com.squareup.square.api

Interface WebhookSubscriptionsApi

All Known Implementing Classes:

DefaultWebhookSubscriptionsApi

public interface WebhookSubscriptionsApi

This interface lists all the endpoints of the group. This can be overridden for the mock calls.

Method Summary

Modifier and Type	Method and Description
CreateWebhookSubscriptionResponse	createWebhookSubscription(CreateWebhookSubscriptionRequest body) Creates a webhook subscription.
CompletableFuture<CreateWebhookSubscriptionResponse>	createWebhookSubscriptionAsync(CreateWebhookSubscriptionRequest body) Creates a webhook subscription.
DeleteWebhookSubscriptionResponse	deleteWebhookSubscription(String subscriptionId) Deletes a webhook subscription.
CompletableFuture<DeleteWebhookSubscriptionResponse>	deleteWebhookSubscriptionAsync(String subscriptionId) Deletes a webhook subscription.
ListWebhookEventTypesResponse	listWebhookEventTypes(String apiVersion) Lists all webhook event types that can be subscribed to.
CompletableFuture<ListWebhookEventTypesResponse>	listWebhookEventTypesAsync(String apiVersion) Lists all webhook event types that can be subscribed to.
ListWebhookSubscriptionsResponse	listWebhookSubscriptions(String cursor, Boolean includeDisabled, String sortOrder, Integer limit) Lists all webhook subscriptions owned by your application.
CompletableFuture<ListWebhookSubscriptionsResponse>	listWebhookSubscriptionsAsync(String cursor, Boolean includeDisabled, String sortOrder, Integer limit) Lists all webhook subscriptions owned by your application.
RetrieveWebhookSubscriptionResponse	retrieveWebhookSubscription(String subscriptionId) Retrieves a webhook subscription identified by its ID.
CompletableFuture<RetrieveWebhookSubscriptionResponse>	retrieveWebhookSubscriptionAsync(String subscriptionId) Retrieves a webhook subscription identified by its ID.
TestWebhookSubscriptionResponse	testWebhookSubscription(String subscriptionId, TestWebhookSubscriptionRequest body) Tests a webhook subscription by sending a test event to the notification URL.
CompletableFuture<TestWebhookSubscriptionResponse>	testWebhookSubscriptionAsync(String subscriptionId, TestWebhookSubscriptionRequest body) Tests a webhook subscription by sending a test event to the notification URL.
UpdateWebhookSubscriptionResponse	updateWebhookSubscription(String subscriptionId, UpdateWebhookSubscriptionRequest body) Updates a webhook subscription.
CompletableFuture<UpdateWebhookSubscriptionResponse>	updateWebhookSubscriptionAsync(String subscriptionId, UpdateWebhookSubscriptionRequest body) Updates a webhook subscription.
UpdateWebhookSubscriptionSignatureKeyResponse	updateWebhookSubscriptionSignatureKey(String subscriptionId, UpdateWebhookSubscriptionSignatureKeyRequest body) Updates a webhook subscription by replacing the existing signature key with a new one.
CompletableFuture<UpdateWebhookSubscriptionSignatureKeyResponse>	updateWebhookSubscriptionSignatureKeyAsync(String subscriptionId, UpdateWebhookSubscriptionSignatureKeyRequest body) Updates a webhook subscription by replacing the existing signature key with a new one.

Method Detail

listWebhookEventTypes

ListWebhookEventTypesResponse listWebhookEventTypes(String apiVersion)
                                             throws ApiException,
                                                    IOException

Lists all webhook event types that can be subscribed to.

Parameters:

apiVersion - Optional parameter: The API version for which to list event types. Setting this field overrides the default version used by the application.

Returns:

Returns the ListWebhookEventTypesResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listWebhookEventTypesAsync

CompletableFuture<ListWebhookEventTypesResponse> listWebhookEventTypesAsync(String apiVersion)

Lists all webhook event types that can be subscribed to.

Parameters:

apiVersion - Optional parameter: The API version for which to list event types. Setting this field overrides the default version used by the application.

Returns:

Returns the ListWebhookEventTypesResponse response from the API call

listWebhookSubscriptions

ListWebhookSubscriptionsResponse listWebhookSubscriptions(String cursor,
                                                          Boolean includeDisabled,
                                                          String sortOrder,
                                                          Integer limit)
                                                   throws ApiException,
                                                          IOException

Lists all webhook subscriptions owned by your application.

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

includeDisabled - Optional parameter: Includes disabled [Subscription](entity:WebhookSubscription)s. By default, all enabled [Subscription](entity:WebhookSubscription)s are returned.

sortOrder - Optional parameter: Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order. This field defaults to ASC.

limit - Optional parameter: The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. Default: 100

Returns:

Returns the ListWebhookSubscriptionsResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

listWebhookSubscriptionsAsync

CompletableFuture<ListWebhookSubscriptionsResponse> listWebhookSubscriptionsAsync(String cursor,
                                                                                  Boolean includeDisabled,
                                                                                  String sortOrder,
                                                                                  Integer limit)

