Package io.voucherify.client.api

Class CustomersApi

java.lang.Object

io.voucherify.client.api.CustomersApi

public class CustomersApi
extends Object

Constructor Summary

Constructors

Constructor	Description
CustomersApi()
CustomersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CustomersCreateResponseBody	createCustomer(CustomersCreateRequestBody customersCreateRequestBody)	Create Customer Creates a customer object.
okhttp3.Call	createCustomerAsync(CustomersCreateRequestBody customersCreateRequestBody, ApiCallback<CustomersCreateResponseBody> _callback)	Create Customer (asynchronously) Creates a customer object.
okhttp3.Call	createCustomerCall(CustomersCreateRequestBody customersCreateRequestBody, ApiCallback _callback)	Build call for createCustomer
ApiResponse<CustomersCreateResponseBody>	createCustomerWithHttpInfo(CustomersCreateRequestBody customersCreateRequestBody)	Create Customer Creates a customer object.
CustomersPermanentDeletionCreateResponseBody	customerPermanentlyDeletion(String customerId)	Delete Customer Permanently The organization user can remove consumer data permanently from the Voucherify system by using this API method.
okhttp3.Call	customerPermanentlyDeletionAsync(String customerId, ApiCallback<CustomersPermanentDeletionCreateResponseBody> _callback)	Delete Customer Permanently (asynchronously) The organization user can remove consumer data permanently from the Voucherify system by using this API method.
okhttp3.Call	customerPermanentlyDeletionCall(String customerId, ApiCallback _callback)	Build call for customerPermanentlyDeletion
ApiResponse<CustomersPermanentDeletionCreateResponseBody>	customerPermanentlyDeletionWithHttpInfo(String customerId)	Delete Customer Permanently The organization user can remove consumer data permanently from the Voucherify system by using this API method.
void	deleteCustomer(String customerId)	Delete Customer This method deletes a customer.
okhttp3.Call	deleteCustomerAsync(String customerId, ApiCallback<Void> _callback)	Delete Customer (asynchronously) This method deletes a customer.
okhttp3.Call	deleteCustomerCall(String customerId, ApiCallback _callback)	Build call for deleteCustomer
ApiResponse<Void>	deleteCustomerWithHttpInfo(String customerId)	Delete Customer This method deletes a customer.
ApiClient	getApiClient()
String	getCustomBaseUrl()
CustomersGetResponseBody	getCustomer(String customerId)	Get Customer Retrieve customer details.
okhttp3.Call	getCustomerAsync(String customerId, ApiCallback<CustomersGetResponseBody> _callback)	Get Customer (asynchronously) Retrieve customer details.
okhttp3.Call	getCustomerCall(String customerId, ApiCallback _callback)	Build call for getCustomer
ApiResponse<CustomersGetResponseBody>	getCustomerWithHttpInfo(String customerId)	Get Customer Retrieve customer details.
int	getHostIndex()
CustomersImportCsvCreateResponseBody	importCustomersUsingCsv(File _file)	Import and Update Customers using CSV This API method lets you import or update customer data.
okhttp3.Call	importCustomersUsingCsvAsync(File _file, ApiCallback<CustomersImportCsvCreateResponseBody> _callback)	Import and Update Customers using CSV (asynchronously) This API method lets you import or update customer data.
okhttp3.Call	importCustomersUsingCsvCall(File _file, ApiCallback _callback)	Build call for importCustomersUsingCsv
ApiResponse<CustomersImportCsvCreateResponseBody>	importCustomersUsingCsvWithHttpInfo(File _file)	Import and Update Customers using CSV This API method lets you import or update customer data.
CustomersActivityListResponseBody	listCustomerActivity(String customerId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId, OffsetDateTime startDate, OffsetDateTime endDate, String campaignId, ParameterCampaignType campaignType, ParameterActivityCategory category, String type)	List Customer Activity Retrieve customer activities.
okhttp3.Call	listCustomerActivityAsync(String customerId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId, OffsetDateTime startDate, OffsetDateTime endDate, String campaignId, ParameterCampaignType campaignType, ParameterActivityCategory category, String type, ApiCallback<CustomersActivityListResponseBody> _callback)	List Customer Activity (asynchronously) Retrieve customer activities.
okhttp3.Call	listCustomerActivityCall(String customerId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId, OffsetDateTime startDate, OffsetDateTime endDate, String campaignId, ParameterCampaignType campaignType, ParameterActivityCategory category, String type, ApiCallback _callback)	Build call for listCustomerActivity
ApiResponse<CustomersActivityListResponseBody>	listCustomerActivityWithHttpInfo(String customerId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId, OffsetDateTime startDate, OffsetDateTime endDate, String campaignId, ParameterCampaignType campaignType, ParameterActivityCategory category, String type)	List Customer Activity Retrieve customer activities.
CustomersRedeemablesListResponseBody	listCustomerRedeemables(String customerId, Integer limit, ParameterOrderListRedeemables order, String startingAfterId, ParameterFiltersListCustomerRedeemables filters)	List Customer's Redeemables Retrieves all the redeemables that have been assigned to the customer.
okhttp3.Call	listCustomerRedeemablesAsync(String customerId, Integer limit, ParameterOrderListRedeemables order, String startingAfterId, ParameterFiltersListCustomerRedeemables filters, ApiCallback<CustomersRedeemablesListResponseBody> _callback)	List Customer's Redeemables (asynchronously) Retrieves all the redeemables that have been assigned to the customer.
okhttp3.Call	listCustomerRedeemablesCall(String customerId, Integer limit, ParameterOrderListRedeemables order, String startingAfterId, ParameterFiltersListCustomerRedeemables filters, ApiCallback _callback)	Build call for listCustomerRedeemables
ApiResponse<CustomersRedeemablesListResponseBody>	listCustomerRedeemablesWithHttpInfo(String customerId, Integer limit, ParameterOrderListRedeemables order, String startingAfterId, ParameterFiltersListCustomerRedeemables filters)	List Customer's Redeemables Retrieves all the redeemables that have been assigned to the customer.
CustomersListResponseBody	listCustomers(Integer limit, Integer page, String email, String city, String name, String segmentId, OffsetDateTime createdAtBefore, OffsetDateTime createdAtAfter, OffsetDateTime updatedAtBefore, OffsetDateTime updatedAtAfter, ParameterOrderListCustomers order, OffsetDateTime startingAfter)	List Customers Returns a list of customers.
okhttp3.Call	listCustomersAsync(Integer limit, Integer page, String email, String city, String name, String segmentId, OffsetDateTime createdAtBefore, OffsetDateTime createdAtAfter, OffsetDateTime updatedAtBefore, OffsetDateTime updatedAtAfter, ParameterOrderListCustomers order, OffsetDateTime startingAfter, ApiCallback<CustomersListResponseBody> _callback)	List Customers (asynchronously) Returns a list of customers.
okhttp3.Call	listCustomersCall(Integer limit, Integer page, String email, String city, String name, String segmentId, OffsetDateTime createdAtBefore, OffsetDateTime createdAtAfter, OffsetDateTime updatedAtBefore, OffsetDateTime updatedAtAfter, ParameterOrderListCustomers order, OffsetDateTime startingAfter, ApiCallback _callback)	Build call for listCustomers
CustomersSegmentsListResponseBody	listCustomerSegments(String customerId)	List Customer's Segments Returns the list of segments IDs to which the customer belongs to.
okhttp3.Call	listCustomerSegmentsAsync(String customerId, ApiCallback<CustomersSegmentsListResponseBody> _callback)	List Customer's Segments (asynchronously) Returns the list of segments IDs to which the customer belongs to.
okhttp3.Call	listCustomerSegmentsCall(String customerId, ApiCallback _callback)	Build call for listCustomerSegments
ApiResponse<CustomersSegmentsListResponseBody>	listCustomerSegmentsWithHttpInfo(String customerId)	List Customer's Segments Returns the list of segments IDs to which the customer belongs to.
ApiResponse<CustomersListResponseBody>	listCustomersWithHttpInfo(Integer limit, Integer page, String email, String city, String name, String segmentId, OffsetDateTime createdAtBefore, OffsetDateTime createdAtAfter, OffsetDateTime updatedAtBefore, OffsetDateTime updatedAtAfter, ParameterOrderListCustomers order, OffsetDateTime startingAfter)	List Customers Returns a list of customers.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
CustomersUpdateResponseBody	updateCustomer(String customerId, CustomersUpdateRequestBody customersUpdateRequestBody)	Update Customer Updates the specified customer by setting the values of the parameters passed in the request body.
okhttp3.Call	updateCustomerAsync(String customerId, CustomersUpdateRequestBody customersUpdateRequestBody, ApiCallback<CustomersUpdateResponseBody> _callback)	Update Customer (asynchronously) Updates the specified customer by setting the values of the parameters passed in the request body.
okhttp3.Call	updateCustomerCall(String customerId, CustomersUpdateRequestBody customersUpdateRequestBody, ApiCallback _callback)	Build call for updateCustomer
CustomersUpdateInBulkResponseBody	updateCustomersInBulk(List<CustomersUpdateInBulkRequestBody> customersUpdateInBulkRequestBody)	Update Customers in Bulk Updates customers in one asynchronous operation.
okhttp3.Call	updateCustomersInBulkAsync(List<CustomersUpdateInBulkRequestBody> customersUpdateInBulkRequestBody, ApiCallback<CustomersUpdateInBulkResponseBody> _callback)	Update Customers in Bulk (asynchronously) Updates customers in one asynchronous operation.
okhttp3.Call	updateCustomersInBulkCall(List<CustomersUpdateInBulkRequestBody> customersUpdateInBulkRequestBody, ApiCallback _callback)	Build call for updateCustomersInBulk
ApiResponse<CustomersUpdateInBulkResponseBody>	updateCustomersInBulkWithHttpInfo(List<CustomersUpdateInBulkRequestBody> customersUpdateInBulkRequestBody)	Update Customers in Bulk Updates customers in one asynchronous operation.
CustomersMetadataUpdateInBulkResponseBody	updateCustomersMetadataInBulk(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody)	Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers.
okhttp3.Call	updateCustomersMetadataInBulkAsync(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody, ApiCallback<CustomersMetadataUpdateInBulkResponseBody> _callback)	Update Customers' Metadata in Bulk (asynchronously) Updates metadata parameters for a list of customers.
okhttp3.Call	updateCustomersMetadataInBulkCall(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody, ApiCallback _callback)	Build call for updateCustomersMetadataInBulk
ApiResponse<CustomersMetadataUpdateInBulkResponseBody>	updateCustomersMetadataInBulkWithHttpInfo(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody)	Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers.
ApiResponse<CustomersUpdateResponseBody>	updateCustomerWithHttpInfo(String customerId, CustomersUpdateRequestBody customersUpdateRequestBody)	Update Customer Updates the specified customer by setting the values of the parameters passed in the request body.

