io.swagger.client.api

Class SubaccountsApi

java.lang.Object

io.swagger.client.api.SubaccountsApi

public class SubaccountsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SubaccountsApi()
SubaccountsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	subaccountsEmailCreditsDelete(String notes, String email, Integer credits, Boolean removeAll) Remove email, template or litmus credits from a sub-account
com.squareup.okhttp.Call	subaccountsEmailCreditsDeleteAsync(String notes, String email, Integer credits, Boolean removeAll, ApiCallback<Void> callback) Remove email, template or litmus credits from a sub-account (asynchronously)
com.squareup.okhttp.Call	subaccountsEmailCreditsDeleteCall(String notes, String email, Integer credits, Boolean removeAll, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subaccountsEmailCreditsDelete
ApiResponse<Void>	subaccountsEmailCreditsDeleteWithHttpInfo(String notes, String email, Integer credits, Boolean removeAll) Remove email, template or litmus credits from a sub-account
void	subaccountsEmailCreditsPost(SubaccountCreditsPayload body, String email) Add email credits to a sub-account
com.squareup.okhttp.Call	subaccountsEmailCreditsPostAsync(SubaccountCreditsPayload body, String email, ApiCallback<Void> callback) Add email credits to a sub-account (asynchronously)
com.squareup.okhttp.Call	subaccountsEmailCreditsPostCall(SubaccountCreditsPayload body, String email, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subaccountsEmailCreditsPost
ApiResponse<Void>	subaccountsEmailCreditsPostWithHttpInfo(SubaccountCreditsPayload body, String email) Add email credits to a sub-account
void	subaccountsEmailDelete(String email) Deletes specified Subaccount
com.squareup.okhttp.Call	subaccountsEmailDeleteAsync(String email, ApiCallback<Void> callback) Deletes specified Subaccount (asynchronously)
com.squareup.okhttp.Call	subaccountsEmailDeleteCall(String email, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subaccountsEmailDelete
ApiResponse<Void>	subaccountsEmailDeleteWithHttpInfo(String email) Deletes specified Subaccount
SubAccount	subaccountsEmailGet(String email) Retrieve info about one of your subaccounts
com.squareup.okhttp.Call	subaccountsEmailGetAsync(String email, ApiCallback<SubAccount> callback) Retrieve info about one of your subaccounts (asynchronously)
com.squareup.okhttp.Call	subaccountsEmailGetCall(String email, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subaccountsEmailGet
ApiResponse<SubAccount>	subaccountsEmailGetWithHttpInfo(String email) Retrieve info about one of your subaccounts
SubAccountSettings	subaccountsEmailSettingsGet(String email) Loads settings of subaccount
com.squareup.okhttp.Call	subaccountsEmailSettingsGetAsync(String email, ApiCallback<SubAccountSettings> callback) Loads settings of subaccount (asynchronously)
com.squareup.okhttp.Call	subaccountsEmailSettingsGetCall(String email, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subaccountsEmailSettingsGet
ApiResponse<SubAccountSettings>	subaccountsEmailSettingsGetWithHttpInfo(String email) Loads settings of subaccount
SubAccountSettings	subaccountsEmailSettingsPut(String email, SubAccountSettings body) Updates settings of specified subaccount
com.squareup.okhttp.Call	subaccountsEmailSettingsPutAsync(String email, SubAccountSettings body, ApiCallback<SubAccountSettings> callback) Updates settings of specified subaccount (asynchronously)
com.squareup.okhttp.Call	subaccountsEmailSettingsPutCall(String email, SubAccountSettings body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subaccountsEmailSettingsPut
ApiResponse<SubAccountSettings>	subaccountsEmailSettingsPutWithHttpInfo(String email, SubAccountSettings body) Updates settings of specified subaccount
List<SubAccount>	subaccountsGet(Integer limit, Integer offset) Lists all of your subaccounts
com.squareup.okhttp.Call	subaccountsGetAsync(Integer limit, Integer offset, ApiCallback<List<SubAccount>> callback) Lists all of your subaccounts (asynchronously)
com.squareup.okhttp.Call	subaccountsGetCall(Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subaccountsGet
ApiResponse<List<SubAccount>>	subaccountsGetWithHttpInfo(Integer limit, Integer offset) Lists all of your subaccounts
Account	subaccountsPost(SubaccountPayload body) Create new subaccount and provide most important data about it.
com.squareup.okhttp.Call	subaccountsPostAsync(SubaccountPayload body, ApiCallback<Account> callback) Create new subaccount and provide most important data about it.
com.squareup.okhttp.Call	subaccountsPostCall(SubaccountPayload body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subaccountsPost
ApiResponse<Account>	subaccountsPostWithHttpInfo(SubaccountPayload body) Create new subaccount and provide most important data about it.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubaccountsApi

public SubaccountsApi()

SubaccountsApi

public SubaccountsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

subaccountsEmailCreditsDeleteCall

public com.squareup.okhttp.Call subaccountsEmailCreditsDeleteCall(String notes,
                                                                  String email,
                                                                  Integer credits,
                                                                  Boolean removeAll,
                                                                  ProgressResponseBody.ProgressListener progressListener,
                                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                           throws ApiException

Build call for subaccountsEmailCreditsDelete

Parameters:

notes - Specific notes about the transaction (required)

email - Email address of sub-account (required)

credits - Amount of credits to remove (optional)

removeAll - Remove all credits of this type from sub-account (overrides credits if provided) (optional, default to False)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subaccountsEmailCreditsDelete

public void subaccountsEmailCreditsDelete(String notes,
                                          String email,
                                          Integer credits,
                                          Boolean removeAll)
                                   throws ApiException

Remove email, template or litmus credits from a sub-account

Parameters:

notes - Specific notes about the transaction (required)

email - Email address of sub-account (required)

credits - Amount of credits to remove (optional)

removeAll - Remove all credits of this type from sub-account (overrides credits if provided) (optional, default to False)

Throws:

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

subaccountsEmailCreditsDeleteWithHttpInfo

public ApiResponse<Void> subaccountsEmailCreditsDeleteWithHttpInfo(String notes,
                                                                   String email,
                                                                   Integer credits,
                                                                   Boolean removeAll)
                                                            throws ApiException

Remove email, template or litmus credits from a sub-account

Parameters:

notes - Specific notes about the transaction (required)

email - Email address of sub-account (required)

credits - Amount of credits to remove (optional)

removeAll - Remove all credits of this type from sub-account (overrides credits if provided) (optional, default to False)

Returns:

ApiResponse<Void>

Throws:

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

subaccountsEmailCreditsDeleteAsync

public com.squareup.okhttp.Call subaccountsEmailCreditsDeleteAsync(String notes,
                                                                   String email,
                                                                   Integer credits,
                                                                   Boolean removeAll,
                                                                   ApiCallback<Void> callback)
                                                            throws ApiException

Remove email, template or litmus credits from a sub-account (asynchronously)

Parameters:

notes - Specific notes about the transaction (required)

email - Email address of sub-account (required)

credits - Amount of credits to remove (optional)

removeAll - Remove all credits of this type from sub-account (overrides credits if provided) (optional, default to False)

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

subaccountsEmailCreditsPostCall

public com.squareup.okhttp.Call subaccountsEmailCreditsPostCall(SubaccountCreditsPayload body,
                                                                String email,
                                                                ProgressResponseBody.ProgressListener progressListener,
                                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                         throws ApiException

Build call for subaccountsEmailCreditsPost

Parameters:

body - Amount of credits to add (required)

email - Email address of sub-account (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subaccountsEmailCreditsPost

public void subaccountsEmailCreditsPost(SubaccountCreditsPayload body,
                                        String email)
                                 throws ApiException

Add email credits to a sub-account

Parameters:

body - Amount of credits to add (required)

email - Email address of sub-account (required)

Throws:

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

subaccountsEmailCreditsPostWithHttpInfo

public ApiResponse<Void> subaccountsEmailCreditsPostWithHttpInfo(SubaccountCreditsPayload body,
                                                                 String email)
                                                          throws ApiException

Add email credits to a sub-account

Parameters:

body - Amount of credits to add (required)

email - Email address of sub-account (required)

Returns:

ApiResponse<Void>

Throws:

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

subaccountsEmailCreditsPostAsync

public com.squareup.okhttp.Call subaccountsEmailCreditsPostAsync(SubaccountCreditsPayload body,
                                                                 String email,
                                                                 ApiCallback<Void> callback)
                                                          throws ApiException

Add email credits to a sub-account (asynchronously)

Parameters:

body - Amount of credits to add (required)

email - Email address of sub-account (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

subaccountsEmailDeleteCall

public com.squareup.okhttp.Call subaccountsEmailDeleteCall(String email,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for subaccountsEmailDelete

Parameters:

email - Email address of sub-account (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subaccountsEmailDelete

public void subaccountsEmailDelete(String email)
                            throws ApiException

Deletes specified Subaccount

Parameters:

email - Email address of sub-account (required)

Throws:

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

subaccountsEmailDeleteWithHttpInfo

public ApiResponse<Void> subaccountsEmailDeleteWithHttpInfo(String email)
                                                     throws ApiException

Deletes specified Subaccount

Parameters:

email - Email address of sub-account (required)

Returns:

ApiResponse<Void>

Throws:

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

subaccountsEmailDeleteAsync

public com.squareup.okhttp.Call subaccountsEmailDeleteAsync(String email,
                                                            ApiCallback<Void> callback)
                                                     throws ApiException

Deletes specified Subaccount (asynchronously)

Parameters:

email - Email address of sub-account (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

subaccountsEmailGetCall

public com.squareup.okhttp.Call subaccountsEmailGetCall(String email,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for subaccountsEmailGet

Parameters:

email - Email address of sub-account (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subaccountsEmailGet

public SubAccount subaccountsEmailGet(String email)
                               throws ApiException

Retrieve info about one of your subaccounts

Parameters:

email - Email address of sub-account (required)

Returns:

SubAccount

Throws:

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

subaccountsEmailGetWithHttpInfo

public ApiResponse<SubAccount> subaccountsEmailGetWithHttpInfo(String email)
                                                        throws ApiException

Retrieve info about one of your subaccounts

Parameters:

email - Email address of sub-account (required)

Returns:

ApiResponse<SubAccount>

Throws:

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

subaccountsEmailGetAsync

public com.squareup.okhttp.Call subaccountsEmailGetAsync(String email,
                                                         ApiCallback<SubAccount> callback)
                                                  throws ApiException

Retrieve info about one of your subaccounts (asynchronously)

Parameters:

email - Email address of sub-account (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

subaccountsEmailSettingsGetCall

public com.squareup.okhttp.Call subaccountsEmailSettingsGetCall(String email,
                                                                ProgressResponseBody.ProgressListener progressListener,
                                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                         throws ApiException

Build call for subaccountsEmailSettingsGet

Parameters:

email - Email address of sub-account (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subaccountsEmailSettingsGet

public SubAccountSettings subaccountsEmailSettingsGet(String email)
                                               throws ApiException

Loads settings of subaccount

Parameters:

email - Email address of sub-account (required)

Returns:

SubAccountSettings

Throws:

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

subaccountsEmailSettingsGetWithHttpInfo

public ApiResponse<SubAccountSettings> subaccountsEmailSettingsGetWithHttpInfo(String email)
                                                                        throws ApiException

Loads settings of subaccount

Parameters:

email - Email address of sub-account (required)

Returns:

ApiResponse<SubAccountSettings>

Throws:

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

subaccountsEmailSettingsGetAsync

public com.squareup.okhttp.Call subaccountsEmailSettingsGetAsync(String email,
                                                                 ApiCallback<SubAccountSettings> callback)
                                                          throws ApiException

Loads settings of subaccount (asynchronously)

Parameters:

email - Email address of sub-account (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

subaccountsEmailSettingsPutCall

public com.squareup.okhttp.Call subaccountsEmailSettingsPutCall(String email,
                                                                SubAccountSettings body,
                                                                ProgressResponseBody.ProgressListener progressListener,
                                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                         throws ApiException

Build call for subaccountsEmailSettingsPut

Parameters:

email - Email address of sub-account (required)

body - Http notification settings serialized to JSON (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subaccountsEmailSettingsPut

public SubAccountSettings subaccountsEmailSettingsPut(String email,
                                                      SubAccountSettings body)
                                               throws ApiException

Updates settings of specified subaccount

Parameters:

email - Email address of sub-account (required)

body - Http notification settings serialized to JSON (required)

Returns:

SubAccountSettings

Throws:

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

subaccountsEmailSettingsPutWithHttpInfo

public ApiResponse<SubAccountSettings> subaccountsEmailSettingsPutWithHttpInfo(String email,
                                                                               SubAccountSettings body)
                                                                        throws ApiException

Updates settings of specified subaccount

Parameters:

email - Email address of sub-account (required)

body - Http notification settings serialized to JSON (required)

Returns:

ApiResponse<SubAccountSettings>

Throws:

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

subaccountsEmailSettingsPutAsync

public com.squareup.okhttp.Call subaccountsEmailSettingsPutAsync(String email,
                                                                 SubAccountSettings body,
                                                                 ApiCallback<SubAccountSettings> callback)
                                                          throws ApiException

Updates settings of specified subaccount (asynchronously)

Parameters:

email - Email address of sub-account (required)

body - Http notification settings serialized to JSON (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

subaccountsGetCall

public com.squareup.okhttp.Call subaccountsGetCall(Integer limit,
                                                   Integer offset,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for subaccountsGet

Parameters:

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subaccountsGet

public List<SubAccount> subaccountsGet(Integer limit,
                                       Integer offset)
                                throws ApiException

Lists all of your subaccounts

Parameters:

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

List<SubAccount>

Throws:

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

subaccountsGetWithHttpInfo

public ApiResponse<List<SubAccount>> subaccountsGetWithHttpInfo(Integer limit,
                                                                Integer offset)
                                                         throws ApiException

Lists all of your subaccounts

Parameters:

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

ApiResponse<List<SubAccount>>

Throws:

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

subaccountsGetAsync

public com.squareup.okhttp.Call subaccountsGetAsync(Integer limit,
                                                    Integer offset,
                                                    ApiCallback<List<SubAccount>> callback)
                                             throws ApiException

Lists all of your subaccounts (asynchronously)

Parameters:

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

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

subaccountsPostCall

public com.squareup.okhttp.Call subaccountsPostCall(SubaccountPayload body,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for subaccountsPost

Parameters:

body - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subaccountsPost

public Account subaccountsPost(SubaccountPayload body)
                        throws ApiException

Create new subaccount and provide most important data about it.

Parameters:

body - (required)

Returns:

Account

Throws:

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

subaccountsPostWithHttpInfo

public ApiResponse<Account> subaccountsPostWithHttpInfo(SubaccountPayload body)
                                                 throws ApiException

Create new subaccount and provide most important data about it.

Parameters:

body - (required)

Returns:

ApiResponse<Account>

Throws:

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

subaccountsPostAsync

public com.squareup.okhttp.Call subaccountsPostAsync(SubaccountPayload body,
                                                     ApiCallback<Account> callback)
                                              throws ApiException

Create new subaccount and provide most important data about it. (asynchronously)

Parameters:

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