Package com.zendesk.sunshine_conversations_client.api

Class SwitchboardsApi

java.lang.Object

com.zendesk.sunshine_conversations_client.api.SwitchboardsApi

public class SwitchboardsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
SwitchboardsApi()
SwitchboardsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
SwitchboardResponse	createSwitchboard(java.lang.String appId)	Create Switchboard Create a switchboard.
SwitchboardResponse	createSwitchboard(java.lang.String bearerToken, java.lang.String appId)	Create Switchboard Create a switchboard.
java.lang.Object	deleteSwitchboard(java.lang.String appId, java.lang.String switchboardId)	Delete Switchboard Deletes the switchboard and all its switchboard integrations.
java.lang.Object	deleteSwitchboard(java.lang.String bearerToken, java.lang.String appId, java.lang.String switchboardId)	Delete Switchboard Deletes the switchboard and all its switchboard integrations.
ApiClient	getApiClient()
SwitchboardListResponse	listSwitchboards(java.lang.String appId)	List Switchboards Lists all switchboards belonging to the app.
SwitchboardListResponse	listSwitchboards(java.lang.String bearerToken, java.lang.String appId)	List Switchboards Lists all switchboards belonging to the app.
void	setApiClient(ApiClient apiClient)
SwitchboardResponse	updateSwitchboard(SwitchboardUpdateBody switchboardUpdateBody, java.lang.String appId, java.lang.String switchboardId)	Update Switchboard Updates a switchboard record.
SwitchboardResponse	updateSwitchboard(java.lang.String bearerToken, SwitchboardUpdateBody switchboardUpdateBody, java.lang.String appId, java.lang.String switchboardId)	Update Switchboard Updates a switchboard record.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchboardsApi

public SwitchboardsApi()

SwitchboardsApi

public SwitchboardsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createSwitchboard

public SwitchboardResponse createSwitchboard(java.lang.String appId)
                                      throws ApiException

Create Switchboard Create a switchboard.

Parameters:

appId - Identifies the app. (required)

Returns:

a SwitchboardResponse

Throws:

ApiException - if fails to make API call

deleteSwitchboard

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

Delete Switchboard Deletes the switchboard and all its switchboard integrations. The integrations linked to these switchboard integrations are not deleted and will start receiving all conversation events.

Parameters:

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

listSwitchboards

public SwitchboardListResponse listSwitchboards(java.lang.String appId)
                                         throws ApiException

List Switchboards Lists all switchboards belonging to the app.

Parameters:

appId - Identifies the app. (required)

Returns:

a SwitchboardListResponse

Throws:

ApiException - if fails to make API call

updateSwitchboard

public SwitchboardResponse updateSwitchboard(SwitchboardUpdateBody switchboardUpdateBody,
                                             java.lang.String appId,
                                             java.lang.String switchboardId)
                                      throws ApiException

Update Switchboard Updates a switchboard record.

Parameters:

switchboardUpdateBody - (required)

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

Returns:

a SwitchboardResponse

Throws:

ApiException - if fails to make API call

createSwitchboard

public SwitchboardResponse createSwitchboard(java.lang.String bearerToken,
                                             java.lang.String appId)
                                      throws ApiException

Create Switchboard Create a switchboard.

Parameters:

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

appId - Identifies the app. (required)

Returns:

a SwitchboardResponse

Throws:

ApiException - if fails to make API call

deleteSwitchboard

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

Delete Switchboard Deletes the switchboard and all its switchboard integrations. The integrations linked to these switchboard integrations are not deleted and will start receiving all conversation events.

Parameters:

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

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

Returns:

a Object

Throws:

ApiException - if fails to make API call

listSwitchboards

public SwitchboardListResponse listSwitchboards(java.lang.String bearerToken,
                                                java.lang.String appId)
                                         throws ApiException

List Switchboards Lists all switchboards belonging to the app.

Parameters:

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

appId - Identifies the app. (required)

Returns:

a SwitchboardListResponse

Throws:

ApiException - if fails to make API call

updateSwitchboard

public SwitchboardResponse updateSwitchboard(java.lang.String bearerToken,
                                             SwitchboardUpdateBody switchboardUpdateBody,
                                             java.lang.String appId,
                                             java.lang.String switchboardId)
                                      throws ApiException

Update Switchboard Updates a switchboard record.

Parameters:

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

switchboardUpdateBody - (required)

appId - Identifies the app. (required)

switchboardId - Identifies the switchboard. (required)

Returns:

a SwitchboardResponse

Throws:

ApiException - if fails to make API call