Methods inherited from class java.lang.Object

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

Constructor Details

CustomersApi

public CustomersApi()

CustomersApi

public CustomersApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createCustomerCall

public okhttp3.Call createCustomerCall(CustomersCreateRequestBody customersCreateRequestBody,
 ApiCallback _callback)
                                throws ApiException

Build call for createCustomer

Parameters:

customersCreateRequestBody - Create a customer with specified parameters. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createCustomer

public CustomersCreateResponseBody createCustomer(CustomersCreateRequestBody customersCreateRequestBody)
                                           throws ApiException

Create Customer Creates a customer object. 📘 Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields.

Parameters:

customersCreateRequestBody - Create a customer with specified parameters. (optional)

Returns:

CustomersCreateResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createCustomerWithHttpInfo

public ApiResponse<CustomersCreateResponseBody> createCustomerWithHttpInfo(CustomersCreateRequestBody customersCreateRequestBody)
                                                                    throws ApiException

Create Customer Creates a customer object. 📘 Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields.

Parameters:

customersCreateRequestBody - Create a customer with specified parameters. (optional)

Returns:

ApiResponse<CustomersCreateResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createCustomerAsync

public okhttp3.Call createCustomerAsync(CustomersCreateRequestBody customersCreateRequestBody,
 ApiCallback<CustomersCreateResponseBody> _callback)
                                 throws ApiException

