DefaultLoyaltyApi (Square 37.0.0.20240118 API)

java.lang.Object
- com.squareup.square.api.BaseApi
- - com.squareup.square.api.DefaultLoyaltyApi

All Implemented Interfaces:

LoyaltyApi
```
public final class DefaultLoyaltyApi
extends BaseApi
implements LoyaltyApi
```
This class lists all the endpoints of the groups.

Field Summary
- Fields inherited from class com.squareup.square.api.BaseApi
  AUTHENTICATION_KEY, GLOBAL_ERROR_CASES

Constructor Summary

Constructors
Constructor and Description

DefaultLoyaltyApi(io.apimatic.core.GlobalConfiguration globalConfig)
Initializes the controller.

Constructors
Constructor and Description
`DefaultLoyaltyApi(io.apimatic.core.GlobalConfiguration globalConfig)` Initializes the controller.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AccumulateLoyaltyPointsResponse`	`accumulateLoyaltyPoints(String accountId, AccumulateLoyaltyPointsRequest body)` Adds points earned from a purchase to a [loyalty account]($m/LoyaltyAccount).
`CompletableFuture<AccumulateLoyaltyPointsResponse>`	`accumulateLoyaltyPointsAsync(String accountId, AccumulateLoyaltyPointsRequest body)` Adds points earned from a purchase to a [loyalty account]($m/LoyaltyAccount).
`AdjustLoyaltyPointsResponse`	`adjustLoyaltyPoints(String accountId, AdjustLoyaltyPointsRequest body)` Adds points to or subtracts points from a buyer's account.
`CompletableFuture<AdjustLoyaltyPointsResponse>`	`adjustLoyaltyPointsAsync(String accountId, AdjustLoyaltyPointsRequest body)` Adds points to or subtracts points from a buyer's account.
`CalculateLoyaltyPointsResponse`	`calculateLoyaltyPoints(String programId, CalculateLoyaltyPointsRequest body)` Calculates the number of points a buyer can earn from a purchase.
`CompletableFuture<CalculateLoyaltyPointsResponse>`	`calculateLoyaltyPointsAsync(String programId, CalculateLoyaltyPointsRequest body)` Calculates the number of points a buyer can earn from a purchase.
`CancelLoyaltyPromotionResponse`	`cancelLoyaltyPromotion(String promotionId, String programId)` Cancels a loyalty promotion.
`CompletableFuture<CancelLoyaltyPromotionResponse>`	`cancelLoyaltyPromotionAsync(String promotionId, String programId)` Cancels a loyalty promotion.
`CreateLoyaltyAccountResponse`	`createLoyaltyAccount(CreateLoyaltyAccountRequest body)` Creates a loyalty account.
`CompletableFuture<CreateLoyaltyAccountResponse>`	`createLoyaltyAccountAsync(CreateLoyaltyAccountRequest body)` Creates a loyalty account.
`CreateLoyaltyPromotionResponse`	`createLoyaltyPromotion(String programId, CreateLoyaltyPromotionRequest body)` Creates a loyalty promotion for a [loyalty program]($m/LoyaltyProgram).
`CompletableFuture<CreateLoyaltyPromotionResponse>`	`createLoyaltyPromotionAsync(String programId, CreateLoyaltyPromotionRequest body)` Creates a loyalty promotion for a [loyalty program]($m/LoyaltyProgram).
`CreateLoyaltyRewardResponse`	`createLoyaltyReward(CreateLoyaltyRewardRequest body)` Creates a loyalty reward.
`CompletableFuture<CreateLoyaltyRewardResponse>`	`createLoyaltyRewardAsync(CreateLoyaltyRewardRequest body)` Creates a loyalty reward.
`DeleteLoyaltyRewardResponse`	`deleteLoyaltyReward(String rewardId)` Deletes a loyalty reward by doing the following: - Returns the loyalty points back to the loyalty account.
`CompletableFuture<DeleteLoyaltyRewardResponse>`	`deleteLoyaltyRewardAsync(String rewardId)` Deletes a loyalty reward by doing the following: - Returns the loyalty points back to the loyalty account.
`ListLoyaltyProgramsResponse`	`listLoyaltyPrograms()` Deprecated.
`CompletableFuture<ListLoyaltyProgramsResponse>`	`listLoyaltyProgramsAsync()` Deprecated.
`ListLoyaltyPromotionsResponse`	`listLoyaltyPromotions(String programId, String status, String cursor, Integer limit)` Lists the loyalty promotions associated with a [loyalty program]($m/LoyaltyProgram).
`CompletableFuture<ListLoyaltyPromotionsResponse>`	`listLoyaltyPromotionsAsync(String programId, String status, String cursor, Integer limit)` Lists the loyalty promotions associated with a [loyalty program]($m/LoyaltyProgram).
`RedeemLoyaltyRewardResponse`	`redeemLoyaltyReward(String rewardId, RedeemLoyaltyRewardRequest body)` Redeems a loyalty reward.
`CompletableFuture<RedeemLoyaltyRewardResponse>`	`redeemLoyaltyRewardAsync(String rewardId, RedeemLoyaltyRewardRequest body)` Redeems a loyalty reward.
`RetrieveLoyaltyAccountResponse`	`retrieveLoyaltyAccount(String accountId)` Retrieves a loyalty account.
`CompletableFuture<RetrieveLoyaltyAccountResponse>`	`retrieveLoyaltyAccountAsync(String accountId)` Retrieves a loyalty account.
`RetrieveLoyaltyProgramResponse`	`retrieveLoyaltyProgram(String programId)` Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`.
`CompletableFuture<RetrieveLoyaltyProgramResponse>`	`retrieveLoyaltyProgramAsync(String programId)` Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`.
`RetrieveLoyaltyPromotionResponse`	`retrieveLoyaltyPromotion(String promotionId, String programId)` Retrieves a loyalty promotion.
`CompletableFuture<RetrieveLoyaltyPromotionResponse>`	`retrieveLoyaltyPromotionAsync(String promotionId, String programId)` Retrieves a loyalty promotion.
`RetrieveLoyaltyRewardResponse`	`retrieveLoyaltyReward(String rewardId)` Retrieves a loyalty reward.
`CompletableFuture<RetrieveLoyaltyRewardResponse>`	`retrieveLoyaltyRewardAsync(String rewardId)` Retrieves a loyalty reward.
`SearchLoyaltyAccountsResponse`	`searchLoyaltyAccounts(SearchLoyaltyAccountsRequest body)` Searches for loyalty accounts in a loyalty program.
`CompletableFuture<SearchLoyaltyAccountsResponse>`	`searchLoyaltyAccountsAsync(SearchLoyaltyAccountsRequest body)` Searches for loyalty accounts in a loyalty program.
`SearchLoyaltyEventsResponse`	`searchLoyaltyEvents(SearchLoyaltyEventsRequest body)` Searches for loyalty events.
`CompletableFuture<SearchLoyaltyEventsResponse>`	`searchLoyaltyEventsAsync(SearchLoyaltyEventsRequest body)` Searches for loyalty events.
`SearchLoyaltyRewardsResponse`	`searchLoyaltyRewards(SearchLoyaltyRewardsRequest body)` Searches for loyalty rewards.
`CompletableFuture<SearchLoyaltyRewardsResponse>`	`searchLoyaltyRewardsAsync(SearchLoyaltyRewardsRequest body)` Searches for loyalty rewards.

Methods inherited from class com.squareup.square.api.BaseApi
getClientInstance, getGlobalConfiguration, getHttpCallback

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultLoyaltyApi
```
public DefaultLoyaltyApi(io.apimatic.core.GlobalConfiguration globalConfig)
```
    Initializes the controller.
    
    Parameters:
    
    globalConfig - Configurations added in client.
- Method Detail
  - createLoyaltyAccount
```
public CreateLoyaltyAccountResponse createLoyaltyAccount(CreateLoyaltyAccountRequest body)
                                                  throws ApiException,
                                                         IOException
