com.squareup.square.api

Class DefaultGiftCardsApi

java.lang.Object

com.squareup.square.api.BaseApi

com.squareup.square.api.DefaultGiftCardsApi

All Implemented Interfaces:

GiftCardsApi

public final class DefaultGiftCardsApi
extends BaseApi
implements GiftCardsApi

This class lists all the endpoints of the groups.

Nested Class Summary

Nested classes/interfaces inherited from class com.squareup.square.api.BaseApi

BaseApi.RequestExecutor, BaseApi.RequestSupplier, BaseApi.ResponseHandler<T>

Field Summary

Fields inherited from class com.squareup.square.api.BaseApi

authManagers, config, httpCallback, internalUserAgent

Constructor Summary

Constructors

Constructor and Description
DefaultGiftCardsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers) Initializes the controller.
DefaultGiftCardsApi(Configuration config, HttpClient httpClient, Map<String,AuthManager> authManagers, HttpCallback httpCallback) Initializes the controller with HTTPCallback.

Method Summary

Modifier and Type	Method and Description
CreateGiftCardResponse	createGiftCard(CreateGiftCardRequest body) Creates a digital gift card or registers a physical (plastic) gift card.
CompletableFuture<CreateGiftCardResponse>	createGiftCardAsync(CreateGiftCardRequest body) Creates a digital gift card or registers a physical (plastic) gift card.
LinkCustomerToGiftCardResponse	linkCustomerToGiftCard(String giftCardId, LinkCustomerToGiftCardRequest body) Links a customer to a gift card, which is also referred to as adding a card on file.
CompletableFuture<LinkCustomerToGiftCardResponse>	linkCustomerToGiftCardAsync(String giftCardId, LinkCustomerToGiftCardRequest body) Links a customer to a gift card, which is also referred to as adding a card on file.
ListGiftCardsResponse	listGiftCards(String type, String state, Integer limit, String cursor, String customerId) Lists all gift cards.
CompletableFuture<ListGiftCardsResponse>	listGiftCardsAsync(String type, String state, Integer limit, String cursor, String customerId) Lists all gift cards.
RetrieveGiftCardResponse	retrieveGiftCard(String id) Retrieves a gift card using the gift card ID.
CompletableFuture<RetrieveGiftCardResponse>	retrieveGiftCardAsync(String id) Retrieves a gift card using the gift card ID.
RetrieveGiftCardFromGANResponse	retrieveGiftCardFromGAN(RetrieveGiftCardFromGANRequest body) Retrieves a gift card using the gift card account number (GAN).
CompletableFuture<RetrieveGiftCardFromGANResponse>	retrieveGiftCardFromGANAsync(RetrieveGiftCardFromGANRequest body) Retrieves a gift card using the gift card account number (GAN).
RetrieveGiftCardFromNonceResponse	retrieveGiftCardFromNonce(RetrieveGiftCardFromNonceRequest body) Retrieves a gift card using a secure payment token that represents the gift card.
CompletableFuture<RetrieveGiftCardFromNonceResponse>	retrieveGiftCardFromNonceAsync(RetrieveGiftCardFromNonceRequest body) Retrieves a gift card using a secure payment token that represents the gift card.
UnlinkCustomerFromGiftCardResponse	unlinkCustomerFromGiftCard(String giftCardId, UnlinkCustomerFromGiftCardRequest body) Unlinks a customer from a gift card, which is also referred to as removing a card on file.
CompletableFuture<UnlinkCustomerFromGiftCardResponse>	unlinkCustomerFromGiftCardAsync(String giftCardId, UnlinkCustomerFromGiftCardRequest body) Unlinks a customer from a gift card, which is also referred to as removing a card on file.

Methods inherited from class com.squareup.square.api.BaseApi

getClientInstance, getHttpCallback, makeHttpCallAsync, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultGiftCardsApi

public DefaultGiftCardsApi(Configuration config,
                           HttpClient httpClient,
                           Map<String,AuthManager> authManagers)