Create Customer (asynchronously) Creates a customer object. 📘 Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields.

Parameters:

customersCreateRequestBody - Create a customer with specified parameters. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

customerPermanentlyDeletionCall

public okhttp3.Call customerPermanentlyDeletionCall(String customerId,
 ApiCallback _callback)
                                             throws ApiException

Build call for customerPermanentlyDeletion

Parameters:

customerId - A Voucherify customers id or source_id. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

customerPermanentlyDeletion

public CustomersPermanentDeletionCreateResponseBody customerPermanentlyDeletion(String customerId)
                                                                         throws ApiException

Delete Customer Permanently The organization user can remove consumer data permanently from the Voucherify system by using this API method. It deletes all customer data and connected resources. It makes the customer profile forgotten by Voucherify.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

Returns:

CustomersPermanentDeletionCreateResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

customerPermanentlyDeletionWithHttpInfo

public ApiResponse<CustomersPermanentDeletionCreateResponseBody> customerPermanentlyDeletionWithHttpInfo(String customerId)
                                                                                                  throws ApiException

Delete Customer Permanently The organization user can remove consumer data permanently from the Voucherify system by using this API method. It deletes all customer data and connected resources. It makes the customer profile forgotten by Voucherify.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

Returns:

ApiResponse<CustomersPermanentDeletionCreateResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

customerPermanentlyDeletionAsync

public okhttp3.Call customerPermanentlyDeletionAsync(String customerId,
 ApiCallback<CustomersPermanentDeletionCreateResponseBody> _callback)
                                              throws ApiException

Delete Customer Permanently (asynchronously) The organization user can remove consumer data permanently from the Voucherify system by using this API method. It deletes all customer data and connected resources. It makes the customer profile forgotten by Voucherify.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

