Package software.xdev.brevo.api

Class ProgramApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.ProgramApi

public class ProgramApi
extends BaseApi

Field Summary

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

apiClient

Constructor Summary

Constructors

Constructor	Description
ProgramApi()
ProgramApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
LoyaltyProgram	createNewLP(CreateLoyaltyProgramPayload createLoyaltyProgramPayload)	Create loyalty program Creates loyalty program
LoyaltyProgram	createNewLP(CreateLoyaltyProgramPayload createLoyaltyProgramPayload, Map<String,String> additionalHeaders)	Create loyalty program Creates loyalty program
void	deleteContactMembers(UUID pid, String memberContactIds)	Delete subscription member Deletes member from a subscription
void	deleteContactMembers(UUID pid, String memberContactIds, Map<String,String> additionalHeaders)	Delete subscription member Deletes member from a subscription
void	deleteLoyaltyProgram(UUID pid)	Delete Loyalty Program Deletes Loyalty Program
void	deleteLoyaltyProgram(UUID pid, Map<String,String> additionalHeaders)	Delete Loyalty Program Deletes Loyalty Program
LoyaltyProgram	getLoyaltyProgramInfo(UUID pid)	Get loyalty program Info Returns loyalty program
LoyaltyProgram	getLoyaltyProgramInfo(UUID pid, Map<String,String> additionalHeaders)	Get loyalty program Info Returns loyalty program
LoyaltyProgramPage	getLPList(Integer limit, Integer offset, String sortField, String sort)	Get loyalty program list Returns list of loyalty programs
LoyaltyProgramPage	getLPList(Integer limit, Integer offset, String sortField, String sort, Map<String,String> additionalHeaders)	Get loyalty program list Returns list of loyalty programs
SubscriptionHandlerInfo	getParameterSubscriptionInfo(UUID pid, String contactId, String params, String loyaltySubscriptionId)	Get Subscription Data Get Information of balances, tiers, rewards and subscription members for a subscription
SubscriptionHandlerInfo	getParameterSubscriptionInfo(UUID pid, String contactId, String params, String loyaltySubscriptionId, Map<String,String> additionalHeaders)	Get Subscription Data Get Information of balances, tiers, rewards and subscription members for a subscription
<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.
LoyaltyProgram	partiallyUpdateLoyaltyProgram(UUID pid, PatchLoyaltyProgramPayload patchLoyaltyProgramPayload)	Partially update loyalty program Partially updates loyalty program
LoyaltyProgram	partiallyUpdateLoyaltyProgram(UUID pid, PatchLoyaltyProgramPayload patchLoyaltyProgramPayload, Map<String,String> additionalHeaders)	Partially update loyalty program Partially updates loyalty program
void	publishLoyaltyProgram(UUID pid)	Publish loyalty program Publishes loyalty program
void	publishLoyaltyProgram(UUID pid, Map<String,String> additionalHeaders)	Publish loyalty program Publishes loyalty program
SubscriptionMember	subscribeMemberToASubscription(UUID pid, AddSubscriptionMemberPayload addSubscriptionMemberPayload)	Create subscription member Add member to a subscription
SubscriptionMember	subscribeMemberToASubscription(UUID pid, AddSubscriptionMemberPayload addSubscriptionMemberPayload, Map<String,String> additionalHeaders)	Create subscription member Add member to a subscription
Subscription	subscribeToLoyaltyProgram(UUID pid, CreateSubscriptionPayload createSubscriptionPayload)	Create subscription Subscribes to a loyalty program
Subscription	subscribeToLoyaltyProgram(UUID pid, CreateSubscriptionPayload createSubscriptionPayload, Map<String,String> additionalHeaders)	Create subscription Subscribes to a loyalty program
LoyaltyProgram	updateLoyaltyProgram(UUID pid, UpdateLoyaltyProgramPayload updateLoyaltyProgramPayload)	Update loyalty program Updates loyalty program
LoyaltyProgram	updateLoyaltyProgram(UUID pid, UpdateLoyaltyProgramPayload updateLoyaltyProgramPayload, Map<String,String> additionalHeaders)	Update loyalty program Updates loyalty program

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

ProgramApi

public ProgramApi()

ProgramApi

public ProgramApi(ApiClient apiClient)

Method Details

createNewLP

public LoyaltyProgram createNewLP(@Nonnull
 CreateLoyaltyProgramPayload createLoyaltyProgramPayload)
                           throws ApiException

