Package com.zendesk.sunshine_conversations_client.api

Class WebhooksApi

java.lang.Object

com.zendesk.sunshine_conversations_client.api.WebhooksApi

public class WebhooksApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
WebhooksApi()
WebhooksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
WebhookResponse	createWebhook(WebhookCreateBody webhookCreateBody, java.lang.String appId, java.lang.String integrationId)	Create Webhook Creates a new webhook associated with a Sunshine Conversations Connect integration or a custom integration.
WebhookResponse	createWebhook(java.lang.String bearerToken, WebhookCreateBody webhookCreateBody, java.lang.String appId, java.lang.String integrationId)	Create Webhook Creates a new webhook associated with a Sunshine Conversations Connect integration or a custom integration.
java.lang.Object	deleteWebhook(java.lang.String appId, java.lang.String integrationId, java.lang.String webhookId)	Delete Webhook Deletes the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.
java.lang.Object	deleteWebhook(java.lang.String bearerToken, java.lang.String appId, java.lang.String integrationId, java.lang.String webhookId)	Delete Webhook Deletes the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.
ApiClient	getApiClient()
WebhookResponse	getWebhook(java.lang.String appId, java.lang.String integrationId, java.lang.String webhookId)	Get Webhook Gets the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.
WebhookResponse	getWebhook(java.lang.String bearerToken, java.lang.String appId, java.lang.String integrationId, java.lang.String webhookId)	Get Webhook Gets the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.
WebhookListResponse	listWebhooks(java.lang.String appId, java.lang.String integrationId)	List Webhooks Lists all webhooks for a given Sunshine Conversations Connect integration or custom integration.
WebhookListResponse	listWebhooks(java.lang.String bearerToken, java.lang.String appId, java.lang.String integrationId)	List Webhooks Lists all webhooks for a given Sunshine Conversations Connect integration or custom integration.
void	setApiClient(ApiClient apiClient)
WebhookResponse	updateWebhook(WebhookBody webhookBody, java.lang.String appId, java.lang.String integrationId, java.lang.String webhookId)	Update Webhook Updates the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.
WebhookResponse	updateWebhook(java.lang.String bearerToken, WebhookBody webhookBody, java.lang.String appId, java.lang.String integrationId, java.lang.String webhookId)	Update Webhook Updates the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebhooksApi

public WebhooksApi()

WebhooksApi

public WebhooksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createWebhook

public WebhookResponse createWebhook(WebhookCreateBody webhookCreateBody,
                                     java.lang.String appId,
                                     java.lang.String integrationId)
                              throws ApiException

Create Webhook Creates a new webhook associated with a Sunshine Conversations Connect integration or a custom integration.

Parameters:

webhookCreateBody - (required)

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a WebhookResponse

Throws:

ApiException - if fails to make API call

deleteWebhook

public java.lang.Object deleteWebhook(java.lang.String appId,
                                      java.lang.String integrationId,
                                      java.lang.String webhookId)
                               throws ApiException

Delete Webhook Deletes the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.

Parameters:

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

webhookId - The id of the webhook. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

getWebhook

public WebhookResponse getWebhook(java.lang.String appId,
                                  java.lang.String integrationId,
                                  java.lang.String webhookId)
                           throws ApiException

Get Webhook Gets the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.

Parameters:

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

webhookId - The id of the webhook. (required)

Returns:

a WebhookResponse

Throws:

ApiException - if fails to make API call

listWebhooks

public WebhookListResponse listWebhooks(java.lang.String appId,
                                        java.lang.String integrationId)
                                 throws ApiException

List Webhooks Lists all webhooks for a given Sunshine Conversations Connect integration or custom integration.

Parameters:

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a WebhookListResponse

Throws:

ApiException - if fails to make API call

updateWebhook

public WebhookResponse updateWebhook(WebhookBody webhookBody,
                                     java.lang.String appId,
                                     java.lang.String integrationId,
                                     java.lang.String webhookId)
                              throws ApiException

Update Webhook Updates the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.

Parameters:

webhookBody - (required)

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

webhookId - The id of the webhook. (required)

Returns:

a WebhookResponse

Throws:

ApiException - if fails to make API call

createWebhook

public WebhookResponse createWebhook(java.lang.String bearerToken,
                                     WebhookCreateBody webhookCreateBody,
                                     java.lang.String appId,
                                     java.lang.String integrationId)
                              throws ApiException

Create Webhook Creates a new webhook associated with a Sunshine Conversations Connect integration or a custom integration.

Parameters:

bearerToken - a token to be used for this request (required)

webhookCreateBody - (required)

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a WebhookResponse

Throws:

ApiException - if fails to make API call

deleteWebhook

public java.lang.Object deleteWebhook(java.lang.String bearerToken,
                                      java.lang.String appId,
                                      java.lang.String integrationId,
                                      java.lang.String webhookId)
                               throws ApiException

Delete Webhook Deletes the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.

Parameters:

bearerToken - a token to be used for this request (required)

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

webhookId - The id of the webhook. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

getWebhook

public WebhookResponse getWebhook(java.lang.String bearerToken,
                                  java.lang.String appId,
                                  java.lang.String integrationId,
                                  java.lang.String webhookId)
                           throws ApiException

Get Webhook Gets the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.

Parameters:

bearerToken - a token to be used for this request (required)

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

webhookId - The id of the webhook. (required)

Returns:

a WebhookResponse

Throws:

ApiException - if fails to make API call

listWebhooks

public WebhookListResponse listWebhooks(java.lang.String bearerToken,
                                        java.lang.String appId,
                                        java.lang.String integrationId)
                                 throws ApiException

List Webhooks Lists all webhooks for a given Sunshine Conversations Connect integration or custom integration.

Parameters:

bearerToken - a token to be used for this request (required)

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a WebhookListResponse

Throws:

ApiException - if fails to make API call

updateWebhook

public WebhookResponse updateWebhook(java.lang.String bearerToken,
                                     WebhookBody webhookBody,
                                     java.lang.String appId,
                                     java.lang.String integrationId,
                                     java.lang.String webhookId)
                              throws ApiException

Update Webhook Updates the specified webhook associated with a Sunshine Conversations Connect integration or a custom integration.

Parameters:

bearerToken - a token to be used for this request (required)

webhookBody - (required)

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

webhookId - The id of the webhook. (required)

Returns:

a WebhookResponse

Throws:

ApiException - if fails to make API call