deleteCustomerCall

public okhttp3.Call deleteCustomerCall(String customerId,
 ApiCallback _callback)
                                throws ApiException

Build call for deleteCustomer

Parameters:

customerId - A Voucherify customers id or source_id. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteCustomer

public void deleteCustomer(String customerId)
                    throws ApiException

Delete Customer This method deletes a customer.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteCustomerWithHttpInfo

public ApiResponse<Void> deleteCustomerWithHttpInfo(String customerId)
                                             throws ApiException

Delete Customer This method deletes a customer.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteCustomerAsync

public okhttp3.Call deleteCustomerAsync(String customerId,
 ApiCallback<Void> _callback)
                                 throws ApiException

Delete Customer (asynchronously) This method deletes a customer.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getCustomerCall

public okhttp3.Call getCustomerCall(String customerId,
 ApiCallback _callback)
                             throws ApiException

Build call for getCustomer

Parameters:

customerId - A Voucherify customers id or source_id. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCustomer

public CustomersGetResponseBody getCustomer(String customerId)
                                     throws ApiException

Get Customer Retrieve customer details.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

Returns:

CustomersGetResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCustomerWithHttpInfo

public ApiResponse<CustomersGetResponseBody> getCustomerWithHttpInfo(String customerId)
                                                              throws ApiException

Get Customer Retrieve customer details.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

Returns:

ApiResponse<CustomersGetResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getCustomerAsync

public okhttp3.Call getCustomerAsync(String customerId,
 ApiCallback<CustomersGetResponseBody> _callback)
                              throws ApiException

Get Customer (asynchronously) Retrieve customer details.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

importCustomersUsingCsvCall

public okhttp3.Call importCustomersUsingCsvCall(File _file,
 ApiCallback _callback)
                                         throws ApiException

Build call for importCustomersUsingCsv

Parameters:

_file - File path. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

importCustomersUsingCsv

public CustomersImportCsvCreateResponseBody importCustomersUsingCsv(File _file)
                                                             throws ApiException

Import and Update Customers using CSV This API method lets you import or update customer data. To get a proper and valid response, please send a CSV file with data separated by commas. # Request Example # CSV File Format The CSV file has to include headers in the first line. All properties which cannot be mapped to standard customer fields will be added to the metadata object. 📘 Standard customer fields mapping **No spaces allowed in field names** Id, Name, Email, Phone, Birthdate, Source_id, Address_line_1, Address_line_2, Address_Postal_Code, Address_City, Address_State, Address_Country, Description, Metadata_name_1, Metadata_name_2 # Update Customers using CSV If you would like to update customers data, you can do it using the CSV file with new data. However, remember to include a source_id in your CSV file to manage the update successfully. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.

Parameters:

_file - File path. (optional)

Returns:

CustomersImportCsvCreateResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

importCustomersUsingCsvWithHttpInfo

public ApiResponse<CustomersImportCsvCreateResponseBody> importCustomersUsingCsvWithHttpInfo(File _file)
                                                                                      throws ApiException

Import and Update Customers using CSV This API method lets you import or update customer data. To get a proper and valid response, please send a CSV file with data separated by commas. # Request Example # CSV File Format The CSV file has to include headers in the first line. All properties which cannot be mapped to standard customer fields will be added to the metadata object. 📘 Standard customer fields mapping **No spaces allowed in field names** Id, Name, Email, Phone, Birthdate, Source_id, Address_line_1, Address_line_2, Address_Postal_Code, Address_City, Address_State, Address_Country, Description, Metadata_name_1, Metadata_name_2 # Update Customers using CSV If you would like to update customers data, you can do it using the CSV file with new data. However, remember to include a source_id in your CSV file to manage the update successfully. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.

Parameters:

_file - File path. (optional)

Returns:

ApiResponse<CustomersImportCsvCreateResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

importCustomersUsingCsvAsync

public okhttp3.Call importCustomersUsingCsvAsync(File _file,
 ApiCallback<CustomersImportCsvCreateResponseBody> _callback)
                                          throws ApiException

Import and Update Customers using CSV (asynchronously) This API method lets you import or update customer data. To get a proper and valid response, please send a CSV file with data separated by commas. # Request Example # CSV File Format The CSV file has to include headers in the first line. All properties which cannot be mapped to standard customer fields will be added to the metadata object. 📘 Standard customer fields mapping **No spaces allowed in field names** Id, Name, Email, Phone, Birthdate, Source_id, Address_line_1, Address_line_2, Address_Postal_Code, Address_City, Address_State, Address_Country, Description, Metadata_name_1, Metadata_name_2 # Update Customers using CSV If you would like to update customers data, you can do it using the CSV file with new data. However, remember to include a source_id in your CSV file to manage the update successfully. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.

