Package com.zendesk.sunshine_conversations_client.api

Class SwitchboardActionsApi

  • public class SwitchboardActionsApi
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object acceptControl​(AcceptControlBody acceptControlBody, java.lang.String appId, java.lang.String conversationId)
      Accept Control The acceptControl action transfers the control of the conversation to the pending switchboard integration.
      java.lang.Object acceptControl​(java.lang.String bearerToken, AcceptControlBody acceptControlBody, java.lang.String appId, java.lang.String conversationId)
      Accept Control The acceptControl action transfers the control of the conversation to the pending switchboard integration.
      ApiClient getApiClient()  
      java.lang.Object offerControl​(OfferControlBody offerControlBody, java.lang.String appId, java.lang.String conversationId)
      Offer Control The offerControl action will invite a switchboard integration to accept control of the conversation (changing its status to pending), and trigger a webhook signal to that integration indicating that they have been offered control of the conversation.
      java.lang.Object offerControl​(java.lang.String bearerToken, OfferControlBody offerControlBody, java.lang.String appId, java.lang.String conversationId)
      Offer Control The offerControl action will invite a switchboard integration to accept control of the conversation (changing its status to pending), and trigger a webhook signal to that integration indicating that they have been offered control of the conversation.
      java.lang.Object passControl​(PassControlBody passControlBody, java.lang.String appId, java.lang.String conversationId)
      Pass Control The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status.
      java.lang.Object passControl​(java.lang.String bearerToken, PassControlBody passControlBody, java.lang.String appId, java.lang.String conversationId)
      Pass Control The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status.
      java.lang.Object releaseControl​(java.lang.String appId, java.lang.String conversationId)
      Release Control The releaseControl action releases the control of the conversation by nullifying its switchboard state.
      java.lang.Object releaseControl​(java.lang.String bearerToken, java.lang.String appId, java.lang.String conversationId)
      Release Control The releaseControl action releases the control of the conversation by nullifying its switchboard state.
      void setApiClient​(ApiClient apiClient)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SwitchboardActionsApi

        public SwitchboardActionsApi()

      • SwitchboardActionsApi

        public SwitchboardActionsApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • acceptControl

        public java.lang.Object acceptControl​(AcceptControlBody acceptControlBody,
                                      java.lang.String appId,
                                      java.lang.String conversationId)
                               throws ApiException
        Accept Control The acceptControl action transfers the control of the conversation to the pending switchboard integration. When using integration auth scope, a 403 is returned if the pending switchboard integration is not the authenticated integration.
        Parameters:
        acceptControlBody - (required)
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        Returns:
        a Object
        Throws:
        ApiException - if fails to make API call

      • offerControl

        public java.lang.Object offerControl​(OfferControlBody offerControlBody,
                                     java.lang.String appId,
                                     java.lang.String conversationId)
                              throws ApiException
        Offer Control The offerControl action will invite a switchboard integration to accept control of the conversation (changing its status to pending), and trigger a webhook signal to that integration indicating that they have been offered control of the conversation. Invalidates previous offerControl actions.
        Parameters:
        offerControlBody - (required)
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        Returns:
        a Object
        Throws:
        ApiException - if fails to make API call

      • passControl

        public java.lang.Object passControl​(PassControlBody passControlBody,
                                    java.lang.String appId,
                                    java.lang.String conversationId)
                             throws ApiException
        Pass Control The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://docs.smooch.io/guide/oauth/#redirect-and-acquiring-an-oauth-token) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded. For more information, see [Switchboard passControl](https://docs.smooch.io/guide/switchboard/#pass-control).
        Parameters:
        passControlBody - (required)
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        Returns:
        a Object
        Throws:
        ApiException - if fails to make API call

      • releaseControl

        public java.lang.Object releaseControl​(java.lang.String appId,
                                       java.lang.String conversationId)
                                throws ApiException
        Release Control The releaseControl action releases the control of the conversation by nullifying its switchboard state. When using integration auth scope, a 403 is returned if the active switchboard integration is not the authenticated integration.
        Parameters:
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        Returns:
        a Object
        Throws:
        ApiException - if fails to make API call

      • acceptControl

        public java.lang.Object acceptControl​(java.lang.String bearerToken,
                                      AcceptControlBody acceptControlBody,
                                      java.lang.String appId,
                                      java.lang.String conversationId)
                               throws ApiException
        Accept Control The acceptControl action transfers the control of the conversation to the pending switchboard integration. When using integration auth scope, a 403 is returned if the pending switchboard integration is not the authenticated integration.
        Parameters:
        bearerToken - a token to be used for this request (required)
        acceptControlBody - (required)
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        Returns:
        a Object
        Throws:
        ApiException - if fails to make API call

      • offerControl

        public java.lang.Object offerControl​(java.lang.String bearerToken,
                                     OfferControlBody offerControlBody,
                                     java.lang.String appId,
                                     java.lang.String conversationId)
                              throws ApiException
        Offer Control The offerControl action will invite a switchboard integration to accept control of the conversation (changing its status to pending), and trigger a webhook signal to that integration indicating that they have been offered control of the conversation. Invalidates previous offerControl actions.
        Parameters:
        bearerToken - a token to be used for this request (required)
        offerControlBody - (required)
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        Returns:
        a Object
        Throws:
        ApiException - if fails to make API call

      • passControl

        public java.lang.Object passControl​(java.lang.String bearerToken,
                                    PassControlBody passControlBody,
                                    java.lang.String appId,
                                    java.lang.String conversationId)
                             throws ApiException
        Pass Control The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://docs.smooch.io/guide/oauth/#redirect-and-acquiring-an-oauth-token) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded. For more information, see [Switchboard passControl](https://docs.smooch.io/guide/switchboard/#pass-control).
        Parameters:
        bearerToken - a token to be used for this request (required)
        passControlBody - (required)
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        Returns:
        a Object
        Throws:
        ApiException - if fails to make API call

      • releaseControl

        public java.lang.Object releaseControl​(java.lang.String bearerToken,
                                       java.lang.String appId,
                                       java.lang.String conversationId)
                                throws ApiException
        Release Control The releaseControl action releases the control of the conversation by nullifying its switchboard state. When using integration auth scope, a 403 is returned if the active switchboard integration is not the authenticated integration.
        Parameters:
        bearerToken - a token to be used for this request (required)
        appId - Identifies the app. (required)
        conversationId - Identifies the conversation. (required)
        Returns:
        a Object
        Throws:
        ApiException - if fails to make API call