sibApi

Class TransactionalSmsApi

java.lang.Object

sibApi.TransactionalSmsApi

public class TransactionalSmsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TransactionalSmsApi()
TransactionalSmsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
GetSmsEventReport	getSmsEvents(Long limit, String startDate, String endDate, Long offset, Long days, String phoneNumber, String event, String tags, String sort) Get all your SMS activity (unaggregated events)
com.squareup.okhttp.Call	getSmsEventsAsync(Long limit, String startDate, String endDate, Long offset, Long days, String phoneNumber, String event, String tags, String sort, ApiCallback<GetSmsEventReport> callback) Get all your SMS activity (unaggregated events) (asynchronously)
com.squareup.okhttp.Call	getSmsEventsCall(Long limit, String startDate, String endDate, Long offset, Long days, String phoneNumber, String event, String tags, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSmsEvents
ApiResponse<GetSmsEventReport>	getSmsEventsWithHttpInfo(Long limit, String startDate, String endDate, Long offset, Long days, String phoneNumber, String event, String tags, String sort) Get all your SMS activity (unaggregated events)
GetTransacAggregatedSmsReport	getTransacAggregatedSmsReport(String startDate, String endDate, Long days, String tag) Get your SMS activity aggregated over a period of time
com.squareup.okhttp.Call	getTransacAggregatedSmsReportAsync(String startDate, String endDate, Long days, String tag, ApiCallback<GetTransacAggregatedSmsReport> callback) Get your SMS activity aggregated over a period of time (asynchronously)
com.squareup.okhttp.Call	getTransacAggregatedSmsReportCall(String startDate, String endDate, Long days, String tag, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getTransacAggregatedSmsReport
ApiResponse<GetTransacAggregatedSmsReport>	getTransacAggregatedSmsReportWithHttpInfo(String startDate, String endDate, Long days, String tag) Get your SMS activity aggregated over a period of time
GetTransacSmsReport	getTransacSmsReport(String startDate, String endDate, Long days, String tag, String sort) Get your SMS activity aggregated per day
com.squareup.okhttp.Call	getTransacSmsReportAsync(String startDate, String endDate, Long days, String tag, String sort, ApiCallback<GetTransacSmsReport> callback) Get your SMS activity aggregated per day (asynchronously)
com.squareup.okhttp.Call	getTransacSmsReportCall(String startDate, String endDate, Long days, String tag, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getTransacSmsReport
ApiResponse<GetTransacSmsReport>	getTransacSmsReportWithHttpInfo(String startDate, String endDate, Long days, String tag, String sort) Get your SMS activity aggregated per day
SendSms	sendTransacSms(SendTransacSms sendTransacSms) Send SMS message to a mobile number
com.squareup.okhttp.Call	sendTransacSmsAsync(SendTransacSms sendTransacSms, ApiCallback<SendSms> callback) Send SMS message to a mobile number (asynchronously)
com.squareup.okhttp.Call	sendTransacSmsCall(SendTransacSms sendTransacSms, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for sendTransacSms
ApiResponse<SendSms>	sendTransacSmsWithHttpInfo(SendTransacSms sendTransacSms) Send SMS message to a mobile number
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionalSmsApi

public TransactionalSmsApi()

TransactionalSmsApi

public TransactionalSmsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getSmsEventsCall

public com.squareup.okhttp.Call getSmsEventsCall(Long limit,
                                                 String startDate,
                                                 String endDate,
                                                 Long offset,
                                                 Long days,
                                                 String phoneNumber,
                                                 String event,
                                                 String tags,
                                                 String sort,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for getSmsEvents

Parameters:

limit - Number of documents per page (optional, default to 50)

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

offset - Index of the first document of the page (optional, default to 0)

days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)

phoneNumber - Filter the report for a specific phone number (optional)

event - Filter the report for specific events (optional)

tags - Filter the report for specific tags passed as a serialized urlencoded array (optional)

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

getSmsEvents

public GetSmsEventReport getSmsEvents(Long limit,
                                      String startDate,
                                      String endDate,
                                      Long offset,
                                      Long days,
                                      String phoneNumber,
                                      String event,
                                      String tags,
                                      String sort)
                               throws ApiException

Get all your SMS activity (unaggregated events)

Parameters:

limit - Number of documents per page (optional, default to 50)

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

offset - Index of the first document of the page (optional, default to 0)

days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)

phoneNumber - Filter the report for a specific phone number (optional)

event - Filter the report for specific events (optional)

tags - Filter the report for specific tags passed as a serialized urlencoded array (optional)

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:

GetSmsEventReport

Throws:

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

getSmsEventsWithHttpInfo

public ApiResponse<GetSmsEventReport> getSmsEventsWithHttpInfo(Long limit,
                                                               String startDate,
                                                               String endDate,
                                                               Long offset,
                                                               Long days,
                                                               String phoneNumber,
                                                               String event,
                                                               String tags,
                                                               String sort)
                                                        throws ApiException

Get all your SMS activity (unaggregated events)

Parameters:

limit - Number of documents per page (optional, default to 50)

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

offset - Index of the first document of the page (optional, default to 0)

days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)

phoneNumber - Filter the report for a specific phone number (optional)

event - Filter the report for specific events (optional)

tags - Filter the report for specific tags passed as a serialized urlencoded array (optional)

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<GetSmsEventReport>

Throws:

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

getSmsEventsAsync

public com.squareup.okhttp.Call getSmsEventsAsync(Long limit,
                                                  String startDate,
                                                  String endDate,
                                                  Long offset,
                                                  Long days,
                                                  String phoneNumber,
                                                  String event,
                                                  String tags,
                                                  String sort,
                                                  ApiCallback<GetSmsEventReport> callback)
                                           throws ApiException

Get all your SMS activity (unaggregated events) (asynchronously)

Parameters:

limit - Number of documents per page (optional, default to 50)

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

offset - Index of the first document of the page (optional, default to 0)

days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)

phoneNumber - Filter the report for a specific phone number (optional)

event - Filter the report for specific events (optional)

tags - Filter the report for specific tags passed as a serialized urlencoded array (optional)

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

getTransacAggregatedSmsReportCall

public com.squareup.okhttp.Call getTransacAggregatedSmsReportCall(String startDate,
                                                                  String endDate,
                                                                  Long days,
                                                                  String tag,
                                                                  ProgressResponseBody.ProgressListener progressListener,
                                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                           throws ApiException

Build call for getTransacAggregatedSmsReport

Parameters:

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

days - Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional)

tag - Filter on a tag (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getTransacAggregatedSmsReport

public GetTransacAggregatedSmsReport getTransacAggregatedSmsReport(String startDate,
                                                                   String endDate,
                                                                   Long days,
                                                                   String tag)
                                                            throws ApiException

Get your SMS activity aggregated over a period of time

Parameters:

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

days - Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional)

tag - Filter on a tag (optional)

Returns:

GetTransacAggregatedSmsReport

Throws:

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

getTransacAggregatedSmsReportWithHttpInfo

public ApiResponse<GetTransacAggregatedSmsReport> getTransacAggregatedSmsReportWithHttpInfo(String startDate,
                                                                                            String endDate,
                                                                                            Long days,
                                                                                            String tag)
                                                                                     throws ApiException

Get your SMS activity aggregated over a period of time

Parameters:

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

days - Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional)