Create loyalty program Creates loyalty program

Parameters:

createLoyaltyProgramPayload - Payload for creating a new loyalty program. (required)

Returns:

LoyaltyProgram

Throws:

ApiException - if fails to make API call

createNewLP

public LoyaltyProgram createNewLP(@Nonnull
 CreateLoyaltyProgramPayload createLoyaltyProgramPayload,
 Map<String,String> additionalHeaders)
                           throws ApiException

Create loyalty program Creates loyalty program

Parameters:

createLoyaltyProgramPayload - Payload for creating a new loyalty program. (required)

additionalHeaders - additionalHeaders for this call

Returns:

LoyaltyProgram

Throws:

ApiException - if fails to make API call

deleteContactMembers

public void deleteContactMembers(@Nonnull
 UUID pid,
 @Nonnull
 String memberContactIds)
                          throws ApiException

Delete subscription member Deletes member from a subscription

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

memberContactIds - Comma-separated list of member contact IDs to delete from the subscription. (required)

Throws:

ApiException - if fails to make API call

deleteContactMembers

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

Delete subscription member Deletes member from a subscription

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

memberContactIds - Comma-separated list of member contact IDs to delete from the subscription. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteLoyaltyProgram

public void deleteLoyaltyProgram(@Nonnull
 UUID pid)
                          throws ApiException

Delete Loyalty Program Deletes Loyalty Program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

Throws:

ApiException - if fails to make API call

deleteLoyaltyProgram

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

Delete Loyalty Program Deletes Loyalty Program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getLPList

public LoyaltyProgramPage getLPList(@Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String sortField,
 @Nullable
 String sort)
                             throws ApiException

Get loyalty program list Returns list of loyalty programs

Parameters:

limit - Number of documents per page (optional)

offset - Index of the first document in the page (optional)

sortField - Sort documents by field (optional)

sort - Sort documents by field (optional)

Returns:

LoyaltyProgramPage

Throws:

ApiException - if fails to make API call

getLPList

public LoyaltyProgramPage getLPList(@Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String sortField,
 @Nullable
 String sort,
 Map<String,String> additionalHeaders)
                             throws ApiException

Get loyalty program list Returns list of loyalty programs

Parameters:

limit - Number of documents per page (optional)

offset - Index of the first document in the page (optional)

sortField - Sort documents by field (optional)

sort - Sort documents by field (optional)

additionalHeaders - additionalHeaders for this call

Returns:

LoyaltyProgramPage

Throws:

ApiException - if fails to make API call

getLoyaltyProgramInfo

public LoyaltyProgram getLoyaltyProgramInfo(@Nonnull
 UUID pid)
                                     throws ApiException

Get loyalty program Info Returns loyalty program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

Returns:

LoyaltyProgram

Throws:

ApiException - if fails to make API call

getLoyaltyProgramInfo

public LoyaltyProgram getLoyaltyProgramInfo(@Nonnull
 UUID pid,
 Map<String,String> additionalHeaders)
                                     throws ApiException

Get loyalty program Info Returns loyalty program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

additionalHeaders - additionalHeaders for this call

Returns:

LoyaltyProgram

Throws:

ApiException - if fails to make API call

getParameterSubscriptionInfo

public SubscriptionHandlerInfo getParameterSubscriptionInfo(@Nonnull
 UUID pid,
 @Nullable
 String contactId,
 @Nullable
 String params,
 @Nullable
 String loyaltySubscriptionId)
                                                     throws ApiException

Get Subscription Data Get Information of balances, tiers, rewards and subscription members for a subscription

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

contactId - The contact ID to filter by. (optional)

params - A list of filter parameters for querying the subscription info. (optional)

loyaltySubscriptionId - The loyalty subscription ID to filter by. (optional)

Returns:

SubscriptionHandlerInfo

Throws:

ApiException - if fails to make API call

getParameterSubscriptionInfo

public SubscriptionHandlerInfo getParameterSubscriptionInfo(@Nonnull
 UUID pid,
 @Nullable
 String contactId,
 @Nullable
 String params,
 @Nullable
 String loyaltySubscriptionId,
 Map<String,String> additionalHeaders)
                                                     throws ApiException

Get Subscription Data Get Information of balances, tiers, rewards and subscription members for a subscription

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

contactId - The contact ID to filter by. (optional)