Parameters:

_file - File path. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

listCustomerActivityCall

public okhttp3.Call listCustomerActivityCall(String customerId,
 Integer limit,
 ParameterOrderCreatedAt order,
 String startingAfterId,
 OffsetDateTime startDate,
 OffsetDateTime endDate,
 String campaignId,
 ParameterCampaignType campaignType,
 ParameterActivityCategory category,
 String type,
 ApiCallback _callback)
                                      throws ApiException

Build call for listCustomerActivity

Parameters:

customerId - A Voucherify customers id or source ID of the customer who performed the activities. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

order - Apply this filter to order the events according the date and time when it was created. (optional)

startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)

startDate - Timestamp representing the date and time which results must begin on. Represented in ISO 8601 format. (optional)

endDate - Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. (optional)

campaignId - Requests only events related to specific campaign identified by its ID. (optional)

campaignType - Filters related customers activity for the selected campaign types. Allowed values: DISCOUNT_COUPONS, REFERRAL_PROGRAM, GIFT_VOUCHERS, PROMOTION, LOYALTY_PROGRAM. (optional)

category - Filters activities for actions or effects. Allowed values: ACTION, EFFECT. (optional)

type - Event name of the customer event. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listCustomerActivity

public CustomersActivityListResponseBody listCustomerActivity(String customerId,
 Integer limit,
 ParameterOrderCreatedAt order,
 String startingAfterId,
 OffsetDateTime startDate,
 OffsetDateTime endDate,
 String campaignId,
 ParameterCampaignType campaignType,
 ParameterActivityCategory category,
 String type)
                                                       throws ApiException

List Customer Activity Retrieve customer activities.

Parameters:

customerId - A Voucherify customers id or source ID of the customer who performed the activities. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

order - Apply this filter to order the events according the date and time when it was created. (optional)

startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)

startDate - Timestamp representing the date and time which results must begin on. Represented in ISO 8601 format. (optional)

endDate - Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. (optional)

campaignId - Requests only events related to specific campaign identified by its ID. (optional)

campaignType - Filters related customers activity for the selected campaign types. Allowed values: DISCOUNT_COUPONS, REFERRAL_PROGRAM, GIFT_VOUCHERS, PROMOTION, LOYALTY_PROGRAM. (optional)

category - Filters activities for actions or effects. Allowed values: ACTION, EFFECT. (optional)

type - Event name of the customer event. (optional)

Returns:

CustomersActivityListResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

listCustomerActivityWithHttpInfo

public ApiResponse<CustomersActivityListResponseBody> listCustomerActivityWithHttpInfo(String customerId,
 Integer limit,
 ParameterOrderCreatedAt order,
 String startingAfterId,
 OffsetDateTime startDate,
 OffsetDateTime endDate,
 String campaignId,
 ParameterCampaignType campaignType,
 ParameterActivityCategory category,
 String type)
                                                                                throws ApiException

List Customer Activity Retrieve customer activities.

Parameters:

customerId - A Voucherify customers id or source ID of the customer who performed the activities. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

order - Apply this filter to order the events according the date and time when it was created. (optional)

startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)

startDate - Timestamp representing the date and time which results must begin on. Represented in ISO 8601 format. (optional)

endDate - Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. (optional)

campaignId - Requests only events related to specific campaign identified by its ID. (optional)

campaignType - Filters related customers activity for the selected campaign types. Allowed values: DISCOUNT_COUPONS, REFERRAL_PROGRAM, GIFT_VOUCHERS, PROMOTION, LOYALTY_PROGRAM. (optional)

category - Filters activities for actions or effects. Allowed values: ACTION, EFFECT. (optional)

type - Event name of the customer event. (optional)

Returns:

ApiResponse<CustomersActivityListResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

listCustomerActivityAsync

public okhttp3.Call listCustomerActivityAsync(String customerId,
 Integer limit,
 ParameterOrderCreatedAt order,
 String startingAfterId,
 OffsetDateTime startDate,
 OffsetDateTime endDate,
 String campaignId,
 ParameterCampaignType campaignType,
 ParameterActivityCategory category,
 String type,
 ApiCallback<CustomersActivityListResponseBody> _callback)
                                       throws ApiException

List Customer Activity (asynchronously) Retrieve customer activities.

Parameters:

customerId - A Voucherify customers id or source ID of the customer who performed the activities. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

order - Apply this filter to order the events according the date and time when it was created. (optional)

startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)

startDate - Timestamp representing the date and time which results must begin on. Represented in ISO 8601 format. (optional)

endDate - Timestamp representing the date and time which results must end on. Represented in ISO 8601 format. (optional)