```
    Creates a loyalty account. To create a loyalty account, you must provide the `program_id` and a `mapping` with the `phone_number` of the buyer.
    
    Specified by:
    
    createLoyaltyAccount in interface LoyaltyApi
    
    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 CreateLoyaltyAccountResponse 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.
  - createLoyaltyAccountAsync
```
public CompletableFuture<CreateLoyaltyAccountResponse> createLoyaltyAccountAsync(CreateLoyaltyAccountRequest body)
```
    Creates a loyalty account. To create a loyalty account, you must provide the `program_id` and a `mapping` with the `phone_number` of the buyer.
    
    Specified by:
    
    createLoyaltyAccountAsync in interface LoyaltyApi
    
    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 CreateLoyaltyAccountResponse response from the API call
  - searchLoyaltyAccounts
```
public SearchLoyaltyAccountsResponse searchLoyaltyAccounts(SearchLoyaltyAccountsRequest body)
                                                    throws ApiException,
                                                           IOException
```
    Searches for loyalty accounts in a loyalty program. You can search for a loyalty account using the phone number or customer ID associated with the account. To return all loyalty accounts, specify an empty `query` object or omit it entirely. Search results are sorted by `created_at` in ascending order.
    
    Specified by:
    
    searchLoyaltyAccounts in interface LoyaltyApi
    
    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 SearchLoyaltyAccountsResponse 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.
  - searchLoyaltyAccountsAsync
```
public CompletableFuture<SearchLoyaltyAccountsResponse> searchLoyaltyAccountsAsync(SearchLoyaltyAccountsRequest body)
```
    Searches for loyalty accounts in a loyalty program. You can search for a loyalty account using the phone number or customer ID associated with the account. To return all loyalty accounts, specify an empty `query` object or omit it entirely. Search results are sorted by `created_at` in ascending order.
    
    Specified by:
    
    searchLoyaltyAccountsAsync in interface LoyaltyApi
    
    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 SearchLoyaltyAccountsResponse response from the API call
  - retrieveLoyaltyAccount
```
public RetrieveLoyaltyAccountResponse retrieveLoyaltyAccount(String accountId)
                                                      throws ApiException,
                                                             IOException