params - A list of filter parameters for querying the subscription info. (optional)

loyaltySubscriptionId - The loyalty subscription ID to filter by. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

SubscriptionHandlerInfo

Throws:

ApiException - if fails to make API call

partiallyUpdateLoyaltyProgram

public LoyaltyProgram partiallyUpdateLoyaltyProgram(@Nonnull
 UUID pid,
 @Nonnull
 PatchLoyaltyProgramPayload patchLoyaltyProgramPayload)
                                             throws ApiException

Partially update loyalty program Partially updates loyalty program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

patchLoyaltyProgramPayload - Loyalty Program Payload (required)

Returns:

LoyaltyProgram

Throws:

ApiException - if fails to make API call

partiallyUpdateLoyaltyProgram

public LoyaltyProgram partiallyUpdateLoyaltyProgram(@Nonnull
 UUID pid,
 @Nonnull
 PatchLoyaltyProgramPayload patchLoyaltyProgramPayload,
 Map<String,String> additionalHeaders)
                                             throws ApiException

Partially update loyalty program Partially updates loyalty program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

patchLoyaltyProgramPayload - Loyalty Program Payload (required)

additionalHeaders - additionalHeaders for this call

Returns:

LoyaltyProgram

Throws:

ApiException - if fails to make API call

publishLoyaltyProgram

public void publishLoyaltyProgram(@Nonnull
 UUID pid)
                           throws ApiException

Publish loyalty program Publishes loyalty program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

Throws:

ApiException - if fails to make API call

publishLoyaltyProgram

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

Publish loyalty program Publishes loyalty program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

subscribeMemberToASubscription

public SubscriptionMember subscribeMemberToASubscription(@Nonnull
 UUID pid,
 @Nonnull
 AddSubscriptionMemberPayload addSubscriptionMemberPayload)
                                                  throws ApiException

Create subscription member Add member to a subscription

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

addSubscriptionMemberPayload - Payload for adding a subscription member. (required)

Returns:

SubscriptionMember

Throws:

ApiException - if fails to make API call

subscribeMemberToASubscription

public SubscriptionMember subscribeMemberToASubscription(@Nonnull
 UUID pid,
 @Nonnull
 AddSubscriptionMemberPayload addSubscriptionMemberPayload,
 Map<String,String> additionalHeaders)
                                                  throws ApiException

Create subscription member Add member to a subscription

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

addSubscriptionMemberPayload - Payload for adding a subscription member. (required)

additionalHeaders - additionalHeaders for this call

Returns:

SubscriptionMember

Throws:

ApiException - if fails to make API call

subscribeToLoyaltyProgram

public Subscription subscribeToLoyaltyProgram(@Nonnull
 UUID pid,
 @Nonnull
 CreateSubscriptionPayload createSubscriptionPayload)
                                       throws ApiException

Create subscription Subscribes to a loyalty program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

createSubscriptionPayload - Create Subscription Payload (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

subscribeToLoyaltyProgram

public Subscription subscribeToLoyaltyProgram(@Nonnull
 UUID pid,
 @Nonnull
 CreateSubscriptionPayload createSubscriptionPayload,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Create subscription Subscribes to a loyalty program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

createSubscriptionPayload - Create Subscription Payload (required)

additionalHeaders - additionalHeaders for this call

Returns:

Subscription

Throws:

ApiException - if fails to make API call

updateLoyaltyProgram

public LoyaltyProgram updateLoyaltyProgram(@Nonnull
 UUID pid,
 @Nonnull
 UpdateLoyaltyProgramPayload updateLoyaltyProgramPayload)
                                    throws ApiException

Update loyalty program Updates loyalty program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

updateLoyaltyProgramPayload - Update Loyalty Program Payload (required)

Returns:

LoyaltyProgram

Throws:

ApiException - if fails to make API call

updateLoyaltyProgram

public LoyaltyProgram updateLoyaltyProgram(@Nonnull
 UUID pid,
 @Nonnull
 UpdateLoyaltyProgramPayload updateLoyaltyProgramPayload,
 Map<String,String> additionalHeaders)
                                    throws ApiException

Update loyalty program Updates loyalty program

Parameters:

pid - Loyalty Program ID. A unique identifier for the loyalty program. (required)

updateLoyaltyProgramPayload - Update Loyalty Program Payload (required)

additionalHeaders - additionalHeaders for this call

Returns:

LoyaltyProgram

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.