campaignId - Requests only events related to specific campaign identified by its ID. (optional)

campaignType - Filters related customers activity for the selected campaign types. Allowed values: DISCOUNT_COUPONS, REFERRAL_PROGRAM, GIFT_VOUCHERS, PROMOTION, LOYALTY_PROGRAM. (optional)

category - Filters activities for actions or effects. Allowed values: ACTION, EFFECT. (optional)

type - Event name of the customer event. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

listCustomerRedeemablesCall

public okhttp3.Call listCustomerRedeemablesCall(String customerId,
 Integer limit,
 ParameterOrderListRedeemables order,
 String startingAfterId,
 ParameterFiltersListCustomerRedeemables filters,
 ApiCallback _callback)
                                         throws ApiException

Build call for listCustomerRedeemables

Parameters:

customerId - Unique identifier of a customer represented by an internal customer ID or customer source ID. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)

filters - Filters for listing customer redeemables. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listCustomerRedeemables

public CustomersRedeemablesListResponseBody listCustomerRedeemables(String customerId,
 Integer limit,
 ParameterOrderListRedeemables order,
 String startingAfterId,
 ParameterFiltersListCustomerRedeemables filters)
                                                             throws ApiException

List Customer's Redeemables Retrieves all the redeemables that have been assigned to the customer. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)

Parameters:

customerId - Unique identifier of a customer represented by an internal customer ID or customer source ID. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)

filters - Filters for listing customer redeemables. (optional)

Returns:

CustomersRedeemablesListResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

listCustomerRedeemablesWithHttpInfo

public ApiResponse<CustomersRedeemablesListResponseBody> listCustomerRedeemablesWithHttpInfo(String customerId,
 Integer limit,
 ParameterOrderListRedeemables order,
 String startingAfterId,
 ParameterFiltersListCustomerRedeemables filters)
                                                                                      throws ApiException

List Customer's Redeemables Retrieves all the redeemables that have been assigned to the customer. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)

Parameters:

customerId - Unique identifier of a customer represented by an internal customer ID or customer source ID. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)

filters - Filters for listing customer redeemables. (optional)

Returns:

ApiResponse<CustomersRedeemablesListResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

listCustomerRedeemablesAsync

public okhttp3.Call listCustomerRedeemablesAsync(String customerId,
 Integer limit,
 ParameterOrderListRedeemables order,
 String startingAfterId,
 ParameterFiltersListCustomerRedeemables filters,
 ApiCallback<CustomersRedeemablesListResponseBody> _callback)
                                          throws ApiException

List Customer's Redeemables (asynchronously) Retrieves all the redeemables that have been assigned to the customer. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)

Parameters:

customerId - Unique identifier of a customer represented by an internal customer ID or customer source ID. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)

filters - Filters for listing customer redeemables. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

listCustomerSegmentsCall

public okhttp3.Call listCustomerSegmentsCall(String customerId,
 ApiCallback _callback)
                                      throws ApiException

Build call for listCustomerSegments

Parameters:

customerId - Unique identifier of a customer represented by an internal customer ID or customer source ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listCustomerSegments

public CustomersSegmentsListResponseBody listCustomerSegments(String customerId)
                                                       throws ApiException

List Customer's Segments Returns the list of segments IDs to which the customer belongs to. If you pass a customerId which is not stored and recognized by Voucherify as an existing customer in the system, the response will generate a list of segments that the customer would potentialy qualify for if they were to become a customer tracked in the system.

Parameters:

customerId - Unique identifier of a customer represented by an internal customer ID or customer source ID. (required)

Returns:

CustomersSegmentsListResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

listCustomerSegmentsWithHttpInfo

public ApiResponse<CustomersSegmentsListResponseBody> listCustomerSegmentsWithHttpInfo(String customerId)
                                                                                throws ApiException

List Customer's Segments Returns the list of segments IDs to which the customer belongs to. If you pass a customerId which is not stored and recognized by Voucherify as an existing customer in the system, the response will generate a list of segments that the customer would potentialy qualify for if they were to become a customer tracked in the system.

Parameters:

customerId - Unique identifier of a customer represented by an internal customer ID or customer source ID. (required)

Returns:

ApiResponse<CustomersSegmentsListResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

listCustomerSegmentsAsync

public okhttp3.Call listCustomerSegmentsAsync(String customerId,
 ApiCallback<CustomersSegmentsListResponseBody> _callback)
                                       throws ApiException

List Customer's Segments (asynchronously) Returns the list of segments IDs to which the customer belongs to. If you pass a customerId which is not stored and recognized by Voucherify as an existing customer in the system, the response will generate a list of segments that the customer would potentialy qualify for if they were to become a customer tracked in the system.

