Package software.xdev.brevo.api

Class BalanceApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.BalanceApi

public class BalanceApi
extends BaseApi

Field Summary

Fields inherited from class software.xdev.brevo.client.BaseApi

apiClient

Constructor Summary

Constructors

Constructor	Description
BalanceApi()
BalanceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Transaction	beginTransaction(UUID pid, CreateTransactionPayload createTransactionPayload)	Create new transaction Creates new transaction and returns information
Transaction	beginTransaction(UUID pid, CreateTransactionPayload createTransactionPayload, Map<String,String> additionalHeaders)	Create new transaction Creates new transaction and returns information
Transaction	cancelTransaction(UUID pid, UUID tid)	Cancel transaction Cancels transaction
Transaction	cancelTransaction(UUID pid, UUID tid, Map<String,String> additionalHeaders)	Cancel transaction Cancels transaction
Transaction	completeTransaction(UUID pid, UUID tid)	Complete transaction Completes transaction
Transaction	completeTransaction(UUID pid, UUID tid, Map<String,String> additionalHeaders)	Complete transaction Completes transaction
BalanceLimit	createBalanceLimit(UUID pid, UUID bdid, CreateBalanceLimitPayload createBalanceLimitPayload)	Create balance limits Creates balance limit and sends the created UUID along with the data
BalanceLimit	createBalanceLimit(UUID pid, UUID bdid, CreateBalanceLimitPayload createBalanceLimitPayload, Map<String,String> additionalHeaders)	Create balance limits Creates balance limit and sends the created UUID along with the data
BalanceOrder	createBalanceOrder(UUID pid, CreateOrderPayload createOrderPayload)	Create balance order Returns created order
BalanceOrder	createBalanceOrder(UUID pid, CreateOrderPayload createOrderPayload, Map<String,String> additionalHeaders)	Create balance order Returns created order
void	deleteBalanceDefinition(UUID pid, UUID bdid)	Delete balance definition Delete Balance definition
void	deleteBalanceDefinition(UUID pid, UUID bdid, Map<String,String> additionalHeaders)	Delete balance definition Delete Balance definition
void	deleteBalanceLimit(UUID pid, UUID bdid, UUID blid)	Delete balance limit Delete balance limit
void	deleteBalanceLimit(UUID pid, UUID bdid, UUID blid, Map<String,String> additionalHeaders)	Delete balance limit Delete balance limit
BalanceDefinition	getBalanceDefinition(UUID pid, UUID bdid, String version)	Get balance definition Returns balance definition
BalanceDefinition	getBalanceDefinition(UUID pid, UUID bdid, String version, Map<String,String> additionalHeaders)	Get balance definition Returns balance definition
BalanceDefinitionPage	getBalanceDefinitionList(UUID pid, Integer limit, Integer offset, String sortField, String sort, String version)	Get balance definition list Returns balance definition page
BalanceDefinitionPage	getBalanceDefinitionList(UUID pid, Integer limit, Integer offset, String sortField, String sort, String version, Map<String,String> additionalHeaders)	Get balance definition list Returns balance definition page
BalanceLimit	getBalanceLimit(UUID pid, UUID bdid, UUID blid, String version)	Get balance limits Fetches balance limits and send the created UUID along with the data
BalanceLimit	getBalanceLimit(UUID pid, UUID bdid, UUID blid, String version, Map<String,String> additionalHeaders)	Get balance limits Fetches balance limits and send the created UUID along with the data
ContactBalancesResp	getContactBalances(UUID pid)	Get balance list Returns balance list
ContactBalancesResp	getContactBalances(UUID pid, Map<String,String> additionalHeaders)	Get balance list Returns balance list
ModelSubscriptionBalanceResp	getSubscriptionBalances(Integer cid, UUID pid)	Get subscription balances Returns subscription balances
ModelSubscriptionBalanceResp	getSubscriptionBalances(Integer cid, UUID pid, Map<String,String> additionalHeaders)	Get subscription balances Returns subscription balances
<T> T	invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)	Directly invoke the API for the given URL.
BalanceLimit	loyaltyBalanceProgramsPidActiveBalanceGet(UUID pid, Integer contactId, UUID balanceDefinitionId, Integer limit, Integer offset, String sortField, String sort)	Get Active Balances API Returns Active Balances
BalanceLimit	loyaltyBalanceProgramsPidActiveBalanceGet(UUID pid, Integer contactId, UUID balanceDefinitionId, Integer limit, Integer offset, String sortField, String sort, Map<String,String> additionalHeaders)	Get Active Balances API Returns Active Balances
BalanceDefinition	loyaltyBalanceProgramsPidBalanceDefinitionsPost(UUID pid, CreateBalanceDefinitionPayload createBalanceDefinitionPayload)	Create balance definition Creates balance definition and returns information
BalanceDefinition	loyaltyBalanceProgramsPidBalanceDefinitionsPost(UUID pid, CreateBalanceDefinitionPayload createBalanceDefinitionPayload, Map<String,String> additionalHeaders)	Create balance definition Creates balance definition and returns information
Balance	loyaltyBalanceProgramsPidSubscriptionsCidBalancesPost(UUID pid, UUID cid, CreateBalancePayload createBalancePayload)	Create subscription balances Creates a balance for a contact
Balance	loyaltyBalanceProgramsPidSubscriptionsCidBalancesPost(UUID pid, UUID cid, CreateBalancePayload createBalancePayload, Map<String,String> additionalHeaders)	Create subscription balances Creates a balance for a contact
TransactionHistoryResp	loyaltyBalanceProgramsPidTransactionHistoryGet(UUID pid, Integer contactId, UUID balanceDefinitionId, Integer limit, Integer offset, String sortField, String sort, List<String> filters)	Get Transaction History API Returns transaction history
TransactionHistoryResp	loyaltyBalanceProgramsPidTransactionHistoryGet(UUID pid, Integer contactId, UUID balanceDefinitionId, Integer limit, Integer offset, String sortField, String sort, List<String> filters, Map<String,String> additionalHeaders)	Get Transaction History API Returns transaction history
BalanceDefinition	updateBalanceDefinition(UUID pid, UUID bdid, UpdateBalanceDefinitionPayload updateBalanceDefinitionPayload)	Update balance definition Updates Balance definition
BalanceDefinition	updateBalanceDefinition(UUID pid, UUID bdid, UpdateBalanceDefinitionPayload updateBalanceDefinitionPayload, Map<String,String> additionalHeaders)	Update balance definition Updates Balance definition
BalanceLimit	updateBalanceLimit(UUID pid, UUID bdid, UUID blid, UpdateBalanceLimitPayload updateBalanceLimitPayload)	Updates balance limit Updates balance limit
BalanceLimit	updateBalanceLimit(UUID pid, UUID bdid, UUID blid, UpdateBalanceLimitPayload updateBalanceLimitPayload, Map<String,String> additionalHeaders)	Updates balance limit Updates balance limit

