Package Avalara.SDK.api.EInvoicing.V1

Class SubscriptionsApi

java.lang.Object

Avalara.SDK.api.EInvoicing.V1.SubscriptionsApi

public class SubscriptionsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SubscriptionsApi.CreateWebhookSubscriptionRequest	Represents the Request object for the CreateWebhookSubscription API
class	SubscriptionsApi.DeleteWebhookSubscriptionRequest	Represents the Request object for the DeleteWebhookSubscription API
class	SubscriptionsApi.GetWebhookSubscriptionRequest	Represents the Request object for the GetWebhookSubscription API
class	SubscriptionsApi.ListWebhookSubscriptionsRequest	Represents the Request object for the ListWebhookSubscriptions API

Constructor Summary

Constructors

Constructor	Description
SubscriptionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
SuccessResponse	createWebhookSubscription(SubscriptionsApi.CreateWebhookSubscriptionRequest requestParameters)	Create a subscription to events Create a subscription to events exposed by registered systems.
okhttp3.Call	createWebhookSubscriptionAsync(SubscriptionsApi.CreateWebhookSubscriptionRequest requestParameters, ApiCallback<SuccessResponse> _callback)	Create a subscription to events (asynchronously) Create a subscription to events exposed by registered systems.
okhttp3.Call	createWebhookSubscriptionCall(SubscriptionsApi.CreateWebhookSubscriptionRequest requestParameters, ApiCallback _callback)	Build call for createWebhookSubscription
ApiResponse<SuccessResponse>	createWebhookSubscriptionWithHttpInfo(SubscriptionsApi.CreateWebhookSubscriptionRequest requestParameters)	Create a subscription to events Create a subscription to events exposed by registered systems.
void	deleteWebhookSubscription(SubscriptionsApi.DeleteWebhookSubscriptionRequest requestParameters)	Unsubscribe from events Remove a subscription from the webhooks dispatch service.
okhttp3.Call	deleteWebhookSubscriptionAsync(SubscriptionsApi.DeleteWebhookSubscriptionRequest requestParameters, ApiCallback<Void> _callback)	Unsubscribe from events (asynchronously) Remove a subscription from the webhooks dispatch service.
okhttp3.Call	deleteWebhookSubscriptionCall(SubscriptionsApi.DeleteWebhookSubscriptionRequest requestParameters, ApiCallback _callback)	Build call for deleteWebhookSubscription
ApiResponse<Void>	deleteWebhookSubscriptionWithHttpInfo(SubscriptionsApi.DeleteWebhookSubscriptionRequest requestParameters)	Unsubscribe from events Remove a subscription from the webhooks dispatch service.
ApiClient	getApiClient()
SubscriptionsApi.CreateWebhookSubscriptionRequest	getCreateWebhookSubscriptionRequest()	Getter function to instantiate Request class
String	getCustomBaseUrl()
SubscriptionsApi.DeleteWebhookSubscriptionRequest	getDeleteWebhookSubscriptionRequest()	Getter function to instantiate Request class
SubscriptionsApi.GetWebhookSubscriptionRequest	getGetWebhookSubscriptionRequest()	Getter function to instantiate Request class
int	getHostIndex()
SubscriptionsApi.ListWebhookSubscriptionsRequest	getListWebhookSubscriptionsRequest()	Getter function to instantiate Request class
SubscriptionDetail	getWebhookSubscription(SubscriptionsApi.GetWebhookSubscriptionRequest requestParameters)	Get details of a subscription Retrieve details of a specific subscription.
okhttp3.Call	getWebhookSubscriptionAsync(SubscriptionsApi.GetWebhookSubscriptionRequest requestParameters, ApiCallback<SubscriptionDetail> _callback)	Get details of a subscription (asynchronously) Retrieve details of a specific subscription.
okhttp3.Call	getWebhookSubscriptionCall(SubscriptionsApi.GetWebhookSubscriptionRequest requestParameters, ApiCallback _callback)	Build call for getWebhookSubscription
ApiResponse<SubscriptionDetail>	getWebhookSubscriptionWithHttpInfo(SubscriptionsApi.GetWebhookSubscriptionRequest requestParameters)	Get details of a subscription Retrieve details of a specific subscription.
SubscriptionListResponse	listWebhookSubscriptions(SubscriptionsApi.ListWebhookSubscriptionsRequest requestParameters)	List all subscriptions Retrieve a list of all subscriptions.
okhttp3.Call	listWebhookSubscriptionsAsync(SubscriptionsApi.ListWebhookSubscriptionsRequest requestParameters, ApiCallback<SubscriptionListResponse> _callback)	List all subscriptions (asynchronously) Retrieve a list of all subscriptions.
okhttp3.Call	listWebhookSubscriptionsCall(SubscriptionsApi.ListWebhookSubscriptionsRequest requestParameters, ApiCallback _callback)	Build call for listWebhookSubscriptions
ApiResponse<SubscriptionListResponse>	listWebhookSubscriptionsWithHttpInfo(SubscriptionsApi.ListWebhookSubscriptionsRequest requestParameters)	List all subscriptions Retrieve a list of all subscriptions.
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionsApi

public SubscriptionsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createWebhookSubscriptionCall

public okhttp3.Call createWebhookSubscriptionCall(SubscriptionsApi.CreateWebhookSubscriptionRequest requestParameters,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for createWebhookSubscription

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Subscribed successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
400	Invalid input	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

createWebhookSubscription

public SuccessResponse createWebhookSubscription(SubscriptionsApi.CreateWebhookSubscriptionRequest requestParameters)
                                          throws ApiException

Create a subscription to events Create a subscription to events exposed by registered systems.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

SuccessResponse

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
201	Subscribed successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
400	Invalid input	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

createWebhookSubscriptionWithHttpInfo

public ApiResponse<SuccessResponse> createWebhookSubscriptionWithHttpInfo(SubscriptionsApi.CreateWebhookSubscriptionRequest requestParameters)
                                                                   throws ApiException

Create a subscription to events Create a subscription to events exposed by registered systems.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

ApiResponse<SuccessResponse>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
201	Subscribed successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
400	Invalid input	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

createWebhookSubscriptionAsync

public okhttp3.Call createWebhookSubscriptionAsync(SubscriptionsApi.CreateWebhookSubscriptionRequest requestParameters,
                                                   ApiCallback<SuccessResponse> _callback)
                                            throws ApiException

Create a subscription to events (asynchronously) Create a subscription to events exposed by registered systems.

Parameters:

requestOptions - Object which represents the options available for a given API/request

_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

Http Response Details:

Status Code	Description	Response Headers
201	Subscribed successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
400	Invalid input	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

getCreateWebhookSubscriptionRequest

public SubscriptionsApi.CreateWebhookSubscriptionRequest getCreateWebhookSubscriptionRequest()

Getter function to instantiate Request class

deleteWebhookSubscriptionCall

public okhttp3.Call deleteWebhookSubscriptionCall(SubscriptionsApi.DeleteWebhookSubscriptionRequest requestParameters,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for deleteWebhookSubscription

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Unsubscribed successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
404	Subscription not found	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

deleteWebhookSubscription

public void deleteWebhookSubscription(SubscriptionsApi.DeleteWebhookSubscriptionRequest requestParameters)
                               throws ApiException

Unsubscribe from events Remove a subscription from the webhooks dispatch service. All events and subscriptions are also deleted.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	Unsubscribed successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
404	Subscription not found	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

deleteWebhookSubscriptionWithHttpInfo

public ApiResponse<Void> deleteWebhookSubscriptionWithHttpInfo(SubscriptionsApi.DeleteWebhookSubscriptionRequest requestParameters)
                                                        throws ApiException

Unsubscribe from events Remove a subscription from the webhooks dispatch service. All events and subscriptions are also deleted.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

ApiResponse<Void>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	Unsubscribed successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
404	Subscription not found	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

deleteWebhookSubscriptionAsync

public okhttp3.Call deleteWebhookSubscriptionAsync(SubscriptionsApi.DeleteWebhookSubscriptionRequest requestParameters,
                                                   ApiCallback<Void> _callback)
                                            throws ApiException

Unsubscribe from events (asynchronously) Remove a subscription from the webhooks dispatch service. All events and subscriptions are also deleted.

Parameters:

requestOptions - Object which represents the options available for a given API/request

_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

Http Response Details:

Status Code	Description	Response Headers
204	Unsubscribed successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
404	Subscription not found	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

getDeleteWebhookSubscriptionRequest

public SubscriptionsApi.DeleteWebhookSubscriptionRequest getDeleteWebhookSubscriptionRequest()

Getter function to instantiate Request class

getWebhookSubscriptionCall

public okhttp3.Call getWebhookSubscriptionCall(SubscriptionsApi.GetWebhookSubscriptionRequest requestParameters,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for getWebhookSubscription

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Subscription details retrieved successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
404	Subscription not found	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

getWebhookSubscription

public SubscriptionDetail getWebhookSubscription(SubscriptionsApi.GetWebhookSubscriptionRequest requestParameters)
                                          throws ApiException

Get details of a subscription Retrieve details of a specific subscription.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

SubscriptionDetail

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Subscription details retrieved successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
404	Subscription not found	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

getWebhookSubscriptionWithHttpInfo

public ApiResponse<SubscriptionDetail> getWebhookSubscriptionWithHttpInfo(SubscriptionsApi.GetWebhookSubscriptionRequest requestParameters)
                                                                   throws ApiException

Get details of a subscription Retrieve details of a specific subscription.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

ApiResponse<SubscriptionDetail>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	Subscription details retrieved successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
404	Subscription not found	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

getWebhookSubscriptionAsync

public okhttp3.Call getWebhookSubscriptionAsync(SubscriptionsApi.GetWebhookSubscriptionRequest requestParameters,
                                                ApiCallback<SubscriptionDetail> _callback)
                                         throws ApiException

Get details of a subscription (asynchronously) Retrieve details of a specific subscription.

Parameters:

requestOptions - Object which represents the options available for a given API/request

_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

Http Response Details:

Status Code	Description	Response Headers
200	Subscription details retrieved successfully	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
404	Subscription not found	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

getGetWebhookSubscriptionRequest

public SubscriptionsApi.GetWebhookSubscriptionRequest getGetWebhookSubscriptionRequest()

Getter function to instantiate Request class

listWebhookSubscriptionsCall

public okhttp3.Call listWebhookSubscriptionsCall(SubscriptionsApi.ListWebhookSubscriptionsRequest requestParameters,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for listWebhookSubscriptions

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	A list of subscriptions	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
500	Internal server error	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

listWebhookSubscriptions

public SubscriptionListResponse listWebhookSubscriptions(SubscriptionsApi.ListWebhookSubscriptionsRequest requestParameters)
                                                  throws ApiException

List all subscriptions Retrieve a list of all subscriptions.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

SubscriptionListResponse

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	A list of subscriptions	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
500	Internal server error	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

listWebhookSubscriptionsWithHttpInfo

public ApiResponse<SubscriptionListResponse> listWebhookSubscriptionsWithHttpInfo(SubscriptionsApi.ListWebhookSubscriptionsRequest requestParameters)
                                                                           throws ApiException

List all subscriptions Retrieve a list of all subscriptions.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

ApiResponse<SubscriptionListResponse>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	A list of subscriptions	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
500	Internal server error	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

listWebhookSubscriptionsAsync

public okhttp3.Call listWebhookSubscriptionsAsync(SubscriptionsApi.ListWebhookSubscriptionsRequest requestParameters,
                                                  ApiCallback<SubscriptionListResponse> _callback)
                                           throws ApiException

List all subscriptions (asynchronously) Retrieve a list of all subscriptions.

Parameters:

requestOptions - Object which represents the options available for a given API/request

_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

Http Response Details:

Status Code	Description	Response Headers
200	A list of subscriptions	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
401	Not authenticated	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
403	Access token does not have the required scope	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request
500	Internal server error	* X-Correlation-ID - Correlation ID from the request, or a new one if not provided in request

getListWebhookSubscriptionsRequest

public SubscriptionsApi.ListWebhookSubscriptionsRequest getListWebhookSubscriptionsRequest()

Getter function to instantiate Request class