Package com.zendesk.sunshine_conversations_client.api

Class IntegrationsApi

java.lang.Object

com.zendesk.sunshine_conversations_client.api.IntegrationsApi

public class IntegrationsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
IntegrationsApi()
IntegrationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
IntegrationResponse	createIntegration(Integration integration, java.lang.String appId)	Create Integration The Create Integration endpoint allows you to provision apps with front-end messaging channels.
IntegrationResponse	createIntegration(java.lang.String bearerToken, Integration integration, java.lang.String appId)	Create Integration The Create Integration endpoint allows you to provision apps with front-end messaging channels.
java.lang.Object	deleteIntegration(java.lang.String appId, java.lang.String integrationId)	Delete Integration Delete the specified integration.
java.lang.Object	deleteIntegration(java.lang.String bearerToken, java.lang.String appId, java.lang.String integrationId)	Delete Integration Delete the specified integration.
ApiClient	getApiClient()
IntegrationResponse	getIntegration(java.lang.String appId, java.lang.String integrationId)	Get Integration Get integration.
IntegrationResponse	getIntegration(java.lang.String bearerToken, java.lang.String appId, java.lang.String integrationId)	Get Integration Get integration.
IntegrationListResponse	listIntegrations(java.lang.String appId, Page page, IntegrationListFilter filter)	List Integrations List available integrations.
IntegrationListResponse	listIntegrations(java.lang.String bearerToken, java.lang.String appId, Page page, IntegrationListFilter filter)	List Integrations List available integrations.
void	setApiClient(ApiClient apiClient)
IntegrationResponse	updateIntegration(IntegrationUpdate integrationUpdate, java.lang.String appId, java.lang.String integrationId)	Update Integration Allows you to update certain fields of existing integrations.
IntegrationResponse	updateIntegration(java.lang.String bearerToken, IntegrationUpdate integrationUpdate, java.lang.String appId, java.lang.String integrationId)	Update Integration Allows you to update certain fields of existing integrations.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntegrationsApi

public IntegrationsApi()

IntegrationsApi

public IntegrationsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createIntegration

public IntegrationResponse createIntegration(Integration integration,
                                             java.lang.String appId)
                                      throws ApiException

Create Integration The Create Integration endpoint allows you to provision apps with front-end messaging channels. Selecting a `custom` integration allows the creation of webhooks.

Parameters:

integration - (required)

appId - Identifies the app. (required)

Returns:

a IntegrationResponse

Throws:

ApiException - if fails to make API call

deleteIntegration

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

Delete Integration Delete the specified integration.

Parameters:

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

getIntegration

public IntegrationResponse getIntegration(java.lang.String appId,
                                          java.lang.String integrationId)
                                   throws ApiException

Get Integration Get integration.

Parameters:

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a IntegrationResponse

Throws:

ApiException - if fails to make API call

listIntegrations

public IntegrationListResponse listIntegrations(java.lang.String appId,
                                                Page page,
                                                IntegrationListFilter filter)
                                         throws ApiException

List Integrations List available integrations. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). ```shell /v2/apps/:appId/integrations?page[after]=5e1606762556d93e9c176f69&page[size]=10&filter[types]=custom,web ```

Parameters:

appId - Identifies the app. (required)

page - Contains parameters for applying cursor pagination. (optional)

filter - Contains parameters for filtering the results. (optional)

Returns:

a IntegrationListResponse

Throws:

ApiException - if fails to make API call

updateIntegration

public IntegrationResponse updateIntegration(IntegrationUpdate integrationUpdate,
                                             java.lang.String appId,
                                             java.lang.String integrationId)
                                      throws ApiException

Update Integration Allows you to update certain fields of existing integrations. If updating a specific property is not supported, you must delete the integration and re-create it with the new data.

Parameters:

integrationUpdate - (required)

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a IntegrationResponse

Throws:

ApiException - if fails to make API call

createIntegration

public IntegrationResponse createIntegration(java.lang.String bearerToken,
                                             Integration integration,
                                             java.lang.String appId)
                                      throws ApiException

Create Integration The Create Integration endpoint allows you to provision apps with front-end messaging channels. Selecting a `custom` integration allows the creation of webhooks.

Parameters:

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

integration - (required)

appId - Identifies the app. (required)

Returns:

a IntegrationResponse

Throws:

ApiException - if fails to make API call

deleteIntegration

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

Delete Integration Delete the specified 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 Object

Throws:

ApiException - if fails to make API call

getIntegration

public IntegrationResponse getIntegration(java.lang.String bearerToken,
                                          java.lang.String appId,
                                          java.lang.String integrationId)
                                   throws ApiException

Get Integration Get 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 IntegrationResponse

Throws:

ApiException - if fails to make API call

listIntegrations

public IntegrationListResponse listIntegrations(java.lang.String bearerToken,
                                                java.lang.String appId,
                                                Page page,
                                                IntegrationListFilter filter)
                                         throws ApiException

List Integrations List available integrations. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). ```shell /v2/apps/:appId/integrations?page[after]=5e1606762556d93e9c176f69&page[size]=10&filter[types]=custom,web ```

Parameters:

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

appId - Identifies the app. (required)

page - Contains parameters for applying cursor pagination. (optional)

filter - Contains parameters for filtering the results. (optional)

Returns:

a IntegrationListResponse

Throws:

ApiException - if fails to make API call

updateIntegration

public IntegrationResponse updateIntegration(java.lang.String bearerToken,
                                             IntegrationUpdate integrationUpdate,
                                             java.lang.String appId,
                                             java.lang.String integrationId)
                                      throws ApiException

Update Integration Allows you to update certain fields of existing integrations. If updating a specific property is not supported, you must delete the integration and re-create it with the new data.

Parameters:

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

integrationUpdate - (required)

appId - Identifies the app. (required)

integrationId - The id of the integration. (required)

Returns:

a IntegrationResponse

Throws:

ApiException - if fails to make API call