com.squareup.square.api

Interface GiftCardActivitiesApi

All Known Implementing Classes:

DefaultGiftCardActivitiesApi

public interface GiftCardActivitiesApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
CreateGiftCardActivityResponse	createGiftCardActivity(CreateGiftCardActivityRequest body) Creates a gift card activity to manage the balance or state of a [gift card]($m/GiftCard).
CompletableFuture<CreateGiftCardActivityResponse>	createGiftCardActivityAsync(CreateGiftCardActivityRequest body) Creates a gift card activity to manage the balance or state of a [gift card]($m/GiftCard).
ListGiftCardActivitiesResponse	listGiftCardActivities(String giftCardId, String type, String locationId, String beginTime, String endTime, Integer limit, String cursor, String sortOrder) Lists gift card activities.
CompletableFuture<ListGiftCardActivitiesResponse>	listGiftCardActivitiesAsync(String giftCardId, String type, String locationId, String beginTime, String endTime, Integer limit, String cursor, String sortOrder) Lists gift card activities.

Method Detail

listGiftCardActivities

ListGiftCardActivitiesResponse listGiftCardActivities(String giftCardId,
                                                      String type,
                                                      String locationId,
                                                      String beginTime,
                                                      String endTime,
                                                      Integer limit,
                                                      String cursor,
                                                      String sortOrder)
                                               throws ApiException,
                                                      IOException

Lists gift card activities. By default, you get gift card activities for all gift cards in the seller's account. You can optionally specify query parameters to filter the list. For example, you can get a list of gift card activities for a gift card, for all gift cards in a specific region, or for activities within a time window.

Parameters:

giftCardId - Optional parameter: If a gift card ID is provided, the endpoint returns activities related to the specified gift card. Otherwise, the endpoint returns all gift card activities for the seller.

type - Optional parameter: If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. Otherwise, the endpoint returns all types of gift card activities.

locationId - Optional parameter: If a location ID is provided, the endpoint returns gift card activities for the specified location. Otherwise, the endpoint returns gift card activities for all locations.

beginTime - Optional parameter: The timestamp for the beginning of the reporting period, in RFC 3339 format. This start time is inclusive. The default value is the current time minus one year.

endTime - Optional parameter: The timestamp for the end of the reporting period, in RFC 3339 format. This end time is inclusive. The default value is the current time.

limit - Optional parameter: If a limit is provided, the endpoint returns the specified number of results (or fewer) per page. The maximum value is 100. The default value is 50. 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).

sortOrder - Optional parameter: The order in which the endpoint returns the activities, based on `created_at`. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

Returns:

Returns the ListGiftCardActivitiesResponse 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.

listGiftCardActivitiesAsync

CompletableFuture<ListGiftCardActivitiesResponse> listGiftCardActivitiesAsync(String giftCardId,
                                                                              String type,
                                                                              String locationId,
                                                                              String beginTime,
                                                                              String endTime,
                                                                              Integer limit,
                                                                              String cursor,
                                                                              String sortOrder)

Lists gift card activities. By default, you get gift card activities for all gift cards in the seller's account. You can optionally specify query parameters to filter the list. For example, you can get a list of gift card activities for a gift card, for all gift cards in a specific region, or for activities within a time window.

Parameters:

giftCardId - Optional parameter: If a gift card ID is provided, the endpoint returns activities related to the specified gift card. Otherwise, the endpoint returns all gift card activities for the seller.

type - Optional parameter: If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. Otherwise, the endpoint returns all types of gift card activities.

locationId - Optional parameter: If a location ID is provided, the endpoint returns gift card activities for the specified location. Otherwise, the endpoint returns gift card activities for all locations.

beginTime - Optional parameter: The timestamp for the beginning of the reporting period, in RFC 3339 format. This start time is inclusive. The default value is the current time minus one year.

endTime - Optional parameter: The timestamp for the end of the reporting period, in RFC 3339 format. This end time is inclusive. The default value is the current time.

limit - Optional parameter: If a limit is provided, the endpoint returns the specified number of results (or fewer) per page. The maximum value is 100. The default value is 50. 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).

sortOrder - Optional parameter: The order in which the endpoint returns the activities, based on `created_at`. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

Returns:

Returns the ListGiftCardActivitiesResponse response from the API call

createGiftCardActivity

CreateGiftCardActivityResponse createGiftCardActivity(CreateGiftCardActivityRequest body)
                                               throws ApiException,
                                                      IOException

Creates a gift card activity to manage the balance or state of a [gift card]($m/GiftCard). For example, you create an `ACTIVATE` activity to activate a gift card with an initial balance before the gift card can be used.

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 CreateGiftCardActivityResponse 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.

createGiftCardActivityAsync

CompletableFuture<CreateGiftCardActivityResponse> createGiftCardActivityAsync(CreateGiftCardActivityRequest body)

Creates a gift card activity to manage the balance or state of a [gift card]($m/GiftCard). For example, you create an `ACTIVATE` activity to activate a gift card with an initial balance before the gift card can be used.

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 CreateGiftCardActivityResponse response from the API call