Skip to content

README.md

Latest commit

 

History

History
271 lines (202 loc) · 14.9 KB

README.md

File metadata and controls

271 lines (202 loc) · 14.9 KB

GiftCards

Overview

Available Operations

  • get - Get gift card
  • delete - Delete a gift card
  • create - Create gift card
  • list - List gift cards

get

Fetch details about a gift card.

Example Usage

package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.GetGiftCardResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .merchantAccountId("default")
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        GetGiftCardResponse res = sdk.giftCards().get()
                .giftCardId("356d56e5-fe16-42ae-97ee-8d55d846ae2e")
                .call();

        if (res.giftCard().isPresent()) {
            System.out.println(res.giftCard().get());
        }
    }
}

Parameters

Parameter Type Required Description Example
giftCardId String ✔️ The ID of the gift card. 356d56e5-fe16-42ae-97ee-8d55d846ae2e
merchantAccountId JsonNullable<String> ➖ The ID of the merchant account to use for this request.

Response

GetGiftCardResponse

Errors

Error Type Status Code Content Type
models/errors/Error400 400 application/json
models/errors/Error401 401 application/json
models/errors/Error403 403 application/json
models/errors/Error404 404 application/json
models/errors/Error405 405 application/json
models/errors/Error409 409 application/json
models/errors/HTTPValidationError 422 application/json
models/errors/Error425 425 application/json
models/errors/Error429 429 application/json
models/errors/Error500 500 application/json
models/errors/Error502 502 application/json
models/errors/Error504 504 application/json
models/errors/APIException 4XX, 5XX */*

delete

Removes a gift card from our system.

Example Usage

package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.DeleteGiftCardResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .merchantAccountId("default")
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        DeleteGiftCardResponse res = sdk.giftCards().delete()
                .giftCardId("356d56e5-fe16-42ae-97ee-8d55d846ae2e")
                .call();

        // handle response
    }
}

Parameters

Parameter Type Required Description Example
giftCardId String ✔️ The ID of the gift card. 356d56e5-fe16-42ae-97ee-8d55d846ae2e
merchantAccountId JsonNullable<String> ➖ The ID of the merchant account to use for this request.

Response

DeleteGiftCardResponse

Errors

Error Type Status Code Content Type
models/errors/Error400 400 application/json
models/errors/Error401 401 application/json
models/errors/Error403 403 application/json
models/errors/Error404 404 application/json
models/errors/Error405 405 application/json
models/errors/Error409 409 application/json
models/errors/HTTPValidationError 422 application/json
models/errors/Error425 425 application/json
models/errors/Error429 429 application/json
models/errors/Error500 500 application/json
models/errors/Error502 502 application/json
models/errors/Error504 504 application/json
models/errors/APIException 4XX, 5XX */*

create

Store a new gift card in the vault.

Example Usage

package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.components.GiftCardCreate;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.CreateGiftCardResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .merchantAccountId("default")
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        CreateGiftCardResponse res = sdk.giftCards().create()
                .giftCardCreate(GiftCardCreate.builder()
                    .number("4123455541234561234")
                    .pin("1234")
                    .build())
                .call();

        if (res.giftCard().isPresent()) {
            System.out.println(res.giftCard().get());
        }
    }
}

Parameters

Parameter Type Required Description
merchantAccountId JsonNullable<String> ➖ The ID of the merchant account to use for this request.
giftCardCreate GiftCardCreate ✔️ N/A

Response

CreateGiftCardResponse

Errors

Error Type Status Code Content Type
models/errors/Error400 400 application/json
models/errors/Error401 401 application/json
models/errors/Error403 403 application/json
models/errors/Error404 404 application/json
models/errors/Error405 405 application/json
models/errors/Error409 409 application/json
models/errors/HTTPValidationError 422 application/json
models/errors/Error425 425 application/json
models/errors/Error429 429 application/json
models/errors/Error500 500 application/json
models/errors/Error502 502 application/json
models/errors/Error504 504 application/json
models/errors/APIException 4XX, 5XX */*

list

Browser all gift cards.

Example Usage

package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.ListGiftCardsRequest;
import com.gr4vy.sdk.models.operations.ListGiftCardsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .merchantAccountId("default")
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        ListGiftCardsRequest req = ListGiftCardsRequest.builder()
                .build();


        sdk.giftCards().list()
                .callAsStream()
                .forEach((ListGiftCardsResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter Type Required Description
request ListGiftCardsRequest ✔️ The request object to use for the request.

Response

ListGiftCardsResponse

Errors

Error Type Status Code Content Type
models/errors/Error400 400 application/json
models/errors/Error401 401 application/json
models/errors/Error403 403 application/json
models/errors/Error404 404 application/json
models/errors/Error405 405 application/json
models/errors/Error409 409 application/json
models/errors/HTTPValidationError 422 application/json
models/errors/Error425 425 application/json
models/errors/Error429 429 application/json
models/errors/Error500 500 application/json
models/errors/Error502 502 application/json
models/errors/Error504 504 application/json
models/errors/APIException 4XX, 5XX */*