Methods inherited from class software.xdev.brevo.client.BaseApi

getApiClient, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, setApiClient

Methods inherited from class java.lang.Object

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

Constructor Details

BalanceApi

public BalanceApi()

BalanceApi

public BalanceApi(ApiClient apiClient)

Method Details

beginTransaction

public Transaction beginTransaction(@Nonnull
 UUID pid,
 @Nonnull
 CreateTransactionPayload createTransactionPayload)
                             throws ApiException

Create new transaction Creates new transaction and returns information

Parameters:

pid - Loyalty Program Id (required)

createTransactionPayload - Transaction Payload (required)

Returns:

Transaction

Throws:

ApiException - if fails to make API call

beginTransaction

public Transaction beginTransaction(@Nonnull
 UUID pid,
 @Nonnull
 CreateTransactionPayload createTransactionPayload,
 Map<String,String> additionalHeaders)
                             throws ApiException

Create new transaction Creates new transaction and returns information

Parameters:

pid - Loyalty Program Id (required)

createTransactionPayload - Transaction Payload (required)

additionalHeaders - additionalHeaders for this call

Returns:

Transaction

Throws:

ApiException - if fails to make API call

cancelTransaction

public Transaction cancelTransaction(@Nonnull
 UUID pid,
 @Nonnull
 UUID tid)
                              throws ApiException

Cancel transaction Cancels transaction

Parameters:

pid - Loyalty Program Id (required)

tid - Transaction Id (required)

Returns:

Transaction

Throws:

