sibApi

Class EmailCampaignsApi

java.lang.Object

sibApi.EmailCampaignsApi

public class EmailCampaignsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EmailCampaignsApi()
EmailCampaignsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateModel	createEmailCampaign(CreateEmailCampaign emailCampaigns) Create an email campaign
com.squareup.okhttp.Call	createEmailCampaignAsync(CreateEmailCampaign emailCampaigns, ApiCallback<CreateModel> callback) Create an email campaign (asynchronously)
com.squareup.okhttp.Call	createEmailCampaignCall(CreateEmailCampaign emailCampaigns, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createEmailCampaign
ApiResponse<CreateModel>	createEmailCampaignWithHttpInfo(CreateEmailCampaign emailCampaigns) Create an email campaign
void	deleteEmailCampaign(Long campaignId) Delete an email campaign
com.squareup.okhttp.Call	deleteEmailCampaignAsync(Long campaignId, ApiCallback<Void> callback) Delete an email campaign (asynchronously)
com.squareup.okhttp.Call	deleteEmailCampaignCall(Long campaignId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteEmailCampaign
ApiResponse<Void>	deleteEmailCampaignWithHttpInfo(Long campaignId) Delete an email campaign
CreatedProcessId	emailExportRecipients(Long campaignId, EmailExportRecipients recipientExport) Export the recipients of an email campaign
com.squareup.okhttp.Call	emailExportRecipientsAsync(Long campaignId, EmailExportRecipients recipientExport, ApiCallback<CreatedProcessId> callback) Export the recipients of an email campaign (asynchronously)
com.squareup.okhttp.Call	emailExportRecipientsCall(Long campaignId, EmailExportRecipients recipientExport, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for emailExportRecipients
ApiResponse<CreatedProcessId>	emailExportRecipientsWithHttpInfo(Long campaignId, EmailExportRecipients recipientExport) Export the recipients of an email campaign
AbTestCampaignResult	getAbTestCampaignResult(Long campaignId) Get an A/B test email campaign results Obtain winning version of an A/B test email campaign
com.squareup.okhttp.Call	getAbTestCampaignResultAsync(Long campaignId, ApiCallback<AbTestCampaignResult> callback) Get an A/B test email campaign results (asynchronously) Obtain winning version of an A/B test email campaign
com.squareup.okhttp.Call	getAbTestCampaignResultCall(Long campaignId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAbTestCampaignResult
ApiResponse<AbTestCampaignResult>	getAbTestCampaignResultWithHttpInfo(Long campaignId) Get an A/B test email campaign results Obtain winning version of an A/B test email campaign
ApiClient	getApiClient()
GetEmailCampaign	getEmailCampaign(Long campaignId) Get an email campaign report
com.squareup.okhttp.Call	getEmailCampaignAsync(Long campaignId, ApiCallback<GetEmailCampaign> callback) Get an email campaign report (asynchronously)
com.squareup.okhttp.Call	getEmailCampaignCall(Long campaignId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getEmailCampaign
GetEmailCampaigns	getEmailCampaigns(String type, String status, String startDate, String endDate, Long limit, Long offset, String sort) Return all your created email campaigns
com.squareup.okhttp.Call	getEmailCampaignsAsync(String type, String status, String startDate, String endDate, Long limit, Long offset, String sort, ApiCallback<GetEmailCampaigns> callback) Return all your created email campaigns (asynchronously)
com.squareup.okhttp.Call	getEmailCampaignsCall(String type, String status, String startDate, String endDate, Long limit, Long offset, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getEmailCampaigns
ApiResponse<GetEmailCampaigns>	getEmailCampaignsWithHttpInfo(String type, String status, String startDate, String endDate, Long limit, Long offset, String sort) Return all your created email campaigns
ApiResponse<GetEmailCampaign>	getEmailCampaignWithHttpInfo(Long campaignId) Get an email campaign report
GetSharedTemplateUrl	getSharedTemplateUrl(Long campaignId) Get a shared template url Get a unique URL to share & import an email template from one Sendinblue account to another.
com.squareup.okhttp.Call	getSharedTemplateUrlAsync(Long campaignId, ApiCallback<GetSharedTemplateUrl> callback) Get a shared template url (asynchronously) Get a unique URL to share & import an email template from one Sendinblue account to another.
com.squareup.okhttp.Call	getSharedTemplateUrlCall(Long campaignId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSharedTemplateUrl
ApiResponse<GetSharedTemplateUrl>	getSharedTemplateUrlWithHttpInfo(Long campaignId) Get a shared template url Get a unique URL to share & import an email template from one Sendinblue account to another.
void	sendEmailCampaignNow(Long campaignId) Send an email campaign immediately, based on campaignId
com.squareup.okhttp.Call	sendEmailCampaignNowAsync(Long campaignId, ApiCallback<Void> callback) Send an email campaign immediately, based on campaignId (asynchronously)
com.squareup.okhttp.Call	sendEmailCampaignNowCall(Long campaignId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for sendEmailCampaignNow
ApiResponse<Void>	sendEmailCampaignNowWithHttpInfo(Long campaignId) Send an email campaign immediately, based on campaignId
void	sendReport(Long campaignId, SendReport sendReport) Send the report of a campaign A PDF will be sent to the specified email addresses
com.squareup.okhttp.Call	sendReportAsync(Long campaignId, SendReport sendReport, ApiCallback<Void> callback) Send the report of a campaign (asynchronously) A PDF will be sent to the specified email addresses
com.squareup.okhttp.Call	sendReportCall(Long campaignId, SendReport sendReport, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for sendReport
ApiResponse<Void>	sendReportWithHttpInfo(Long campaignId, SendReport sendReport) Send the report of a campaign A PDF will be sent to the specified email addresses
void	sendTestEmail(Long campaignId, SendTestEmail emailTo) Send an email campaign to your test list
com.squareup.okhttp.Call	sendTestEmailAsync(Long campaignId, SendTestEmail emailTo, ApiCallback<Void> callback) Send an email campaign to your test list (asynchronously)
com.squareup.okhttp.Call	sendTestEmailCall(Long campaignId, SendTestEmail emailTo, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for sendTestEmail
ApiResponse<Void>	sendTestEmailWithHttpInfo(Long campaignId, SendTestEmail emailTo) Send an email campaign to your test list
void	setApiClient(ApiClient apiClient)
void	updateCampaignStatus(Long campaignId, UpdateCampaignStatus status) Update an email campaign status
com.squareup.okhttp.Call	updateCampaignStatusAsync(Long campaignId, UpdateCampaignStatus status, ApiCallback<Void> callback) Update an email campaign status (asynchronously)
com.squareup.okhttp.Call	updateCampaignStatusCall(Long campaignId, UpdateCampaignStatus status, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateCampaignStatus
ApiResponse<Void>	updateCampaignStatusWithHttpInfo(Long campaignId, UpdateCampaignStatus status) Update an email campaign status
void	updateEmailCampaign(Long campaignId, UpdateEmailCampaign emailCampaign) Update an email campaign
com.squareup.okhttp.Call	updateEmailCampaignAsync(Long campaignId, UpdateEmailCampaign emailCampaign, ApiCallback<Void> callback) Update an email campaign (asynchronously)
com.squareup.okhttp.Call	updateEmailCampaignCall(Long campaignId, UpdateEmailCampaign emailCampaign, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateEmailCampaign
ApiResponse<Void>	updateEmailCampaignWithHttpInfo(Long campaignId, UpdateEmailCampaign emailCampaign) Update an email campaign
void	uploadImageToGallery(UploadImageToGallery uploadImage) Upload an image to your account's image gallery
com.squareup.okhttp.Call	uploadImageToGalleryAsync(UploadImageToGallery uploadImage, ApiCallback<Void> callback) Upload an image to your account's image gallery (asynchronously)
com.squareup.okhttp.Call	uploadImageToGalleryCall(UploadImageToGallery uploadImage, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for uploadImageToGallery
ApiResponse<Void>	uploadImageToGalleryWithHttpInfo(UploadImageToGallery uploadImage) Upload an image to your account's image gallery

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailCampaignsApi

public EmailCampaignsApi()

EmailCampaignsApi

public EmailCampaignsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createEmailCampaignCall

public com.squareup.okhttp.Call createEmailCampaignCall(CreateEmailCampaign emailCampaigns,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for createEmailCampaign

Parameters:

emailCampaigns - Values to create a campaign (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createEmailCampaign

public CreateModel createEmailCampaign(CreateEmailCampaign emailCampaigns)
                                throws ApiException

Create an email campaign

Parameters:

emailCampaigns - Values to create a campaign (required)

Returns:

CreateModel

Throws:

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

createEmailCampaignWithHttpInfo

public ApiResponse<CreateModel> createEmailCampaignWithHttpInfo(CreateEmailCampaign emailCampaigns)
                                                         throws ApiException

Create an email campaign

Parameters:

emailCampaigns - Values to create a campaign (required)

Returns:

ApiResponse<CreateModel>

Throws:

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

createEmailCampaignAsync

public com.squareup.okhttp.Call createEmailCampaignAsync(CreateEmailCampaign emailCampaigns,
                                                         ApiCallback<CreateModel> callback)
                                                  throws ApiException

Create an email campaign (asynchronously)

Parameters:

emailCampaigns - Values to create a 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

deleteEmailCampaignCall

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

Build call for deleteEmailCampaign

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

deleteEmailCampaign

public void deleteEmailCampaign(Long campaignId)
                         throws ApiException

Delete an email campaign

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

deleteEmailCampaignWithHttpInfo

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

Delete an email campaign

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

deleteEmailCampaignAsync

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

Delete an email campaign (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

emailExportRecipientsCall

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

Build call for emailExportRecipients

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

emailExportRecipients

public CreatedProcessId emailExportRecipients(Long campaignId,
                                              EmailExportRecipients recipientExport)
                                       throws ApiException

Export the recipients of an email campaign

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

emailExportRecipientsWithHttpInfo

public ApiResponse<CreatedProcessId> emailExportRecipientsWithHttpInfo(Long campaignId,
                                                                       EmailExportRecipients recipientExport)
                                                                throws ApiException

Export the recipients of an email campaign

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

emailExportRecipientsAsync

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

Export the recipients of an email campaign (asynchronously)

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

getAbTestCampaignResultCall

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

Build call for getAbTestCampaignResult

Parameters:

campaignId - Id of the A/B test campaign (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAbTestCampaignResult

public AbTestCampaignResult getAbTestCampaignResult(Long campaignId)
                                             throws ApiException

Get an A/B test email campaign results Obtain winning version of an A/B test email campaign

Parameters:

campaignId - Id of the A/B test campaign (required)

Returns:

AbTestCampaignResult

Throws:

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

getAbTestCampaignResultWithHttpInfo

public ApiResponse<AbTestCampaignResult> getAbTestCampaignResultWithHttpInfo(Long campaignId)
                                                                      throws ApiException

Get an A/B test email campaign results Obtain winning version of an A/B test email campaign

Parameters:

campaignId - Id of the A/B test campaign (required)

Returns:

ApiResponse<AbTestCampaignResult>

Throws:

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

getAbTestCampaignResultAsync

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

Get an A/B test email campaign results (asynchronously) Obtain winning version of an A/B test email campaign

Parameters:

campaignId - Id of the A/B test 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

getEmailCampaignCall

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

Build call for getEmailCampaign

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

getEmailCampaign

public GetEmailCampaign getEmailCampaign(Long campaignId)
                                  throws ApiException

Get an email campaign report

Parameters:

campaignId - Id of the campaign (required)

Returns:

GetEmailCampaign

Throws:

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

getEmailCampaignWithHttpInfo

public ApiResponse<GetEmailCampaign> getEmailCampaignWithHttpInfo(Long campaignId)
                                                           throws ApiException

Get an email campaign report

Parameters:

campaignId - Id of the campaign (required)

Returns:

ApiResponse<GetEmailCampaign>

Throws:

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

getEmailCampaignAsync

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

Get an email campaign report (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

getEmailCampaignsCall

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

Build call for getEmailCampaigns

Parameters:

type - Filter on the type of the campaigns (optional)

status - Filter on the status of the campaign (optional)

startDate - Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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 email 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 of documents per page (optional, default to 500)

offset - Index of the first document in the page (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

getEmailCampaigns

public GetEmailCampaigns getEmailCampaigns(String type,
                                           String status,
                                           String startDate,
                                           String endDate,
                                           Long limit,
                                           Long offset,
                                           String sort)
                                    throws ApiException

Return all your created email campaigns

Parameters:

type - Filter on the type of the campaigns (optional)

status - Filter on the status of the campaign (optional)

startDate - Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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 email 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 of documents per page (optional, default to 500)

offset - Index of the first document in the page (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:

GetEmailCampaigns

Throws:

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

getEmailCampaignsWithHttpInfo

public ApiResponse<GetEmailCampaigns> getEmailCampaignsWithHttpInfo(String type,
                                                                    String status,
                                                                    String startDate,
                                                                    String endDate,
                                                                    Long limit,
                                                                    Long offset,
                                                                    String sort)
                                                             throws ApiException

Return all your created email campaigns

Parameters:

type - Filter on the type of the campaigns (optional)

status - Filter on the status of the campaign (optional)

startDate - Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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 email 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 of documents per page (optional, default to 500)

offset - Index of the first document in the page (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<GetEmailCampaigns>

Throws:

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

getEmailCampaignsAsync

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

Return all your created email campaigns (asynchronously)

Parameters:

type - Filter on the type of the campaigns (optional)

status - Filter on the status of the campaign (optional)

startDate - Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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 email 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 of documents per page (optional, default to 500)

offset - Index of the first document in the page (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

getSharedTemplateUrlCall

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

Build call for getSharedTemplateUrl

Parameters:

campaignId - Id of the campaign or template (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSharedTemplateUrl

public GetSharedTemplateUrl getSharedTemplateUrl(Long campaignId)
                                          throws ApiException

Get a shared template url Get a unique URL to share & import an email template from one Sendinblue account to another.

Parameters:

campaignId - Id of the campaign or template (required)

Returns:

GetSharedTemplateUrl

Throws:

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

getSharedTemplateUrlWithHttpInfo

public ApiResponse<GetSharedTemplateUrl> getSharedTemplateUrlWithHttpInfo(Long campaignId)
                                                                   throws ApiException

Get a shared template url Get a unique URL to share & import an email template from one Sendinblue account to another.

Parameters:

campaignId - Id of the campaign or template (required)

Returns:

ApiResponse<GetSharedTemplateUrl>

Throws:

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

getSharedTemplateUrlAsync

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

Get a shared template url (asynchronously) Get a unique URL to share & import an email template from one Sendinblue account to another.

Parameters:

campaignId - Id of the campaign or template (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

sendEmailCampaignNowCall

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

Build call for sendEmailCampaignNow

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

sendEmailCampaignNow

public void sendEmailCampaignNow(Long campaignId)
                          throws ApiException

Send an email campaign immediately, based on campaignId

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

sendEmailCampaignNowWithHttpInfo

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

Send an email campaign immediately, based on campaignId

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

sendEmailCampaignNowAsync

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

Send an email campaign immediately, based on campaignId (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

sendReportCall

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

Build call for sendReport

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

sendReport

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

Send the report of a campaign A PDF will be sent to the specified email addresses

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

sendReportWithHttpInfo

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

Send the report of a campaign A PDF will be sent to the specified email addresses

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

sendReportAsync

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

Send the report of a campaign (asynchronously) A PDF will be sent to the specified email addresses

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

sendTestEmailCall

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

Build call for sendTestEmail

Parameters:

campaignId - Id of the campaign (required)

emailTo - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

sendTestEmail

public void sendTestEmail(Long campaignId,
                          SendTestEmail emailTo)
                   throws ApiException

Send an email campaign to your test list

Parameters:

campaignId - Id of the campaign (required)

emailTo - (required)

Throws:

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

sendTestEmailWithHttpInfo

public ApiResponse<Void> sendTestEmailWithHttpInfo(Long campaignId,
                                                   SendTestEmail emailTo)
                                            throws ApiException

Send an email campaign to your test list

Parameters:

campaignId - Id of the campaign (required)

emailTo - (required)

Returns:

ApiResponse<Void>

Throws:

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

sendTestEmailAsync

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

Send an email campaign to your test list (asynchronously)

Parameters:

campaignId - Id of the campaign (required)

emailTo - (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

updateCampaignStatusCall

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

Build call for updateCampaignStatus

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

updateCampaignStatus

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

Update an email campaign 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

updateCampaignStatusWithHttpInfo

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

Update an email campaign 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

updateCampaignStatusAsync

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

Update an email campaign 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

updateEmailCampaignCall

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

Build call for updateEmailCampaign

Parameters:

campaignId - Id of the campaign (required)

emailCampaign - Values to update a campaign (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateEmailCampaign

public void updateEmailCampaign(Long campaignId,
                                UpdateEmailCampaign emailCampaign)
                         throws ApiException

Update an email campaign

Parameters:

campaignId - Id of the campaign (required)

emailCampaign - Values to update a campaign (required)

Throws:

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

updateEmailCampaignWithHttpInfo

public ApiResponse<Void> updateEmailCampaignWithHttpInfo(Long campaignId,
                                                         UpdateEmailCampaign emailCampaign)
                                                  throws ApiException

Update an email campaign

Parameters:

campaignId - Id of the campaign (required)

emailCampaign - Values to update a campaign (required)

Returns:

ApiResponse<Void>

Throws:

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

updateEmailCampaignAsync

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

Update an email campaign (asynchronously)

Parameters:

campaignId - Id of the campaign (required)

emailCampaign - Values to update a 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

uploadImageToGalleryCall

public com.squareup.okhttp.Call uploadImageToGalleryCall(UploadImageToGallery uploadImage,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for uploadImageToGallery

Parameters:

uploadImage - Parameters to upload an image (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

uploadImageToGallery

public void uploadImageToGallery(UploadImageToGallery uploadImage)
                          throws ApiException

Upload an image to your account's image gallery

Parameters:

uploadImage - Parameters to upload an image (required)

Throws:

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

uploadImageToGalleryWithHttpInfo

public ApiResponse<Void> uploadImageToGalleryWithHttpInfo(UploadImageToGallery uploadImage)
                                                   throws ApiException

Upload an image to your account's image gallery

Parameters:

uploadImage - Parameters to upload an image (required)

Returns:

ApiResponse<Void>

Throws:

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

uploadImageToGalleryAsync

public com.squareup.okhttp.Call uploadImageToGalleryAsync(UploadImageToGallery uploadImage,
                                                          ApiCallback<Void> callback)
                                                   throws ApiException

Upload an image to your account's image gallery (asynchronously)

Parameters:

uploadImage - Parameters to upload an image (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