```
    Retrieves a loyalty account.
    
    Specified by:
    
    retrieveLoyaltyAccount in interface LoyaltyApi
    
    Parameters:
    
    accountId - Required parameter: The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve.
    
    Returns:
    
    Returns the RetrieveLoyaltyAccountResponse 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.
  - retrieveLoyaltyAccountAsync
```
public CompletableFuture<RetrieveLoyaltyAccountResponse> retrieveLoyaltyAccountAsync(String accountId)
```
    Retrieves a loyalty account.
    
    Specified by:
    
    retrieveLoyaltyAccountAsync in interface LoyaltyApi
    
    Parameters:
    
    accountId - Required parameter: The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve.
    
    Returns:
    
    Returns the RetrieveLoyaltyAccountResponse response from the API call
  - accumulateLoyaltyPoints
```
public AccumulateLoyaltyPointsResponse accumulateLoyaltyPoints(String accountId,
                                                               AccumulateLoyaltyPointsRequest body)
                                                        throws ApiException,
                                                               IOException
```
    Adds points earned from a purchase to a [loyalty account]($m/LoyaltyAccount). - If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order to compute the points earned from both the base loyalty program and an associated [loyalty promotion]($m/LoyaltyPromotion). For purchases that qualify for multiple accrual rules, Square computes points based on the accrual rule that grants the most points. For purchases that qualify for multiple promotions, Square computes points based on the most recently created promotion. A purchase must first qualify for program points to be eligible for promotion points. - If you are not using the Orders API to manage orders, provide `points` with the number of points to add. You must first perform a client-side computation of the points earned from the loyalty program and loyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints]($e/Loyalty/CalculateLoyaltyPoints) to compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).
    
    Specified by:
    
    accumulateLoyaltyPoints in interface LoyaltyApi
    
    Parameters:
    
    accountId - Required parameter: The ID of the target [loyalty account](entity:LoyaltyAccount).
    
    body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.
    
    Returns:
    
    Returns the AccumulateLoyaltyPointsResponse 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.
  - accumulateLoyaltyPointsAsync
```
public CompletableFuture<AccumulateLoyaltyPointsResponse> accumulateLoyaltyPointsAsync(String accountId,
                                                                                       AccumulateLoyaltyPointsRequest body)
```
    Adds points earned from a purchase to a [loyalty account]($m/LoyaltyAccount). - If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order to compute the points earned from both the base loyalty program and an associated [loyalty promotion]($m/LoyaltyPromotion). For purchases that qualify for multiple accrual rules, Square computes points based on the accrual rule that grants the most points. For purchases that qualify for multiple promotions, Square computes points based on the most recently created promotion. A purchase must first qualify for program points to be eligible for promotion points. - If you are not using the Orders API to manage orders, provide `points` with the number of points to add. You must first perform a client-side computation of the points earned from the loyalty program and loyalty promotion. For spend-based and visit-based programs, you can call [CalculateLoyaltyPoints]($e/Loyalty/CalculateLoyaltyPoints) to compute the points earned from the base loyalty program. For information about computing points earned from a loyalty promotion, see [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).
    
    Specified by:
    
    accumulateLoyaltyPointsAsync in interface LoyaltyApi
    
    Parameters:
    
    accountId - Required parameter: The ID of the target [loyalty account](entity:LoyaltyAccount).
    
    body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.
    
    Returns:
    
    Returns the AccumulateLoyaltyPointsResponse response from the API call
  - adjustLoyaltyPoints
```
public AdjustLoyaltyPointsResponse adjustLoyaltyPoints(String accountId,
                                                       AdjustLoyaltyPointsRequest body)
                                                throws ApiException,
                                                       IOException