Initializes the controller.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

DefaultGiftCardsApi

public DefaultGiftCardsApi(Configuration config,
                           HttpClient httpClient,
                           Map<String,AuthManager> authManagers,
                           HttpCallback httpCallback)

Initializes the controller with HTTPCallback.

Parameters:

config - Configurations added in client.

httpClient - Send HTTP requests and read the responses.

authManagers - Apply authorization to requests.

httpCallback - Callback to be called before and after the HTTP call.

Method Detail

listGiftCards

public ListGiftCardsResponse listGiftCards(String type,
                                           String state,
                                           Integer limit,
                                           String cursor,
                                           String customerId)
                                    throws ApiException,
                                           IOException

Lists all gift cards. You can specify optional filters to retrieve a subset of the gift cards.

Specified by:

listGiftCards in interface GiftCardsApi

Parameters:

type - Optional parameter: If a [type]($m/GiftCardType) is provided, the endpoint returns gift cards of the specified type. Otherwise, the endpoint returns gift cards of all types.

state - Optional parameter: If a [state]($m/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state. Otherwise, the endpoint returns the gift cards of all states.

limit - Optional parameter: If a limit is provided, the endpoint returns only the specified number of results per page. The maximum value is 50. The default value is 30. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).

customerId - Optional parameter: If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer.

Returns:

Returns the ListGiftCardsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listGiftCardsAsync

public CompletableFuture<ListGiftCardsResponse> listGiftCardsAsync(String type,
                                                                   String state,
                                                                   Integer limit,
                                                                   String cursor,
                                                                   String customerId)

Lists all gift cards. You can specify optional filters to retrieve a subset of the gift cards.

Specified by:

listGiftCardsAsync in interface GiftCardsApi

Parameters:

type - Optional parameter: If a [type]($m/GiftCardType) is provided, the endpoint returns gift cards of the specified type. Otherwise, the endpoint returns gift cards of all types.

state - Optional parameter: If a [state]($m/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state. Otherwise, the endpoint returns the gift cards of all states.

limit - Optional parameter: If a limit is provided, the endpoint returns only the specified number of results per page. The maximum value is 50. The default value is 30. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).

customerId - Optional parameter: If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer.

Returns:

Returns the ListGiftCardsResponse response from the API call

createGiftCard

public CreateGiftCardResponse createGiftCard(CreateGiftCardRequest body)
                                      throws ApiException,
                                             IOException

Creates a digital gift card or registers a physical (plastic) gift card. After the gift card is created, you must call [CreateGiftCardActivity]($e/GiftCardActivities/CreateGiftCardActivity) to activate the card with an initial balance before it can be used for payment.

Specified by:

createGiftCard in interface GiftCardsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateGiftCardResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createGiftCardAsync

public CompletableFuture<CreateGiftCardResponse> createGiftCardAsync(CreateGiftCardRequest body)

Creates a digital gift card or registers a physical (plastic) gift card. After the gift card is created, you must call [CreateGiftCardActivity]($e/GiftCardActivities/CreateGiftCardActivity) to activate the card with an initial balance before it can be used for payment.

Specified by:

createGiftCardAsync in interface GiftCardsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateGiftCardResponse response from the API call

retrieveGiftCardFromGAN

public RetrieveGiftCardFromGANResponse retrieveGiftCardFromGAN(RetrieveGiftCardFromGANRequest body)
                                                        throws ApiException,
                                                               IOException

Retrieves a gift card using the gift card account number (GAN).

Specified by:

retrieveGiftCardFromGAN in interface GiftCardsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the RetrieveGiftCardFromGANResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveGiftCardFromGANAsync

public CompletableFuture<RetrieveGiftCardFromGANResponse> retrieveGiftCardFromGANAsync(RetrieveGiftCardFromGANRequest body)

Retrieves a gift card using the gift card account number (GAN).

