sibApi

Class SmsCampaignsApi

java.lang.Object

sibApi.SmsCampaignsApi

public class SmsCampaignsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SmsCampaignsApi()
SmsCampaignsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateModel	createSmsCampaign(CreateSmsCampaign createSmsCampaign) Creates an SMS campaign
com.squareup.okhttp.Call	createSmsCampaignAsync(CreateSmsCampaign createSmsCampaign, ApiCallback<CreateModel> callback) Creates an SMS campaign (asynchronously)
com.squareup.okhttp.Call	createSmsCampaignCall(CreateSmsCampaign createSmsCampaign, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createSmsCampaign
ApiResponse<CreateModel>	createSmsCampaignWithHttpInfo(CreateSmsCampaign createSmsCampaign) Creates an SMS campaign
void	deleteSmsCampaign(Long campaignId) Delete an SMS campaign
com.squareup.okhttp.Call	deleteSmsCampaignAsync(Long campaignId, ApiCallback<Void> callback) Delete an SMS campaign (asynchronously)
com.squareup.okhttp.Call	deleteSmsCampaignCall(Long campaignId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteSmsCampaign
ApiResponse<Void>	deleteSmsCampaignWithHttpInfo(Long campaignId) Delete an SMS campaign
ApiClient	getApiClient()
GetSmsCampaign	getSmsCampaign(Long campaignId) Get an SMS campaign
com.squareup.okhttp.Call	getSmsCampaignAsync(Long campaignId, ApiCallback<GetSmsCampaign> callback) Get an SMS campaign (asynchronously)
com.squareup.okhttp.Call	getSmsCampaignCall(Long campaignId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSmsCampaign
GetSmsCampaigns	getSmsCampaigns(String status, String startDate, String endDate, Long limit, Long offset, String sort) Returns the information for all your created SMS campaigns
com.squareup.okhttp.Call	getSmsCampaignsAsync(String status, String startDate, String endDate, Long limit, Long offset, String sort, ApiCallback<GetSmsCampaigns> callback) Returns the information for all your created SMS campaigns (asynchronously)
com.squareup.okhttp.Call	getSmsCampaignsCall(String status, String startDate, String endDate, Long limit, Long offset, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSmsCampaigns
ApiResponse<GetSmsCampaigns>	getSmsCampaignsWithHttpInfo(String status, String startDate, String endDate, Long limit, Long offset, String sort) Returns the information for all your created SMS campaigns
ApiResponse<GetSmsCampaign>	getSmsCampaignWithHttpInfo(Long campaignId) Get an SMS campaign
CreatedProcessId	requestSmsRecipientExport(Long campaignId, RequestSmsRecipientExport recipientExport) Export an SMS campaign's recipients It returns the background process ID which on completion calls the notify URL that you have set in the input.
com.squareup.okhttp.Call	requestSmsRecipientExportAsync(Long campaignId, RequestSmsRecipientExport recipientExport, ApiCallback<CreatedProcessId> callback) Export an SMS campaign's recipients (asynchronously) It returns the background process ID which on completion calls the notify URL that you have set in the input.
com.squareup.okhttp.Call	requestSmsRecipientExportCall(Long campaignId, RequestSmsRecipientExport recipientExport, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for requestSmsRecipientExport
ApiResponse<CreatedProcessId>	requestSmsRecipientExportWithHttpInfo(Long campaignId, RequestSmsRecipientExport recipientExport) Export an SMS campaign's recipients It returns the background process ID which on completion calls the notify URL that you have set in the input.
void	sendSmsCampaignNow(Long campaignId) Send your SMS campaign immediately
com.squareup.okhttp.Call	sendSmsCampaignNowAsync(Long campaignId, ApiCallback<Void> callback) Send your SMS campaign immediately (asynchronously)
com.squareup.okhttp.Call	sendSmsCampaignNowCall(Long campaignId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for sendSmsCampaignNow
ApiResponse<Void>	sendSmsCampaignNowWithHttpInfo(Long campaignId) Send your SMS campaign immediately
void	sendSmsReport(Long campaignId, SendReport sendReport) Send an SMS campaign's report Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
com.squareup.okhttp.Call	sendSmsReportAsync(Long campaignId, SendReport sendReport, ApiCallback<Void> callback) Send an SMS campaign's report (asynchronously) Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
com.squareup.okhttp.Call	sendSmsReportCall(Long campaignId, SendReport sendReport, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for sendSmsReport
ApiResponse<Void>	sendSmsReportWithHttpInfo(Long campaignId, SendReport sendReport) Send an SMS campaign's report Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
void	sendTestSms(Long campaignId, SendTestSms phoneNumber) Send a test SMS campaign
com.squareup.okhttp.Call	sendTestSmsAsync(Long campaignId, SendTestSms phoneNumber, ApiCallback<Void> callback) Send a test SMS campaign (asynchronously)
com.squareup.okhttp.Call	sendTestSmsCall(Long campaignId, SendTestSms phoneNumber, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for sendTestSms
ApiResponse<Void>	sendTestSmsWithHttpInfo(Long campaignId, SendTestSms phoneNumber) Send a test SMS campaign
void	setApiClient(ApiClient apiClient)
void	updateSmsCampaign(Long campaignId, UpdateSmsCampaign updateSmsCampaign) Update an SMS campaign
com.squareup.okhttp.Call	updateSmsCampaignAsync(Long campaignId, UpdateSmsCampaign updateSmsCampaign, ApiCallback<Void> callback) Update an SMS campaign (asynchronously)
com.squareup.okhttp.Call	updateSmsCampaignCall(Long campaignId, UpdateSmsCampaign updateSmsCampaign, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateSmsCampaign
void	updateSmsCampaignStatus(Long campaignId, UpdateCampaignStatus status) Update a campaign's status
com.squareup.okhttp.Call	updateSmsCampaignStatusAsync(Long campaignId, UpdateCampaignStatus status, ApiCallback<Void> callback) Update a campaign's status (asynchronously)
com.squareup.okhttp.Call	updateSmsCampaignStatusCall(Long campaignId, UpdateCampaignStatus status, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateSmsCampaignStatus
ApiResponse<Void>	updateSmsCampaignStatusWithHttpInfo(Long campaignId, UpdateCampaignStatus status) Update a campaign's status
ApiResponse<Void>	updateSmsCampaignWithHttpInfo(Long campaignId, UpdateSmsCampaign updateSmsCampaign) Update an SMS campaign

Methods inherited from class java.lang.Object

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

Constructor Detail

SmsCampaignsApi

public SmsCampaignsApi()

SmsCampaignsApi

public SmsCampaignsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createSmsCampaignCall

public com.squareup.okhttp.Call createSmsCampaignCall(CreateSmsCampaign createSmsCampaign,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for createSmsCampaign

Parameters:

createSmsCampaign - Values to create an SMS Campaign (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createSmsCampaign

public CreateModel createSmsCampaign(CreateSmsCampaign createSmsCampaign)
                              throws ApiException

Creates an SMS campaign

Parameters:

createSmsCampaign - Values to create an SMS Campaign (required)

Returns:

CreateModel

Throws:

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

createSmsCampaignWithHttpInfo

public ApiResponse<CreateModel> createSmsCampaignWithHttpInfo(CreateSmsCampaign createSmsCampaign)
                                                       throws ApiException

Creates an SMS campaign

Parameters:

createSmsCampaign - Values to create an SMS Campaign (required)

Returns:

ApiResponse<CreateModel>

Throws:

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

createSmsCampaignAsync

public com.squareup.okhttp.Call createSmsCampaignAsync(CreateSmsCampaign createSmsCampaign,
                                                       ApiCallback<CreateModel> callback)
                                                throws ApiException

Creates an SMS campaign (asynchronously)

Parameters:

createSmsCampaign - Values to create an SMS Campaign (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

deleteSmsCampaignCall

public com.squareup.okhttp.Call deleteSmsCampaignCall(Long campaignId,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for deleteSmsCampaign

Parameters:

campaignId - id of the SMS campaign (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteSmsCampaign

public void deleteSmsCampaign(Long campaignId)
                       throws ApiException

Delete an SMS campaign

Parameters:

campaignId - id of the SMS campaign (required)

Throws:

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

deleteSmsCampaignWithHttpInfo

public ApiResponse<Void> deleteSmsCampaignWithHttpInfo(Long campaignId)
                                                throws ApiException

Delete an SMS campaign

Parameters:

campaignId - id of the SMS campaign (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteSmsCampaignAsync

public com.squareup.okhttp.Call deleteSmsCampaignAsync(Long campaignId,
                                                       ApiCallback<Void> callback)
                                                throws ApiException

Delete an SMS campaign (asynchronously)

Parameters:

campaignId - id of the SMS campaign (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

getSmsCampaignCall

public com.squareup.okhttp.Call getSmsCampaignCall(Long campaignId,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getSmsCampaign

Parameters:

campaignId - id of the SMS campaign (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSmsCampaign

public GetSmsCampaign getSmsCampaign(Long campaignId)
                              throws ApiException

Get an SMS campaign

Parameters:

campaignId - id of the SMS campaign (required)

Returns:

GetSmsCampaign

Throws:

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

getSmsCampaignWithHttpInfo

public ApiResponse<GetSmsCampaign> getSmsCampaignWithHttpInfo(Long campaignId)
                                                       throws ApiException

Get an SMS campaign

Parameters:

campaignId - id of the SMS campaign (required)

Returns:

ApiResponse<GetSmsCampaign>

Throws:

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

getSmsCampaignAsync

public com.squareup.okhttp.Call getSmsCampaignAsync(Long campaignId,
                                                    ApiCallback<GetSmsCampaign> callback)
                                             throws ApiException

Get an SMS campaign (asynchronously)

Parameters:

campaignId - id of the SMS campaign (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

getSmsCampaignsCall

public com.squareup.okhttp.Call getSmsCampaignsCall(String status,
                                                    String startDate,
                                                    String endDate,
                                                    Long limit,
                                                    Long offset,
                                                    String sort,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for getSmsCampaigns

Parameters:

status - Status of campaign. (optional)

startDate - Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional)

endDate - Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional)

limit - Number limitation for the result returned (optional, default to 500)

offset - Beginning point in the list to retrieve from. (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSmsCampaigns

public GetSmsCampaigns getSmsCampaigns(String status,
                                       String startDate,
                                       String endDate,
                                       Long limit,
                                       Long offset,
                                       String sort)
                                throws ApiException

Returns the information for all your created SMS campaigns

Parameters:

status - Status of campaign. (optional)

startDate - Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional)

endDate - Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional)

limit - Number limitation for the result returned (optional, default to 500)

offset - Beginning point in the list to retrieve from. (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetSmsCampaigns

Throws:

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

getSmsCampaignsWithHttpInfo

public ApiResponse<GetSmsCampaigns> getSmsCampaignsWithHttpInfo(String status,
                                                                String startDate,
                                                                String endDate,
                                                                Long limit,
                                                                Long offset,
                                                                String sort)
                                                         throws ApiException

Returns the information for all your created SMS campaigns

Parameters:

status - Status of campaign. (optional)

startDate - Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional)

endDate - Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional)

limit - Number limitation for the result returned (optional, default to 500)

offset - Beginning point in the list to retrieve from. (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

ApiResponse<GetSmsCampaigns>

Throws:

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

getSmsCampaignsAsync

public com.squareup.okhttp.Call getSmsCampaignsAsync(String status,
                                                     String startDate,
                                                     String endDate,
                                                     Long limit,
                                                     Long offset,
                                                     String sort,
                                                     ApiCallback<GetSmsCampaigns> callback)
                                              throws ApiException

Returns the information for all your created SMS campaigns (asynchronously)

Parameters:

status - Status of campaign. (optional)

startDate - Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional)

endDate - Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional)

limit - Number limitation for the result returned (optional, default to 500)

offset - Beginning point in the list to retrieve from. (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

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

requestSmsRecipientExportCall

public com.squareup.okhttp.Call requestSmsRecipientExportCall(Long campaignId,
                                                              RequestSmsRecipientExport recipientExport,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for requestSmsRecipientExport

Parameters:

campaignId - id of the campaign (required)

recipientExport - Values to send for a recipient export request (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

requestSmsRecipientExport

public CreatedProcessId requestSmsRecipientExport(Long campaignId,
                                                  RequestSmsRecipientExport recipientExport)
                                           throws ApiException

Export an SMS campaign's recipients It returns the background process ID which on completion calls the notify URL that you have set in the input.

Parameters:

campaignId - id of the campaign (required)

recipientExport - Values to send for a recipient export request (optional)

Returns:

CreatedProcessId

Throws:

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

requestSmsRecipientExportWithHttpInfo

public ApiResponse<CreatedProcessId> requestSmsRecipientExportWithHttpInfo(Long campaignId,
                                                                           RequestSmsRecipientExport recipientExport)
                                                                    throws ApiException

Export an SMS campaign's recipients It returns the background process ID which on completion calls the notify URL that you have set in the input.

Parameters:

campaignId - id of the campaign (required)

recipientExport - Values to send for a recipient export request (optional)

Returns:

ApiResponse<CreatedProcessId>

Throws:

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

requestSmsRecipientExportAsync

public com.squareup.okhttp.Call requestSmsRecipientExportAsync(Long campaignId,
                                                               RequestSmsRecipientExport recipientExport,
                                                               ApiCallback<CreatedProcessId> callback)
                                                        throws ApiException

Export an SMS campaign's recipients (asynchronously) It returns the background process ID which on completion calls the notify URL that you have set in the input.

Parameters:

campaignId - id of the campaign (required)

recipientExport - Values to send for a recipient export request (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

sendSmsCampaignNowCall

public com.squareup.okhttp.Call sendSmsCampaignNowCall(Long campaignId,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for sendSmsCampaignNow

Parameters:

campaignId - id of the campaign (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

sendSmsCampaignNow

public void sendSmsCampaignNow(Long campaignId)
                        throws ApiException

Send your SMS campaign immediately

Parameters:

campaignId - id of the campaign (required)

Throws:

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

sendSmsCampaignNowWithHttpInfo

public ApiResponse<Void> sendSmsCampaignNowWithHttpInfo(Long campaignId)
                                                 throws ApiException

Send your SMS campaign immediately

Parameters:

campaignId - id of the campaign (required)

Returns:

ApiResponse<Void>

Throws:

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

sendSmsCampaignNowAsync

public com.squareup.okhttp.Call sendSmsCampaignNowAsync(Long campaignId,
                                                        ApiCallback<Void> callback)
                                                 throws ApiException

Send your SMS campaign immediately (asynchronously)

Parameters:

campaignId - id of the campaign (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

sendSmsReportCall

public com.squareup.okhttp.Call sendSmsReportCall(Long campaignId,
                                                  SendReport sendReport,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for sendSmsReport

Parameters:

campaignId - id of the campaign (required)

sendReport - Values for send a report (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

sendSmsReport

public void sendSmsReport(Long campaignId,
                          SendReport sendReport)
                   throws ApiException

Send an SMS campaign's report Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.

Parameters:

campaignId - id of the campaign (required)

sendReport - Values for send a report (required)

Throws:

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

sendSmsReportWithHttpInfo

public ApiResponse<Void> sendSmsReportWithHttpInfo(Long campaignId,
                                                   SendReport sendReport)
                                            throws ApiException

Send an SMS campaign's report Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.

Parameters:

campaignId - id of the campaign (required)

sendReport - Values for send a report (required)

Returns:

ApiResponse<Void>

Throws:

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

sendSmsReportAsync

public com.squareup.okhttp.Call sendSmsReportAsync(Long campaignId,
                                                   SendReport sendReport,
                                                   ApiCallback<Void> callback)
                                            throws ApiException

Send an SMS campaign's report (asynchronously) Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.

Parameters:

campaignId - id of the campaign (required)

sendReport - Values for send a report (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

sendTestSmsCall

public com.squareup.okhttp.Call sendTestSmsCall(Long campaignId,
                                                SendTestSms phoneNumber,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for sendTestSms

Parameters:

campaignId - Id of the SMS campaign (required)

phoneNumber - Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

sendTestSms

public void sendTestSms(Long campaignId,
                        SendTestSms phoneNumber)
                 throws ApiException

Send a test SMS campaign

Parameters:

campaignId - Id of the SMS campaign (required)

phoneNumber - Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (required)

Throws:

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

sendTestSmsWithHttpInfo

public ApiResponse<Void> sendTestSmsWithHttpInfo(Long campaignId,
                                                 SendTestSms phoneNumber)
                                          throws ApiException

Send a test SMS campaign

Parameters:

campaignId - Id of the SMS campaign (required)

phoneNumber - Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (required)

Returns:

ApiResponse<Void>

Throws:

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

sendTestSmsAsync

public com.squareup.okhttp.Call sendTestSmsAsync(Long campaignId,
                                                 SendTestSms phoneNumber,
                                                 ApiCallback<Void> callback)
                                          throws ApiException

Send a test SMS campaign (asynchronously)

Parameters:

campaignId - Id of the SMS campaign (required)

phoneNumber - Mobile number of the recipient with the country code. This number must belong to one of your contacts in SendinBlue account and must not be blacklisted (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

updateSmsCampaignCall

public com.squareup.okhttp.Call updateSmsCampaignCall(Long campaignId,
                                                      UpdateSmsCampaign updateSmsCampaign,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for updateSmsCampaign

Parameters:

campaignId - id of the SMS campaign (required)

updateSmsCampaign - Values to update an SMS Campaign (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateSmsCampaign

public void updateSmsCampaign(Long campaignId,
                              UpdateSmsCampaign updateSmsCampaign)
                       throws ApiException

Update an SMS campaign

Parameters:

campaignId - id of the SMS campaign (required)

updateSmsCampaign - Values to update an SMS Campaign (required)

Throws:

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

updateSmsCampaignWithHttpInfo

public ApiResponse<Void> updateSmsCampaignWithHttpInfo(Long campaignId,
                                                       UpdateSmsCampaign updateSmsCampaign)
                                                throws ApiException

Update an SMS campaign

Parameters:

campaignId - id of the SMS campaign (required)

updateSmsCampaign - Values to update an SMS Campaign (required)

Returns:

ApiResponse<Void>

Throws:

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

updateSmsCampaignAsync

public com.squareup.okhttp.Call updateSmsCampaignAsync(Long campaignId,
                                                       UpdateSmsCampaign updateSmsCampaign,
                                                       ApiCallback<Void> callback)
                                                throws ApiException

Update an SMS campaign (asynchronously)

Parameters:

campaignId - id of the SMS campaign (required)

updateSmsCampaign - Values to update an SMS Campaign (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

updateSmsCampaignStatusCall

public com.squareup.okhttp.Call updateSmsCampaignStatusCall(Long campaignId,
                                                            UpdateCampaignStatus status,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for updateSmsCampaignStatus

Parameters:

campaignId - id of the campaign (required)

status - Status of the campaign. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateSmsCampaignStatus

public void updateSmsCampaignStatus(Long campaignId,
                                    UpdateCampaignStatus status)
                             throws ApiException

Update a campaign's status

Parameters:

campaignId - id of the campaign (required)

status - Status of the campaign. (required)

Throws:

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

updateSmsCampaignStatusWithHttpInfo

public ApiResponse<Void> updateSmsCampaignStatusWithHttpInfo(Long campaignId,
                                                             UpdateCampaignStatus status)
                                                      throws ApiException

Update a campaign's status

Parameters:

campaignId - id of the campaign (required)

status - Status of the campaign. (required)

Returns:

ApiResponse<Void>

Throws:

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

updateSmsCampaignStatusAsync

public com.squareup.okhttp.Call updateSmsCampaignStatusAsync(Long campaignId,
                                                             UpdateCampaignStatus status,
                                                             ApiCallback<Void> callback)
                                                      throws ApiException

Update a campaign's status (asynchronously)

Parameters:

campaignId - id of the campaign (required)

status - Status of the campaign. (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