```
    Adds points to or subtracts points from a buyer's account. Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call [AccumulateLoyaltyPoints]($e/Loyalty/AccumulateLoyaltyPoints) to add points when a buyer pays for the purchase.
    
    Specified by:
    
    adjustLoyaltyPoints in interface LoyaltyApi
    
    Parameters:
    
    accountId - Required parameter: The ID of the target [loyalty account](entity:LoyaltyAccount).
    
    body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.
    
    Returns:
    
    Returns the AdjustLoyaltyPointsResponse 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.
  - adjustLoyaltyPointsAsync
```
public CompletableFuture<AdjustLoyaltyPointsResponse> adjustLoyaltyPointsAsync(String accountId,
                                                                               AdjustLoyaltyPointsRequest body)
```
    Adds points to or subtracts points from a buyer's account. Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call [AccumulateLoyaltyPoints]($e/Loyalty/AccumulateLoyaltyPoints) to add points when a buyer pays for the purchase.
    
    Specified by:
    
    adjustLoyaltyPointsAsync in interface LoyaltyApi
    
    Parameters:
    
    accountId - Required parameter: The ID of the target [loyalty account](entity:LoyaltyAccount).
    
    body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.
    
    Returns:
    
    Returns the AdjustLoyaltyPointsResponse response from the API call
  - searchLoyaltyEvents
```
public SearchLoyaltyEventsResponse searchLoyaltyEvents(SearchLoyaltyEventsRequest body)
                                                throws ApiException,
                                                       IOException
```
    Searches for loyalty events. A Square loyalty program maintains a ledger of events that occur during the lifetime of a buyer's loyalty account. Each change in the point balance (for example, points earned, points redeemed, and points expired) is recorded in the ledger. Using this endpoint, you can search the ledger for events. Search results are sorted by `created_at` in descending order.
    
    Specified by:
    
    searchLoyaltyEvents in interface LoyaltyApi
    
    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 SearchLoyaltyEventsResponse 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.
  - searchLoyaltyEventsAsync
```
public CompletableFuture<SearchLoyaltyEventsResponse> searchLoyaltyEventsAsync(SearchLoyaltyEventsRequest body)
```
    Searches for loyalty events. A Square loyalty program maintains a ledger of events that occur during the lifetime of a buyer's loyalty account. Each change in the point balance (for example, points earned, points redeemed, and points expired) is recorded in the ledger. Using this endpoint, you can search the ledger for events. Search results are sorted by `created_at` in descending order.
    
    Specified by:
    
    searchLoyaltyEventsAsync in interface LoyaltyApi
    
    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 SearchLoyaltyEventsResponse response from the API call
  - listLoyaltyPrograms
```
@Deprecated
public ListLoyaltyProgramsResponse listLoyaltyPrograms()
                                                            throws ApiException,
                                                                   IOException
```
    Deprecated.
    
    Returns a list of loyalty programs in the seller's account. Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`.
    
    Specified by:
    
    listLoyaltyPrograms in interface LoyaltyApi
    
    Returns:
    
    Returns the ListLoyaltyProgramsResponse 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.
  - listLoyaltyProgramsAsync
```
@Deprecated
public CompletableFuture<ListLoyaltyProgramsResponse> listLoyaltyProgramsAsync()
```
    Deprecated.
    
    Returns a list of loyalty programs in the seller's account. Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`.
    
    Specified by:
    
    listLoyaltyProgramsAsync in interface LoyaltyApi
    
    Returns:
    
    Returns the ListLoyaltyProgramsResponse response from the API call
  - retrieveLoyaltyProgram