Specified by:

retrieveGiftCardFromGANAsync in interface GiftCardsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the RetrieveGiftCardFromGANResponse response from the API call

retrieveGiftCardFromNonce

public RetrieveGiftCardFromNonceResponse retrieveGiftCardFromNonce(RetrieveGiftCardFromNonceRequest body)
                                                            throws ApiException,
                                                                   IOException

Retrieves a gift card using a secure payment token that represents the gift card.

Specified by:

retrieveGiftCardFromNonce in interface GiftCardsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the RetrieveGiftCardFromNonceResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveGiftCardFromNonceAsync

public CompletableFuture<RetrieveGiftCardFromNonceResponse> retrieveGiftCardFromNonceAsync(RetrieveGiftCardFromNonceRequest body)

Retrieves a gift card using a secure payment token that represents the gift card.

Specified by:

retrieveGiftCardFromNonceAsync in interface GiftCardsApi

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the RetrieveGiftCardFromNonceResponse response from the API call

linkCustomerToGiftCard

public LinkCustomerToGiftCardResponse linkCustomerToGiftCard(String giftCardId,
                                                             LinkCustomerToGiftCardRequest body)
                                                      throws ApiException,
                                                             IOException

Links a customer to a gift card, which is also referred to as adding a card on file.

Specified by:

linkCustomerToGiftCard in interface GiftCardsApi

Parameters:

giftCardId - Required parameter: The ID of the gift card to be linked.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the LinkCustomerToGiftCardResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

linkCustomerToGiftCardAsync

public CompletableFuture<LinkCustomerToGiftCardResponse> linkCustomerToGiftCardAsync(String giftCardId,
                                                                                     LinkCustomerToGiftCardRequest body)

Links a customer to a gift card, which is also referred to as adding a card on file.

Specified by:

linkCustomerToGiftCardAsync in interface GiftCardsApi

Parameters:

giftCardId - Required parameter: The ID of the gift card to be linked.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the LinkCustomerToGiftCardResponse response from the API call

unlinkCustomerFromGiftCard

public UnlinkCustomerFromGiftCardResponse unlinkCustomerFromGiftCard(String giftCardId,
                                                                     UnlinkCustomerFromGiftCardRequest body)
                                                              throws ApiException,
                                                                     IOException

Unlinks a customer from a gift card, which is also referred to as removing a card on file.

Specified by:

unlinkCustomerFromGiftCard in interface GiftCardsApi

Parameters:

giftCardId - Required parameter: The ID of the gift card to be unlinked.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UnlinkCustomerFromGiftCardResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

unlinkCustomerFromGiftCardAsync

public CompletableFuture<UnlinkCustomerFromGiftCardResponse> unlinkCustomerFromGiftCardAsync(String giftCardId,
                                                                                             UnlinkCustomerFromGiftCardRequest body)

Unlinks a customer from a gift card, which is also referred to as removing a card on file.

Specified by:

unlinkCustomerFromGiftCardAsync in interface GiftCardsApi

Parameters:

giftCardId - Required parameter: The ID of the gift card to be unlinked.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UnlinkCustomerFromGiftCardResponse response from the API call

retrieveGiftCard

public RetrieveGiftCardResponse retrieveGiftCard(String id)
                                          throws ApiException,
                                                 IOException

Retrieves a gift card using the gift card ID.

Specified by:

retrieveGiftCard in interface GiftCardsApi

Parameters:

id - Required parameter: The ID of the gift card to retrieve.

Returns:

Returns the RetrieveGiftCardResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveGiftCardAsync

public CompletableFuture<RetrieveGiftCardResponse> retrieveGiftCardAsync(String id)

Retrieves a gift card using the gift card ID.

Specified by:

retrieveGiftCardAsync in interface GiftCardsApi

Parameters:

id - Required parameter: The ID of the gift card to retrieve.

Returns:

Returns the RetrieveGiftCardResponse response from the API call