ApiException - if fails to make API call

cancelTransaction

public Transaction cancelTransaction(@Nonnull
 UUID pid,
 @Nonnull
 UUID tid,
 Map<String,String> additionalHeaders)
                              throws ApiException

Cancel transaction Cancels transaction

Parameters:

pid - Loyalty Program Id (required)

tid - Transaction Id (required)

additionalHeaders - additionalHeaders for this call

Returns:

Transaction

Throws:

ApiException - if fails to make API call

completeTransaction

public Transaction completeTransaction(@Nonnull
 UUID pid,
 @Nonnull
 UUID tid)
                                throws ApiException

Complete transaction Completes transaction

Parameters:

pid - Loyalty Program Id (required)

tid - Transaction Id (required)

Returns:

Transaction

Throws:

ApiException - if fails to make API call

completeTransaction

public Transaction completeTransaction(@Nonnull
 UUID pid,
 @Nonnull
 UUID tid,
 Map<String,String> additionalHeaders)
                                throws ApiException

Complete transaction Completes transaction

Parameters:

pid - Loyalty Program Id (required)

tid - Transaction Id (required)

additionalHeaders - additionalHeaders for this call

Returns:

Transaction

Throws:

ApiException - if fails to make API call

createBalanceLimit

public BalanceLimit createBalanceLimit(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nonnull
 CreateBalanceLimitPayload createBalanceLimitPayload)
                                throws ApiException

Create balance limits Creates balance limit and sends the created UUID along with the data

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

createBalanceLimitPayload - Balance Definition Payload (required)

Returns:

BalanceLimit

Throws:

ApiException - if fails to make API call

createBalanceLimit

public BalanceLimit createBalanceLimit(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nonnull
 CreateBalanceLimitPayload createBalanceLimitPayload,
 Map<String,String> additionalHeaders)
                                throws ApiException

Create balance limits Creates balance limit and sends the created UUID along with the data

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

createBalanceLimitPayload - Balance Definition Payload (required)

additionalHeaders - additionalHeaders for this call

Returns:

BalanceLimit

Throws:

ApiException - if fails to make API call

createBalanceOrder

public BalanceOrder createBalanceOrder(@Nonnull
 UUID pid,
 @Nonnull
 CreateOrderPayload createOrderPayload)
                                throws ApiException

Create balance order Returns created order

Parameters:

pid - Loyalty Program Id (required)

createOrderPayload - Order Payload (required)

Returns:

BalanceOrder

Throws:

ApiException - if fails to make API call

createBalanceOrder

public BalanceOrder createBalanceOrder(@Nonnull
 UUID pid,
 @Nonnull
 CreateOrderPayload createOrderPayload,
 Map<String,String> additionalHeaders)
                                throws ApiException

Create balance order Returns created order

Parameters:

pid - Loyalty Program Id (required)

createOrderPayload - Order Payload (required)

additionalHeaders - additionalHeaders for this call

Returns:

BalanceOrder

Throws:

ApiException - if fails to make API call

deleteBalanceDefinition

public void deleteBalanceDefinition(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid)
                             throws ApiException

Delete balance definition Delete Balance definition

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

Throws:

ApiException - if fails to make API call

deleteBalanceDefinition

public void deleteBalanceDefinition(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 Map<String,String> additionalHeaders)
                             throws ApiException

Delete balance definition Delete Balance definition

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteBalanceLimit

public void deleteBalanceLimit(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nonnull
 UUID blid)
                        throws ApiException

Delete balance limit Delete balance limit

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

blid - Balance Limit Id (required)

Throws:

ApiException - if fails to make API call

deleteBalanceLimit

public void deleteBalanceLimit(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nonnull
 UUID blid,
 Map<String,String> additionalHeaders)
                        throws ApiException

Delete balance limit Delete balance limit

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