```
public RetrieveLoyaltyProgramResponse retrieveLoyaltyProgram(String programId)
                                                      throws ApiException,
                                                             IOException
```
    Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`. Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).
    
    Specified by:
    
    retrieveLoyaltyProgram in interface LoyaltyApi
    
    Parameters:
    
    programId - Required parameter: The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller.
    
    Returns:
    
    Returns the RetrieveLoyaltyProgramResponse 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.
  - retrieveLoyaltyProgramAsync
```
public CompletableFuture<RetrieveLoyaltyProgramResponse> retrieveLoyaltyProgramAsync(String programId)
```
    Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword `main`. Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard. For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).
    
    Specified by:
    
    retrieveLoyaltyProgramAsync in interface LoyaltyApi
    
    Parameters:
    
    programId - Required parameter: The ID of the loyalty program or the keyword `main`. Either value can be used to retrieve the single loyalty program that belongs to the seller.
    
    Returns:
    
    Returns the RetrieveLoyaltyProgramResponse response from the API call
  - calculateLoyaltyPoints
```
public CalculateLoyaltyPointsResponse calculateLoyaltyPoints(String programId,
                                                             CalculateLoyaltyPointsRequest body)
                                                      throws ApiException,
                                                             IOException
```
    Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint to display the points to the buyer. - If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`. Square reads the order to compute the points earned from the base loyalty program and an associated [loyalty promotion]($m/LoyaltyPromotion). - If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the purchase amount. Square uses this amount to calculate the points earned from the base loyalty program, but not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode` setting of the accrual rule indicates how taxes should be treated for loyalty points accrual. If the purchase qualifies for program points, call [ListLoyaltyPromotions]($e/Loyalty/ListLoyaltyPromotions) and perform a client-side computation to calculate whether the purchase also qualifies for promotion points. For more information, see [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).
    
    Specified by:
    
    calculateLoyaltyPoints in interface LoyaltyApi
    
    Parameters:
    
    programId - Required parameter: The ID of the [loyalty program](entity:LoyaltyProgram), which defines the rules for accruing points.
    
    body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.
    
    Returns:
    
    Returns the CalculateLoyaltyPointsResponse 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.
  - calculateLoyaltyPointsAsync
```
public CompletableFuture<CalculateLoyaltyPointsResponse> calculateLoyaltyPointsAsync(String programId,
                                                                                     CalculateLoyaltyPointsRequest body)
```
    Calculates the number of points a buyer can earn from a purchase. Applications might call this endpoint to display the points to the buyer. - If you are using the Orders API to manage orders, provide the `order_id` and (optional) `loyalty_account_id`. Square reads the order to compute the points earned from the base loyalty program and an associated [loyalty promotion]($m/LoyaltyPromotion). - If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the purchase amount. Square uses this amount to calculate the points earned from the base loyalty program, but not points earned from a loyalty promotion. For spend-based and visit-based programs, the `tax_mode` setting of the accrual rule indicates how taxes should be treated for loyalty points accrual. If the purchase qualifies for program points, call [ListLoyaltyPromotions]($e/Loyalty/ListLoyaltyPromotions) and perform a client-side computation to calculate whether the purchase also qualifies for promotion points. For more information, see [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#calculate-promotion-points).
    
    Specified by:
    
    calculateLoyaltyPointsAsync in interface LoyaltyApi
    
    Parameters:
    
    programId - Required parameter: The ID of the [loyalty program](entity:LoyaltyProgram), which defines the rules for accruing points.
    
    body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.
    
    Returns:
    
    Returns the CalculateLoyaltyPointsResponse response from the API call
  - listLoyaltyPromotions
```
public ListLoyaltyPromotionsResponse listLoyaltyPromotions(String programId,
                                                           String status,
                                                           String cursor,
                                                           Integer limit)
                                                    throws ApiException,
                                                           IOException
```
    Lists the loyalty promotions associated with a [loyalty program]($m/LoyaltyProgram). Results are sorted by the `created_at` date in descending order (newest to oldest).
    
    Specified by:
    
    listLoyaltyPromotions in interface LoyaltyApi
    
    Parameters:
    
    programId - Required parameter: The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword.
    
    status - Optional parameter: The status to filter the results by. If a status is provided, only loyalty promotions with the specified status are returned. Otherwise, all loyalty promotions associated with the loyalty program are returned.
    
    cursor - Optional parameter: The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
    
    limit - Optional parameter: The maximum number of results to return in a single paged response. The minimum value is 1 and the maximum value is 30. The default value is 30. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
    
    Returns:
    
    Returns the ListLoyaltyPromotionsResponse 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.
  - listLoyaltyPromotionsAsync
```
public CompletableFuture<ListLoyaltyPromotionsResponse> listLoyaltyPromotionsAsync(String programId,
                                                                                   String status,
                                                                                   String cursor,
                                                                                   Integer limit)