Parameters:

customerId - Unique identifier of a customer represented by an internal customer ID or customer source ID. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

listCustomersCall

public okhttp3.Call listCustomersCall(Integer limit,
 Integer page,
 String email,
 String city,
 String name,
 String segmentId,
 OffsetDateTime createdAtBefore,
 OffsetDateTime createdAtAfter,
 OffsetDateTime updatedAtBefore,
 OffsetDateTime updatedAtAfter,
 ParameterOrderListCustomers order,
 OffsetDateTime startingAfter,
 ApiCallback _callback)
                               throws ApiException

Build call for listCustomers

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

email - Limit the customers to the ones that have this specific email address. (optional)

city - Limit the customers to the ones that are located in the specified city. (optional)

name - Filter customers by the name property. (optional)

segmentId - Filter customers by the segment id. (optional)

createdAtBefore - Filter customers by date customer was created. (optional)

createdAtAfter - Filter customers by date customer was created. (optional)

updatedAtBefore - Filter customers by date customer was updated last time. (optional)

updatedAtAfter - Filter customers by date customer was updated last time. (optional)

order - This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfter - A cursor for pagination. This is a date-time value that defines your place in the list based on created_at property from the customer object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listCustomers

public CustomersListResponseBody listCustomers(Integer limit,
 Integer page,
 String email,
 String city,
 String name,
 String segmentId,
 OffsetDateTime createdAtBefore,
 OffsetDateTime createdAtAfter,
 OffsetDateTime updatedAtBefore,
 OffsetDateTime updatedAtAfter,
 ParameterOrderListCustomers order,
 OffsetDateTime startingAfter)
                                        throws ApiException

List Customers Returns a list of customers.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

email - Limit the customers to the ones that have this specific email address. (optional)

city - Limit the customers to the ones that are located in the specified city. (optional)

name - Filter customers by the name property. (optional)

segmentId - Filter customers by the segment id. (optional)

createdAtBefore - Filter customers by date customer was created. (optional)

createdAtAfter - Filter customers by date customer was created. (optional)

updatedAtBefore - Filter customers by date customer was updated last time. (optional)

updatedAtAfter - Filter customers by date customer was updated last time. (optional)

order - This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfter - A cursor for pagination. This is a date-time value that defines your place in the list based on created_at property from the customer object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list. (optional)

Returns:

CustomersListResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

listCustomersWithHttpInfo

public ApiResponse<CustomersListResponseBody> listCustomersWithHttpInfo(Integer limit,
 Integer page,
 String email,
 String city,
 String name,
 String segmentId,
 OffsetDateTime createdAtBefore,
 OffsetDateTime createdAtAfter,
 OffsetDateTime updatedAtBefore,
 OffsetDateTime updatedAtAfter,
 ParameterOrderListCustomers order,
 OffsetDateTime startingAfter)
                                                                 throws ApiException

List Customers Returns a list of customers.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

email - Limit the customers to the ones that have this specific email address. (optional)

city - Limit the customers to the ones that are located in the specified city. (optional)

name - Filter customers by the name property. (optional)

segmentId - Filter customers by the segment id. (optional)

createdAtBefore - Filter customers by date customer was created. (optional)

createdAtAfter - Filter customers by date customer was created. (optional)

updatedAtBefore - Filter customers by date customer was updated last time. (optional)

updatedAtAfter - Filter customers by date customer was updated last time. (optional)

order - This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfter - A cursor for pagination. This is a date-time value that defines your place in the list based on created_at property from the customer object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list. (optional)

Returns:

ApiResponse<CustomersListResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

listCustomersAsync

public okhttp3.Call listCustomersAsync(Integer limit,
 Integer page,
 String email,
 String city,
 String name,
 String segmentId,
 OffsetDateTime createdAtBefore,
 OffsetDateTime createdAtAfter,
 OffsetDateTime updatedAtBefore,
 OffsetDateTime updatedAtAfter,
 ParameterOrderListCustomers order,
 OffsetDateTime startingAfter,
 ApiCallback<CustomersListResponseBody> _callback)
                                throws ApiException

List Customers (asynchronously) Returns a list of customers.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

email - Limit the customers to the ones that have this specific email address. (optional)

city - Limit the customers to the ones that are located in the specified city. (optional)

name - Filter customers by the name property. (optional)

segmentId - Filter customers by the segment id. (optional)

createdAtBefore - Filter customers by date customer was created. (optional)

createdAtAfter - Filter customers by date customer was created. (optional)

updatedAtBefore - Filter customers by date customer was updated last time. (optional)

updatedAtAfter - Filter customers by date customer was updated last time. (optional)