blid - Balance Limit Id (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getBalanceDefinition

public BalanceDefinition getBalanceDefinition(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nullable
 String version)
                                       throws ApiException

Get balance definition Returns balance definition

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

version - Version (optional, default to draft)

Returns:

BalanceDefinition

Throws:

ApiException - if fails to make API call

getBalanceDefinition

public BalanceDefinition getBalanceDefinition(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nullable
 String version,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Get balance definition Returns balance definition

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

version - Version (optional, default to draft)

additionalHeaders - additionalHeaders for this call

Returns:

BalanceDefinition

Throws:

ApiException - if fails to make API call

getBalanceDefinitionList

public BalanceDefinitionPage getBalanceDefinitionList(@Nonnull
 UUID pid,
 @Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String sortField,
 @Nullable
 String sort,
 @Nullable
 String version)
                                               throws ApiException

Get balance definition list Returns balance definition page

Parameters:

pid - Loyalty Program Id (required)

limit - Limit the number of records returned (optional, default to 200)

offset - Offset to paginate records (optional, default to 0)

sortField - Field to sort by (optional, default to updated_at)

sort - Sort direction (optional, default to desc)

version - Version (optional, default to draft)

Returns:

BalanceDefinitionPage

Throws:

ApiException - if fails to make API call

getBalanceDefinitionList

public BalanceDefinitionPage getBalanceDefinitionList(@Nonnull
 UUID pid,
 @Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String sortField,
 @Nullable
 String sort,
 @Nullable
 String version,
 Map<String,String> additionalHeaders)
                                               throws ApiException

Get balance definition list Returns balance definition page

Parameters:

pid - Loyalty Program Id (required)

limit - Limit the number of records returned (optional, default to 200)

offset - Offset to paginate records (optional, default to 0)

sortField - Field to sort by (optional, default to updated_at)

sort - Sort direction (optional, default to desc)

version - Version (optional, default to draft)

additionalHeaders - additionalHeaders for this call

Returns:

BalanceDefinitionPage

Throws:

ApiException - if fails to make API call

getBalanceLimit

public BalanceLimit getBalanceLimit(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nonnull
 UUID blid,
 @Nullable
 String version)
                             throws ApiException

Get balance limits Fetches balance limits and send the created UUID along with the data

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

blid - Balance Limit Id (required)

version - Version (optional, default to draft)

Returns:

BalanceLimit

Throws:

ApiException - if fails to make API call

getBalanceLimit

public BalanceLimit getBalanceLimit(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nonnull
 UUID blid,
 @Nullable
 String version,
 Map<String,String> additionalHeaders)
                             throws ApiException

Get balance limits Fetches balance limits and send the created UUID along with the data

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

blid - Balance Limit Id (required)

version - Version (optional, default to draft)

additionalHeaders - additionalHeaders for this call

Returns:

BalanceLimit

Throws:

ApiException - if fails to make API call

getContactBalances

public ContactBalancesResp getContactBalances(@Nonnull
 UUID pid)
                                       throws ApiException

Get balance list Returns balance list

Parameters:

pid - Loyalty Program Id (required)

Returns:

ContactBalancesResp

Throws:

ApiException - if fails to make API call

getContactBalances

public ContactBalancesResp getContactBalances(@Nonnull
 UUID pid,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Get balance list Returns balance list

Parameters:

pid - Loyalty Program Id (required)

additionalHeaders - additionalHeaders for this call

Returns:

ContactBalancesResp

Throws:

ApiException - if fails to make API call

getSubscriptionBalances

public ModelSubscriptionBalanceResp getSubscriptionBalances(@Nonnull
 Integer cid,
 @Nonnull
 UUID pid)
                                                     throws ApiException

Get subscription balances Returns subscription balances

Parameters:

cid - Contact Id (required)

pid - Loyalty Program Id (required)

Returns:

ModelSubscriptionBalanceResp

Throws:

ApiException - if fails to make API call

getSubscriptionBalances

public ModelSubscriptionBalanceResp getSubscriptionBalances(@Nonnull
 Integer cid,
 @Nonnull
 UUID pid,
 Map<String,String> additionalHeaders)
                                                     throws ApiException

Get subscription balances Returns subscription balances

Parameters:

cid - Contact Id (required)

pid - Loyalty Program Id (required)

additionalHeaders - additionalHeaders for this call

Returns:

ModelSubscriptionBalanceResp

Throws:

ApiException - if fails to make API call

loyaltyBalanceProgramsPidActiveBalanceGet

public BalanceLimit loyaltyBalanceProgramsPidActiveBalanceGet(@Nonnull
 UUID pid,
 @Nonnull
 Integer contactId,
 @Nonnull
 UUID balanceDefinitionId,
 @Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String sortField,
 @Nullable
 String sort)
                                                       throws ApiException

Get Active Balances API Returns Active Balances

Parameters:

pid - Loyalty Program Id (required)

contactId - Contact ID (required)

balanceDefinitionId - Balance Definition ID (required)

limit - Limit (optional)

offset - Offset (optional)

sortField - Sort Field (optional)

sort - Sort Order (optional)

Returns:

BalanceLimit

Throws:

ApiException - if fails to make API call

loyaltyBalanceProgramsPidActiveBalanceGet

public BalanceLimit loyaltyBalanceProgramsPidActiveBalanceGet(@Nonnull
 UUID pid,
 @Nonnull
 Integer contactId,
 @Nonnull
 UUID balanceDefinitionId,
 @Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String sortField,
 @Nullable
 String sort,
 Map<String,String> additionalHeaders)
                                                       throws ApiException

Get Active Balances API Returns Active Balances

Parameters:

pid - Loyalty Program Id (required)

contactId - Contact ID (required)

balanceDefinitionId - Balance Definition ID (required)

limit - Limit (optional)

offset - Offset (optional)

sortField - Sort Field (optional)

sort - Sort Order (optional)

additionalHeaders - additionalHeaders for this call

Returns:

BalanceLimit

Throws:

ApiException - if fails to make API call

loyaltyBalanceProgramsPidBalanceDefinitionsPost

public BalanceDefinition loyaltyBalanceProgramsPidBalanceDefinitionsPost(@Nonnull
 UUID pid,
 @Nonnull
 CreateBalanceDefinitionPayload createBalanceDefinitionPayload)
                                                                  throws ApiException

Create balance definition Creates balance definition and returns information

Parameters:

pid - Loyalty Program Id (required)

createBalanceDefinitionPayload - Create Balance Definition Payload (required)

Returns:

BalanceDefinition

Throws:

ApiException - if fails to make API call

loyaltyBalanceProgramsPidBalanceDefinitionsPost

public BalanceDefinition loyaltyBalanceProgramsPidBalanceDefinitionsPost(@Nonnull
 UUID pid,
 @Nonnull
 CreateBalanceDefinitionPayload createBalanceDefinitionPayload,
 Map<String,String> additionalHeaders)
                                                                  throws ApiException

Create balance definition Creates balance definition and returns information

Parameters:

pid - Loyalty Program Id (required)

createBalanceDefinitionPayload - Create Balance Definition Payload (required)

additionalHeaders - additionalHeaders for this call

Returns:

BalanceDefinition

Throws:

ApiException - if fails to make API call

loyaltyBalanceProgramsPidSubscriptionsCidBalancesPost

public Balance loyaltyBalanceProgramsPidSubscriptionsCidBalancesPost(@Nonnull
 UUID pid,
 @Nonnull
 UUID cid,
 @Nonnull
 CreateBalancePayload createBalancePayload)
                                                              throws ApiException

Create subscription balances Creates a balance for a contact

Parameters:

pid - Loyalty Program Id (required)

cid - Contact Id (required)

createBalancePayload - Create Balnce Payload (required)

Returns:

Balance

Throws:

ApiException - if fails to make API call

loyaltyBalanceProgramsPidSubscriptionsCidBalancesPost

public Balance loyaltyBalanceProgramsPidSubscriptionsCidBalancesPost(@Nonnull
 UUID pid,
 @Nonnull
 UUID cid,
 @Nonnull
 CreateBalancePayload createBalancePayload,
 Map<String,String> additionalHeaders)
                                                              throws ApiException

Create subscription balances Creates a balance for a contact

Parameters:

pid - Loyalty Program Id (required)

cid - Contact Id (required)

createBalancePayload - Create Balnce Payload (required)

additionalHeaders - additionalHeaders for this call

Returns:

Balance

Throws:

ApiException - if fails to make API call

loyaltyBalanceProgramsPidTransactionHistoryGet

public TransactionHistoryResp loyaltyBalanceProgramsPidTransactionHistoryGet(@Nonnull
 UUID pid,
 @Nonnull
 Integer contactId,
 @Nonnull
 UUID balanceDefinitionId,
 @Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String sortField,
 @Nullable
 String sort,
 @Nullable
 List<String> filters)
                                                                      throws ApiException

Get Transaction History API Returns transaction history

Parameters:

pid - Loyalty Program Id (required)

contactId - Contact ID (required)

balanceDefinitionId - Balance Definition ID (required)

limit - Limit the number of records returned (optional, default to 20)

offset - Skip a number of records (optional, default to 0)

sortField - Field to sort by (optional, default to created_at)

sort - Sort order, either asc or desc (optional, default to desc)

filters - Filters to apply (optional)

Returns:

TransactionHistoryResp

Throws:

ApiException - if fails to make API call

loyaltyBalanceProgramsPidTransactionHistoryGet

public TransactionHistoryResp loyaltyBalanceProgramsPidTransactionHistoryGet(@Nonnull
 UUID pid,
 @Nonnull
 Integer contactId,
 @Nonnull
 UUID balanceDefinitionId,
 @Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String sortField,
 @Nullable
 String sort,
 @Nullable
 List<String> filters,
 Map<String,String> additionalHeaders)
                                                                      throws ApiException

Get Transaction History API Returns transaction history

Parameters:

pid - Loyalty Program Id (required)

contactId - Contact ID (required)

balanceDefinitionId - Balance Definition ID (required)

limit - Limit the number of records returned (optional, default to 20)

offset - Skip a number of records (optional, default to 0)

sortField - Field to sort by (optional, default to created_at)

sort - Sort order, either asc or desc (optional, default to desc)

filters - Filters to apply (optional)

additionalHeaders - additionalHeaders for this call

Returns:

TransactionHistoryResp

Throws:

ApiException - if fails to make API call

updateBalanceDefinition

public BalanceDefinition updateBalanceDefinition(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nonnull
 UpdateBalanceDefinitionPayload updateBalanceDefinitionPayload)
                                          throws ApiException

Update balance definition Updates Balance definition

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

updateBalanceDefinitionPayload - Create Balance Definition Payload (required)

Returns:

BalanceDefinition

Throws:

ApiException - if fails to make API call

updateBalanceDefinition

public BalanceDefinition updateBalanceDefinition(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nonnull
 UpdateBalanceDefinitionPayload updateBalanceDefinitionPayload,
 Map<String,String> additionalHeaders)
                                          throws ApiException

Update balance definition Updates Balance definition

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

updateBalanceDefinitionPayload - Create Balance Definition Payload (required)

additionalHeaders - additionalHeaders for this call

Returns:

BalanceDefinition

Throws:

ApiException - if fails to make API call

updateBalanceLimit

public BalanceLimit updateBalanceLimit(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nonnull
 UUID blid,
 @Nonnull
 UpdateBalanceLimitPayload updateBalanceLimitPayload)
                                throws ApiException

Updates balance limit Updates balance limit

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

blid - Balance Limit Id (required)

updateBalanceLimitPayload - Balance Limits Payload (required)

Returns:

BalanceLimit

Throws:

ApiException - if fails to make API call

updateBalanceLimit

public BalanceLimit updateBalanceLimit(@Nonnull
 UUID pid,
 @Nonnull
 UUID bdid,
 @Nonnull
 UUID blid,
 @Nonnull
 UpdateBalanceLimitPayload updateBalanceLimitPayload,
 Map<String,String> additionalHeaders)
                                throws ApiException

Updates balance limit Updates balance limit

Parameters:

pid - Loyalty Program Id (required)

bdid - Balance Definition Id (required)

blid - Balance Limit Id (required)

updateBalanceLimitPayload - Balance Limits Payload (required)

additionalHeaders - additionalHeaders for this call

Returns:

BalanceLimit

Throws:

ApiException - if fails to make API call

invokeAPI

public <T> T invokeAPI(String url,
 String method,
 Object request,
 com.fasterxml.jackson.core.type.TypeReference<T> returnType,
 Map<String,String> additionalHeaders)
                throws ApiException

Description copied from class: BaseApi

Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.

Specified by:

invokeAPI in class BaseApi

Parameters:

url - The URL for the request, either full URL or only the path.

method - The HTTP method for the request.

request - The request object.

returnType - The return type.

additionalHeaders - Additional headers for the request.

Returns:

The API response in the specified type.

Throws:

ApiException - if fails to make API call.