```
    Lists the loyalty promotions associated with a [loyalty program]($m/LoyaltyProgram). Results are sorted by the `created_at` date in descending order (newest to oldest).
    
    Specified by:
    
    listLoyaltyPromotionsAsync in interface LoyaltyApi
    
    Parameters:
    
    programId - Required parameter: The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword.
    
    status - Optional parameter: The status to filter the results by. If a status is provided, only loyalty promotions with the specified status are returned. Otherwise, all loyalty promotions associated with the loyalty program are returned.
    
    cursor - Optional parameter: The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
    
    limit - Optional parameter: The maximum number of results to return in a single paged response. The minimum value is 1 and the maximum value is 30. The default value is 30. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
    
    Returns:
    
    Returns the ListLoyaltyPromotionsResponse response from the API call
  - createLoyaltyPromotion
```
public CreateLoyaltyPromotionResponse createLoyaltyPromotion(String programId,
                                                             CreateLoyaltyPromotionRequest body)
                                                      throws ApiException,
                                                             IOException
```
    Creates a loyalty promotion for a [loyalty program]($m/LoyaltyProgram). A loyalty promotion enables buyers to earn points in addition to those earned from the base loyalty program. This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the `available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.
    
    Specified by:
    
    createLoyaltyPromotion in interface LoyaltyApi
    
    Parameters:
    
    programId - Required parameter: The ID of the [loyalty program](entity:LoyaltyProgram) to associate with the promotion. To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword.
    
    body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.
    
    Returns:
    
    Returns the CreateLoyaltyPromotionResponse 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.
  - createLoyaltyPromotionAsync
```
public CompletableFuture<CreateLoyaltyPromotionResponse> createLoyaltyPromotionAsync(String programId,
                                                                                     CreateLoyaltyPromotionRequest body)
```
    Creates a loyalty promotion for a [loyalty program]($m/LoyaltyProgram). A loyalty promotion enables buyers to earn points in addition to those earned from the base loyalty program. This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the `available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.
    
    Specified by:
    
    createLoyaltyPromotionAsync in interface LoyaltyApi
    
    Parameters:
    
    programId - Required parameter: The ID of the [loyalty program](entity:LoyaltyProgram) to associate with the promotion. To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword.
    
    body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.
    
    Returns:
    
    Returns the CreateLoyaltyPromotionResponse response from the API call
  - retrieveLoyaltyPromotion
```
public RetrieveLoyaltyPromotionResponse retrieveLoyaltyPromotion(String promotionId,
                                                                 String programId)
                                                          throws ApiException,
                                                                 IOException
```
    Retrieves a loyalty promotion.
    
    Specified by:
    
    retrieveLoyaltyPromotion in interface LoyaltyApi
    
    Parameters:
    
    promotionId - Required parameter: The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve.
    
    programId - Required parameter: The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword.
    
    Returns:
    
    Returns the RetrieveLoyaltyPromotionResponse 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.
  - retrieveLoyaltyPromotionAsync
```
public CompletableFuture<RetrieveLoyaltyPromotionResponse> retrieveLoyaltyPromotionAsync(String promotionId,
                                                                                         String programId)
```
    Retrieves a loyalty promotion.
    
    Specified by:
    
    retrieveLoyaltyPromotionAsync in interface LoyaltyApi
    
    Parameters:
    
    promotionId - Required parameter: The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve.
    
    programId - Required parameter: The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword.
    
    Returns:
    
    Returns the RetrieveLoyaltyPromotionResponse response from the API call
  - cancelLoyaltyPromotion
```
public CancelLoyaltyPromotionResponse cancelLoyaltyPromotion(String promotionId,
                                                             String programId)
                                                      throws ApiException,
                                                             IOException
```
    Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the end date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED` promotion. Because updating a promotion is not supported, you can also use this endpoint to cancel a promotion before you create a new one. This endpoint sets the loyalty promotion to the `CANCELED` state.
    
    Specified by:
    
    cancelLoyaltyPromotion in interface LoyaltyApi
    
    Parameters:
    
    promotionId - Required parameter: The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a promotion that has an `ACTIVE` or `SCHEDULED` status.
    
    programId - Required parameter: The ID of the base [loyalty program](entity:LoyaltyProgram).
    
    Returns:
    
    Returns the CancelLoyaltyPromotionResponse 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.
  - cancelLoyaltyPromotionAsync