order - This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfter - A cursor for pagination. This is a date-time value that defines your place in the list based on created_at property from the customer object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after 2020-05-24T13:43:09.024Z in order to fetch the next page of the list. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

updateCustomerCall

public okhttp3.Call updateCustomerCall(String customerId,
 CustomersUpdateRequestBody customersUpdateRequestBody,
 ApiCallback _callback)
                                throws ApiException

Build call for updateCustomer

Parameters:

customerId - A Voucherify customers id or source_id. (required)

customersUpdateRequestBody - Specify the parameters to be updated. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateCustomer

public CustomersUpdateResponseBody updateCustomer(String customerId,
 CustomersUpdateRequestBody customersUpdateRequestBody)
                                           throws ApiException

Update Customer Updates the specified customer by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

customersUpdateRequestBody - Specify the parameters to be updated. (optional)

Returns:

CustomersUpdateResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateCustomerWithHttpInfo

public ApiResponse<CustomersUpdateResponseBody> updateCustomerWithHttpInfo(String customerId,
 CustomersUpdateRequestBody customersUpdateRequestBody)
                                                                    throws ApiException

Update Customer Updates the specified customer by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

customersUpdateRequestBody - Specify the parameters to be updated. (optional)

Returns:

ApiResponse<CustomersUpdateResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateCustomerAsync

public okhttp3.Call updateCustomerAsync(String customerId,
 CustomersUpdateRequestBody customersUpdateRequestBody,
 ApiCallback<CustomersUpdateResponseBody> _callback)
                                 throws ApiException

Update Customer (asynchronously) Updates the specified customer by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged.

Parameters:

customerId - A Voucherify customers id or source_id. (required)

customersUpdateRequestBody - Specify the parameters to be updated. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

updateCustomersInBulkCall

public okhttp3.Call updateCustomersInBulkCall(List<CustomersUpdateInBulkRequestBody> customersUpdateInBulkRequestBody,
 ApiCallback _callback)
                                       throws ApiException

Build call for updateCustomersInBulk

Parameters:

customersUpdateInBulkRequestBody - List the customer fields to be updated in each customer object. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateCustomersInBulk

public CustomersUpdateInBulkResponseBody updateCustomersInBulk(List<CustomersUpdateInBulkRequestBody> customersUpdateInBulkRequestBody)
                                                        throws ApiException

Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.

Parameters:

customersUpdateInBulkRequestBody - List the customer fields to be updated in each customer object. (optional)

Returns:

CustomersUpdateInBulkResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateCustomersInBulkWithHttpInfo

public ApiResponse<CustomersUpdateInBulkResponseBody> updateCustomersInBulkWithHttpInfo(List<CustomersUpdateInBulkRequestBody> customersUpdateInBulkRequestBody)
                                                                                 throws ApiException

Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.

Parameters:

customersUpdateInBulkRequestBody - List the customer fields to be updated in each customer object. (optional)

Returns:

ApiResponse<CustomersUpdateInBulkResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateCustomersInBulkAsync

public okhttp3.Call updateCustomersInBulkAsync(List<CustomersUpdateInBulkRequestBody> customersUpdateInBulkRequestBody,
 ApiCallback<CustomersUpdateInBulkResponseBody> _callback)
                                        throws ApiException

Update Customers in Bulk (asynchronously) Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.

Parameters:

customersUpdateInBulkRequestBody - List the customer fields to be updated in each customer object. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

updateCustomersMetadataInBulkCall

public okhttp3.Call updateCustomersMetadataInBulkCall(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody,
 ApiCallback _callback)
                                               throws ApiException

Build call for updateCustomersMetadataInBulk

Parameters:

customersMetadataUpdateInBulkRequestBody - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateCustomersMetadataInBulk

public CustomersMetadataUpdateInBulkResponseBody updateCustomersMetadataInBulk(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody)
                                                                        throws ApiException

Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.

Parameters:

customersMetadataUpdateInBulkRequestBody - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional)

Returns:

CustomersMetadataUpdateInBulkResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateCustomersMetadataInBulkWithHttpInfo

public ApiResponse<CustomersMetadataUpdateInBulkResponseBody> updateCustomersMetadataInBulkWithHttpInfo(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody)
                                                                                                 throws ApiException

Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.

Parameters:

customersMetadataUpdateInBulkRequestBody - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional)

Returns:

ApiResponse<CustomersMetadataUpdateInBulkResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateCustomersMetadataInBulkAsync

public okhttp3.Call updateCustomersMetadataInBulkAsync(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody,
 ApiCallback<CustomersMetadataUpdateInBulkResponseBody> _callback)
                                                throws ApiException

Update Customers' Metadata in Bulk (asynchronously) Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.

Parameters:

customersMetadataUpdateInBulkRequestBody - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object