tag - Filter on a tag (optional)

Returns:

ApiResponse<GetTransacAggregatedSmsReport>

Throws:

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

getTransacAggregatedSmsReportAsync

public com.squareup.okhttp.Call getTransacAggregatedSmsReportAsync(String startDate,
                                                                   String endDate,
                                                                   Long days,
                                                                   String tag,
                                                                   ApiCallback<GetTransacAggregatedSmsReport> callback)
                                                            throws ApiException

Get your SMS activity aggregated over a period of time (asynchronously)

Parameters:

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

days - Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional)

tag - Filter on a tag (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

getTransacSmsReportCall

public com.squareup.okhttp.Call getTransacSmsReportCall(String startDate,
                                                        String endDate,
                                                        Long days,
                                                        String tag,
                                                        String sort,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for getTransacSmsReport

Parameters:

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)

tag - Filter on a tag (optional)

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

getTransacSmsReport

public GetTransacSmsReport getTransacSmsReport(String startDate,
                                               String endDate,
                                               Long days,
                                               String tag,
                                               String sort)
                                        throws ApiException

Get your SMS activity aggregated per day

Parameters:

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)

tag - Filter on a tag (optional)

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:

GetTransacSmsReport

Throws:

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

getTransacSmsReportWithHttpInfo

public ApiResponse<GetTransacSmsReport> getTransacSmsReportWithHttpInfo(String startDate,
                                                                        String endDate,
                                                                        Long days,
                                                                        String tag,
                                                                        String sort)
                                                                 throws ApiException

Get your SMS activity aggregated per day

Parameters:

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)

tag - Filter on a tag (optional)

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<GetTransacSmsReport>

Throws:

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

getTransacSmsReportAsync

public com.squareup.okhttp.Call getTransacSmsReportAsync(String startDate,
                                                         String endDate,
                                                         Long days,
                                                         String tag,
                                                         String sort,
                                                         ApiCallback<GetTransacSmsReport> callback)
                                                  throws ApiException

Get your SMS activity aggregated per day (asynchronously)

Parameters:

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)

days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)

tag - Filter on a tag (optional)

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

sendTransacSmsCall

public com.squareup.okhttp.Call sendTransacSmsCall(SendTransacSms sendTransacSms,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for sendTransacSms

Parameters:

sendTransacSms - Values to send a transactional SMS (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

sendTransacSms

public SendSms sendTransacSms(SendTransacSms sendTransacSms)
                       throws ApiException

Send SMS message to a mobile number

Parameters:

sendTransacSms - Values to send a transactional SMS (required)

Returns:

SendSms

Throws:

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

sendTransacSmsWithHttpInfo

public ApiResponse<SendSms> sendTransacSmsWithHttpInfo(SendTransacSms sendTransacSms)
                                                throws ApiException

Send SMS message to a mobile number

Parameters:

sendTransacSms - Values to send a transactional SMS (required)

Returns:

ApiResponse<SendSms>

Throws:

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

sendTransacSmsAsync

public com.squareup.okhttp.Call sendTransacSmsAsync(SendTransacSms sendTransacSms,
                                                    ApiCallback<SendSms> callback)
                                             throws ApiException

Send SMS message to a mobile number (asynchronously)

Parameters:

sendTransacSms - Values to send a transactional SMS (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