```
public CompletableFuture<CancelLoyaltyPromotionResponse> cancelLoyaltyPromotionAsync(String promotionId,
                                                                                     String programId)
```
    Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the end date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED` promotion. Because updating a promotion is not supported, you can also use this endpoint to cancel a promotion before you create a new one. This endpoint sets the loyalty promotion to the `CANCELED` state.
    
    Specified by:
    
    cancelLoyaltyPromotionAsync in interface LoyaltyApi
    
    Parameters:
    
    promotionId - Required parameter: The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a promotion that has an `ACTIVE` or `SCHEDULED` status.
    
    programId - Required parameter: The ID of the base [loyalty program](entity:LoyaltyProgram).
    
    Returns:
    
    Returns the CancelLoyaltyPromotionResponse response from the API call
  - createLoyaltyReward
```
public CreateLoyaltyRewardResponse createLoyaltyReward(CreateLoyaltyRewardRequest body)
                                                throws ApiException,
                                                       IOException
```
    Creates a loyalty reward. In the process, the endpoint does following: - Uses the `reward_tier_id` in the request to determine the number of points to lock for this reward. - If the request includes `order_id`, it adds the reward and related discount to the order. After a reward is created, the points are locked and not available for the buyer to redeem another reward.
    
    Specified by:
    
    createLoyaltyReward in interface LoyaltyApi
    
    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 CreateLoyaltyRewardResponse 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.
  - createLoyaltyRewardAsync
```
public CompletableFuture<CreateLoyaltyRewardResponse> createLoyaltyRewardAsync(CreateLoyaltyRewardRequest body)
```
    Creates a loyalty reward. In the process, the endpoint does following: - Uses the `reward_tier_id` in the request to determine the number of points to lock for this reward. - If the request includes `order_id`, it adds the reward and related discount to the order. After a reward is created, the points are locked and not available for the buyer to redeem another reward.
    
    Specified by:
    
    createLoyaltyRewardAsync in interface LoyaltyApi
    
    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 CreateLoyaltyRewardResponse response from the API call
  - searchLoyaltyRewards
```
public SearchLoyaltyRewardsResponse searchLoyaltyRewards(SearchLoyaltyRewardsRequest body)
                                                  throws ApiException,
                                                         IOException
```
    Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts. If you include a `query` object, `loyalty_account_id` is required and `status` is optional. If you know a reward ID, use the [RetrieveLoyaltyReward]($e/Loyalty/RetrieveLoyaltyReward) endpoint. Search results are sorted by `updated_at` in descending order.
    
    Specified by:
    
    searchLoyaltyRewards in interface LoyaltyApi
    
    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 SearchLoyaltyRewardsResponse 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.
  - searchLoyaltyRewardsAsync
```
public CompletableFuture<SearchLoyaltyRewardsResponse> searchLoyaltyRewardsAsync(SearchLoyaltyRewardsRequest body)
```
    Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns results for all loyalty accounts. If you include a `query` object, `loyalty_account_id` is required and `status` is optional. If you know a reward ID, use the [RetrieveLoyaltyReward]($e/Loyalty/RetrieveLoyaltyReward) endpoint. Search results are sorted by `updated_at` in descending order.
    
    Specified by:
    
    searchLoyaltyRewardsAsync in interface LoyaltyApi
    
    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 SearchLoyaltyRewardsResponse response from the API call
  - deleteLoyaltyReward
```
public DeleteLoyaltyRewardResponse deleteLoyaltyReward(String rewardId)
                                                throws ApiException,
                                                       IOException
```
    Deletes a loyalty reward by doing the following: - Returns the loyalty points back to the loyalty account. - If an order ID was specified when the reward was created (see [CreateLoyaltyReward]($e/Loyalty/CreateLoyaltyReward)), it updates the order by removing the reward and related discounts. You cannot delete a reward that has reached the terminal state (REDEEMED).
    
    Specified by:
    
    deleteLoyaltyReward in interface LoyaltyApi
    
    Parameters:
    
    rewardId - Required parameter: The ID of the [loyalty reward](entity:LoyaltyReward) to delete.
    
    Returns:
    
    Returns the DeleteLoyaltyRewardResponse 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.
  - deleteLoyaltyRewardAsync
```
public CompletableFuture<DeleteLoyaltyRewardResponse> deleteLoyaltyRewardAsync(String rewardId)
```
    Deletes a loyalty reward by doing the following: - Returns the loyalty points back to the loyalty account. - If an order ID was specified when the reward was created (see [CreateLoyaltyReward]($e/Loyalty/CreateLoyaltyReward)), it updates the order by removing the reward and related discounts. You cannot delete a reward that has reached the terminal state (REDEEMED).
    
    Specified by:
    
    deleteLoyaltyRewardAsync in interface LoyaltyApi
    
    Parameters:
    
    rewardId - Required parameter: The ID of the [loyalty reward](entity:LoyaltyReward) to delete.
    
    Returns:
    
    Returns the DeleteLoyaltyRewardResponse response from the API call
  - retrieveLoyaltyReward
```
public RetrieveLoyaltyRewardResponse retrieveLoyaltyReward(String rewardId)
                                                    throws ApiException,
                                                           IOException