Lists all webhook subscriptions owned by your application.

Parameters:

cursor - Optional parameter: A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

includeDisabled - Optional parameter: Includes disabled [Subscription](entity:WebhookSubscription)s. By default, all enabled [Subscription](entity:WebhookSubscription)s are returned.

sortOrder - Optional parameter: Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order. This field defaults to ASC.

limit - Optional parameter: The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. Default: 100

Returns:

Returns the ListWebhookSubscriptionsResponse response from the API call

createWebhookSubscription

CreateWebhookSubscriptionResponse createWebhookSubscription(CreateWebhookSubscriptionRequest body)
                                                     throws ApiException,
                                                            IOException

Creates a webhook subscription.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateWebhookSubscriptionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

createWebhookSubscriptionAsync

CompletableFuture<CreateWebhookSubscriptionResponse> createWebhookSubscriptionAsync(CreateWebhookSubscriptionRequest body)

Creates a webhook subscription.

Parameters:

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the CreateWebhookSubscriptionResponse response from the API call

deleteWebhookSubscription

DeleteWebhookSubscriptionResponse deleteWebhookSubscription(String subscriptionId)
                                                     throws ApiException,
                                                            IOException

Deletes a webhook subscription.

Parameters:

subscriptionId - Required parameter: [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete.

Returns:

Returns the DeleteWebhookSubscriptionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

deleteWebhookSubscriptionAsync

CompletableFuture<DeleteWebhookSubscriptionResponse> deleteWebhookSubscriptionAsync(String subscriptionId)

Deletes a webhook subscription.

Parameters:

subscriptionId - Required parameter: [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete.

Returns:

Returns the DeleteWebhookSubscriptionResponse response from the API call

retrieveWebhookSubscription

RetrieveWebhookSubscriptionResponse retrieveWebhookSubscription(String subscriptionId)
                                                         throws ApiException,
                                                                IOException

Retrieves a webhook subscription identified by its ID.

Parameters:

subscriptionId - Required parameter: [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve.

Returns:

Returns the RetrieveWebhookSubscriptionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

retrieveWebhookSubscriptionAsync

CompletableFuture<RetrieveWebhookSubscriptionResponse> retrieveWebhookSubscriptionAsync(String subscriptionId)

Retrieves a webhook subscription identified by its ID.

Parameters:

subscriptionId - Required parameter: [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve.

Returns:

Returns the RetrieveWebhookSubscriptionResponse response from the API call

updateWebhookSubscription

UpdateWebhookSubscriptionResponse updateWebhookSubscription(String subscriptionId,
                                                            UpdateWebhookSubscriptionRequest body)
                                                     throws ApiException,
                                                            IOException

Updates a webhook subscription.

Parameters:

subscriptionId - Required parameter: [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateWebhookSubscriptionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateWebhookSubscriptionAsync

CompletableFuture<UpdateWebhookSubscriptionResponse> updateWebhookSubscriptionAsync(String subscriptionId,
                                                                                    UpdateWebhookSubscriptionRequest body)

Updates a webhook subscription.

Parameters:

subscriptionId - Required parameter: [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateWebhookSubscriptionResponse response from the API call

updateWebhookSubscriptionSignatureKey

UpdateWebhookSubscriptionSignatureKeyResponse updateWebhookSubscriptionSignatureKey(String subscriptionId,
                                                                                    UpdateWebhookSubscriptionSignatureKeyRequest body)
                                                                             throws ApiException,
                                                                                    IOException

Updates a webhook subscription by replacing the existing signature key with a new one.

Parameters:

subscriptionId - Required parameter: [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateWebhookSubscriptionSignatureKeyResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

updateWebhookSubscriptionSignatureKeyAsync

CompletableFuture<UpdateWebhookSubscriptionSignatureKeyResponse> updateWebhookSubscriptionSignatureKeyAsync(String subscriptionId,
                                                                                                            UpdateWebhookSubscriptionSignatureKeyRequest body)

Updates a webhook subscription by replacing the existing signature key with a new one.

Parameters:

subscriptionId - Required parameter: [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the UpdateWebhookSubscriptionSignatureKeyResponse response from the API call

testWebhookSubscription

TestWebhookSubscriptionResponse testWebhookSubscription(String subscriptionId,
                                                        TestWebhookSubscriptionRequest body)
                                                 throws ApiException,
                                                        IOException

Tests a webhook subscription by sending a test event to the notification URL.

Parameters:

subscriptionId - Required parameter: [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the TestWebhookSubscriptionResponse response from the API call

Throws:

ApiException - Represents error response from the server.

IOException - Signals that an I/O exception of some sort has occurred.

testWebhookSubscriptionAsync

CompletableFuture<TestWebhookSubscriptionResponse> testWebhookSubscriptionAsync(String subscriptionId,
                                                                                TestWebhookSubscriptionRequest body)

Tests a webhook subscription by sending a test event to the notification URL.

Parameters:

subscriptionId - Required parameter: [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test.

body - Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.

Returns:

Returns the TestWebhookSubscriptionResponse response from the API call