Package com.zendesk.sunshine_conversations_client.api

Class SwitchboardIntegrationsApi

java.lang.Object

com.zendesk.sunshine_conversations_client.api.SwitchboardIntegrationsApi

public class SwitchboardIntegrationsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
SwitchboardIntegrationsApi()
SwitchboardIntegrationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
SwitchboardIntegrationResponse	createSwitchboardIntegration(SwitchboardIntegrationCreateBody switchboardIntegrationCreateBody, java.lang.String appId, java.lang.String switchboardId)	Create Switchboard Integration Create a switchboard integration.
SwitchboardIntegrationResponse	createSwitchboardIntegration(java.lang.String bearerToken, SwitchboardIntegrationCreateBody switchboardIntegrationCreateBody, java.lang.String appId, java.lang.String switchboardId)	Create Switchboard Integration Create a switchboard integration.
java.lang.Object	deleteSwitchboardIntegration(java.lang.String appId, java.lang.String switchboardId, java.lang.String switchboardIntegrationId)	Delete Switchboard Integration Deletes the switchboard integration.
java.lang.Object	deleteSwitchboardIntegration(java.lang.String bearerToken, java.lang.String appId, java.lang.String switchboardId, java.lang.String switchboardIntegrationId)	Delete Switchboard Integration Deletes the switchboard integration.
ApiClient	getApiClient()
SwitchboardIntegrationListResponse	listSwitchboardIntegrations(java.lang.String appId, java.lang.String switchboardId)	List Switchboard Integrations Lists all switchboard integrations linked to the switchboard.
SwitchboardIntegrationListResponse	listSwitchboardIntegrations(java.lang.String bearerToken, java.lang.String appId, java.lang.String switchboardId)	List Switchboard Integrations Lists all switchboard integrations linked to the switchboard.
void	setApiClient(ApiClient apiClient)
SwitchboardIntegrationResponse	updateSwitchboardIntegration(SwitchboardIntegrationUpdateBody switchboardIntegrationUpdateBody, java.lang.String appId, java.lang.String switchboardId, java.lang.String switchboardIntegrationId)	Update Switchboard Integration Updates a switchboard integration record.
SwitchboardIntegrationResponse	updateSwitchboardIntegration(java.lang.String bearerToken, SwitchboardIntegrationUpdateBody switchboardIntegrationUpdateBody, java.lang.String appId, java.lang.String switchboardId, java.lang.String switchboardIntegrationId)	Update Switchboard Integration Updates a switchboard integration record.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchboardIntegrationsApi

public SwitchboardIntegrationsApi()

SwitchboardIntegrationsApi

public SwitchboardIntegrationsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createSwitchboardIntegration

public SwitchboardIntegrationResponse createSwitchboardIntegration(SwitchboardIntegrationCreateBody switchboardIntegrationCreateBody,
                                                                   java.lang.String appId,
                                                                   java.lang.String switchboardId)
                                                            throws ApiException

Create Switchboard Integration Create a switchboard integration.

Parameters:

switchboardIntegrationCreateBody - (required)

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

Returns:

a SwitchboardIntegrationResponse

Throws:

ApiException - if fails to make API call

deleteSwitchboardIntegration

public java.lang.Object deleteSwitchboardIntegration(java.lang.String appId,
                                                     java.lang.String switchboardId,
                                                     java.lang.String switchboardIntegrationId)
                                              throws ApiException

Delete Switchboard Integration Deletes the switchboard integration. If the deleted switchboard integration had an active status for some conversations, the default switchboard integration will replace it. Note that it is forbidden to delete a switchboard integration if it's the default one (a new one must be chosen first) or if another switchboard integration's `nextSwitchboardIntegrationId` refers to it. The integration that was linked to the deleted switchboard integration will start receiving all conversation events, regardless of the switchboard status.

Parameters:

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

switchboardIntegrationId - Identifies the switchboard integration. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

listSwitchboardIntegrations

public SwitchboardIntegrationListResponse listSwitchboardIntegrations(java.lang.String appId,
                                                                      java.lang.String switchboardId)
                                                               throws ApiException

List Switchboard Integrations Lists all switchboard integrations linked to the switchboard.

Parameters:

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

Returns:

a SwitchboardIntegrationListResponse

Throws:

ApiException - if fails to make API call

updateSwitchboardIntegration

public SwitchboardIntegrationResponse updateSwitchboardIntegration(SwitchboardIntegrationUpdateBody switchboardIntegrationUpdateBody,
                                                                   java.lang.String appId,
                                                                   java.lang.String switchboardId,
                                                                   java.lang.String switchboardIntegrationId)
                                                            throws ApiException

Update Switchboard Integration Updates a switchboard integration record.

Parameters:

switchboardIntegrationUpdateBody - (required)

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

switchboardIntegrationId - Identifies the switchboard integration. (required)

Returns:

a SwitchboardIntegrationResponse

Throws:

ApiException - if fails to make API call

createSwitchboardIntegration

public SwitchboardIntegrationResponse createSwitchboardIntegration(java.lang.String bearerToken,
                                                                   SwitchboardIntegrationCreateBody switchboardIntegrationCreateBody,
                                                                   java.lang.String appId,
                                                                   java.lang.String switchboardId)
                                                            throws ApiException

Create Switchboard Integration Create a switchboard integration.

Parameters:

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

switchboardIntegrationCreateBody - (required)

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

Returns:

a SwitchboardIntegrationResponse

Throws:

ApiException - if fails to make API call

deleteSwitchboardIntegration

public java.lang.Object deleteSwitchboardIntegration(java.lang.String bearerToken,
                                                     java.lang.String appId,
                                                     java.lang.String switchboardId,
                                                     java.lang.String switchboardIntegrationId)
                                              throws ApiException

Delete Switchboard Integration Deletes the switchboard integration. If the deleted switchboard integration had an active status for some conversations, the default switchboard integration will replace it. Note that it is forbidden to delete a switchboard integration if it's the default one (a new one must be chosen first) or if another switchboard integration's `nextSwitchboardIntegrationId` refers to it. The integration that was linked to the deleted switchboard integration will start receiving all conversation events, regardless of the switchboard status.

Parameters:

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

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

switchboardIntegrationId - Identifies the switchboard integration. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

listSwitchboardIntegrations

public SwitchboardIntegrationListResponse listSwitchboardIntegrations(java.lang.String bearerToken,
                                                                      java.lang.String appId,
                                                                      java.lang.String switchboardId)
                                                               throws ApiException

List Switchboard Integrations Lists all switchboard integrations linked to the switchboard.

Parameters:

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

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

Returns:

a SwitchboardIntegrationListResponse

Throws:

ApiException - if fails to make API call

updateSwitchboardIntegration

public SwitchboardIntegrationResponse updateSwitchboardIntegration(java.lang.String bearerToken,
                                                                   SwitchboardIntegrationUpdateBody switchboardIntegrationUpdateBody,
                                                                   java.lang.String appId,
                                                                   java.lang.String switchboardId,
                                                                   java.lang.String switchboardIntegrationId)
                                                            throws ApiException

Update Switchboard Integration Updates a switchboard integration record.

Parameters:

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

switchboardIntegrationUpdateBody - (required)

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

switchboardIntegrationId - Identifies the switchboard integration. (required)

Returns:

a SwitchboardIntegrationResponse

Throws:

ApiException - if fails to make API call