```
    Retrieves a loyalty reward.
    
    Specified by:
    
    retrieveLoyaltyReward in interface LoyaltyApi
    
    Parameters:
    
    rewardId - Required parameter: The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve.
    
    Returns:
    
    Returns the RetrieveLoyaltyRewardResponse 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.
  - retrieveLoyaltyRewardAsync
```
public CompletableFuture<RetrieveLoyaltyRewardResponse> retrieveLoyaltyRewardAsync(String rewardId)
```
    Retrieves a loyalty reward.
    
    Specified by:
    
    retrieveLoyaltyRewardAsync in interface LoyaltyApi
    
    Parameters:
    
    rewardId - Required parameter: The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve.
    
    Returns:
    
    Returns the RetrieveLoyaltyRewardResponse response from the API call
  - redeemLoyaltyReward
```
public RedeemLoyaltyRewardResponse redeemLoyaltyReward(String rewardId,
                                                       RedeemLoyaltyRewardRequest body)
                                                throws ApiException,
                                                       IOException
```
    Redeems a loyalty reward. The endpoint sets the reward to the `REDEEMED` terminal state. If you are using your own order processing system (not using the Orders API), you call this endpoint after the buyer paid for the purchase. After the reward reaches the terminal state, it cannot be deleted. In other words, points used for the reward cannot be returned to the account.
    
    Specified by:
    
    redeemLoyaltyReward in interface LoyaltyApi
    
    Parameters:
    
    rewardId - Required parameter: The ID of the [loyalty reward](entity:LoyaltyReward) to redeem.
    
    body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.
    
    Returns:
    
    Returns the RedeemLoyaltyRewardResponse 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.
  - redeemLoyaltyRewardAsync
```
public CompletableFuture<RedeemLoyaltyRewardResponse> redeemLoyaltyRewardAsync(String rewardId,
                                                                               RedeemLoyaltyRewardRequest body)
```
    Redeems a loyalty reward. The endpoint sets the reward to the `REDEEMED` terminal state. If you are using your own order processing system (not using the Orders API), you call this endpoint after the buyer paid for the purchase. After the reward reaches the terminal state, it cannot be deleted. In other words, points used for the reward cannot be returned to the account.
    
    Specified by:
    
    redeemLoyaltyRewardAsync in interface LoyaltyApi
    
    Parameters:
    
    rewardId - Required parameter: The ID of the [loyalty reward](entity:LoyaltyReward) to redeem.
    
    body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.
    
    Returns:
    
    Returns the RedeemLoyaltyRewardResponse response from the API call

Class DefaultLoyaltyApi

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

DefaultLoyaltyApi

Method Detail

createLoyaltyAccount

createLoyaltyAccountAsync

searchLoyaltyAccounts

searchLoyaltyAccountsAsync

retrieveLoyaltyAccount

retrieveLoyaltyAccountAsync

accumulateLoyaltyPoints

accumulateLoyaltyPointsAsync

adjustLoyaltyPoints

adjustLoyaltyPointsAsync

searchLoyaltyEvents

searchLoyaltyEventsAsync

listLoyaltyPrograms

listLoyaltyProgramsAsync

retrieveLoyaltyProgram

retrieveLoyaltyProgramAsync

calculateLoyaltyPoints

calculateLoyaltyPointsAsync

listLoyaltyPromotions

listLoyaltyPromotionsAsync

createLoyaltyPromotion

createLoyaltyPromotionAsync

retrieveLoyaltyPromotion

retrieveLoyaltyPromotionAsync

cancelLoyaltyPromotion

cancelLoyaltyPromotionAsync

createLoyaltyReward

createLoyaltyRewardAsync

searchLoyaltyRewards

searchLoyaltyRewardsAsync

deleteLoyaltyReward

deleteLoyaltyRewardAsync

retrieveLoyaltyReward

retrieveLoyaltyRewardAsync

redeemLoyaltyReward

redeemLoyaltyRewardAsync