sunshine-conversations-client 9.1.1

data/docs/SwitchboardIntegrationCreateBody.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::SwitchboardIntegrationCreateBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Identifier for use in control transfer protocols. Restricted to alphanumeric characters, `-` and `_`. | 
+**integration_id** | **String** | The id of the integration to link to the switchboard integration. Must be used when linking a custom integration. One of `integrationId` or `integrationType` must be provided. | [optional] 
+**integration_type** | **String** | The type of the integration to link to the switchboard integration. Must be used when linking an OAuth integration. One of `integrationId` or `integrationType` must be provided. | [optional] 
+**deliver_standby_events** | **Boolean** |  | [optional] 
+**next_switchboard_integration_id** | **String** |  | [optional] 
+**message_history_count** | **Integer** | Number of messages to include in the message history context. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardIntegrationCreateBody.new(name: bot,
+                                 integration_id: null,
+                                 integration_type: null,
+                                 deliver_standby_events: null,
+                                 next_switchboard_integration_id: null,
+                                 message_history_count: 5)
+```
+
+

data/docs/SwitchboardIntegrationListResponse.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::SwitchboardIntegrationListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**switchboard_integrations** | [**Array<SwitchboardIntegration>**](SwitchboardIntegration.md) | List of returned switchboard integrations. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardIntegrationListResponse.new(switchboard_integrations: null)
+```
+
+

data/docs/SwitchboardIntegrationResponse.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::SwitchboardIntegrationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**switchboard_integration** | [**SwitchboardIntegration**](SwitchboardIntegration.md) | The switchboard integration. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardIntegrationResponse.new(switchboard_integration: null)
+```
+
+

data/docs/SwitchboardIntegrationUpdateBody.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::SwitchboardIntegrationUpdateBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Identifier for use in control transfer protocols. Restricted to alphanumeric characters, `-` and `_`. | [optional] 
+**integration_id** | **String** | The id of the integration to link to the switchboard integration. Must be used when linking a custom integration. Can't provide both `integrationId` and `integrationType`. | [optional] 
+**integration_type** | **String** | The type of the integration to link to the switchboard integration. Must be used when linking an OAuth integration. Can't provide both `integrationId` and `integrationType`. | [optional] 
+**deliver_standby_events** | **Boolean** | Setting to determine if webhooks should be sent when the switchboard integration is not in control of a conversation (standby status) | [optional] 
+**next_switchboard_integration_id** | **String** |  | [optional] 
+**message_history_count** | **Integer** | Number of messages to include in the message history context. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardIntegrationUpdateBody.new(name: bot,
+                                 integration_id: null,
+                                 integration_type: null,
+                                 deliver_standby_events: null,
+                                 next_switchboard_integration_id: null,
+                                 message_history_count: 5)
+```
+
+

data/docs/SwitchboardIntegrationWebhook.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::SwitchboardIntegrationWebhook
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the switchboard integration. | [optional] 
+**name** | **String** | Identifier for use in control transfer protocols. Restricted to alphanumeric characters, `-` and `_`. | [optional] 
+**integration_id** | **String** | Id of the integration that should deliver events routed by the switchboard. | [optional] 
+**integration_type** | **String** | Type of integration that should deliver events routed by the switchboard. If referencing an OAuth integration, the clientId issued by Sunshine Conversations during the OAuth partnership process will be the value of integrationType. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardIntegrationWebhook.new(id: 5ef21b86e933b7355c11c604,
+                                 name: bot,
+                                 integration_id: 5ef21b86e933b7355c11c605,
+                                 integration_type: zd:agentWorkspace)
+```
+
+

data/docs/SwitchboardIntegrationsApi.md

@@ -0,0 +1,260 @@
+# SunshineConversationsClient::SwitchboardIntegrationsApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_switchboard_integration**](SwitchboardIntegrationsApi.md#create_switchboard_integration) | **POST** /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations | Create Switchboard Integration
+[**delete_switchboard_integration**](SwitchboardIntegrationsApi.md#delete_switchboard_integration) | **DELETE** /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations/{switchboardIntegrationId} | Delete Switchboard Integration
+[**list_switchboard_integrations**](SwitchboardIntegrationsApi.md#list_switchboard_integrations) | **GET** /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations | List Switchboard Integrations
+[**update_switchboard_integration**](SwitchboardIntegrationsApi.md#update_switchboard_integration) | **PATCH** /v2/apps/{appId}/switchboards/{switchboardId}/switchboardIntegrations/{switchboardIntegrationId} | Update Switchboard Integration
+
+
+
+## create_switchboard_integration
+
+> SwitchboardIntegrationResponse create_switchboard_integration(app_id, switchboard_id, switchboard_integration_create_body)
+
+Create Switchboard Integration
+
+Create a switchboard integration.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::SwitchboardIntegrationsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+switchboard_id = '5d8cff3cd55b040010928b5b' # String | Identifies the switchboard.
+switchboard_integration_create_body = {"name":"bot","integrationType":"zd:agentWorkspace","deliverStandbyEvents":true,"nextSwitchboardIntegrationId":"5ef21b86e933b7355c11c606","messageHistoryCount":5} # SwitchboardIntegrationCreateBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Create Switchboard Integration
+  result = api_instance.create_switchboard_integration(app_id, switchboard_id, switchboard_integration_create_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling SwitchboardIntegrationsApi->create_switchboard_integration: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **switchboard_id** | **String**| Identifies the switchboard. | 
+ **switchboard_integration_create_body** | [**SwitchboardIntegrationCreateBody**](SwitchboardIntegrationCreateBody.md)|  | 
+
+### Return type
+
+[**SwitchboardIntegrationResponse**](SwitchboardIntegrationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_switchboard_integration
+
+> Object delete_switchboard_integration(app_id, switchboard_id, switchboard_integration_id)
+
+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.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::SwitchboardIntegrationsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+switchboard_id = '5d8cff3cd55b040010928b5b' # String | Identifies the switchboard.
+switchboard_integration_id = '5d8cff3cd55b040010928b5b' # String | Identifies the switchboard integration.
+# Be sure to add the required body parameters
+
+begin
+  #Delete Switchboard Integration
+  result = api_instance.delete_switchboard_integration(app_id, switchboard_id, switchboard_integration_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling SwitchboardIntegrationsApi->delete_switchboard_integration: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **switchboard_id** | **String**| Identifies the switchboard. | 
+ **switchboard_integration_id** | **String**| Identifies the switchboard integration. | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_switchboard_integrations
+
+> SwitchboardIntegrationListResponse list_switchboard_integrations(app_id, switchboard_id)
+
+List Switchboard Integrations
+
+Lists all switchboard integrations linked to the switchboard. 
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::SwitchboardIntegrationsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+switchboard_id = '5d8cff3cd55b040010928b5b' # String | Identifies the switchboard.
+# Be sure to add the required body parameters
+
+begin
+  #List Switchboard Integrations
+  result = api_instance.list_switchboard_integrations(app_id, switchboard_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling SwitchboardIntegrationsApi->list_switchboard_integrations: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **switchboard_id** | **String**| Identifies the switchboard. | 
+
+### Return type
+
+[**SwitchboardIntegrationListResponse**](SwitchboardIntegrationListResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_switchboard_integration
+
+> SwitchboardIntegrationResponse update_switchboard_integration(app_id, switchboard_id, switchboard_integration_id, switchboard_integration_update_body)
+
+Update Switchboard Integration
+
+Updates a switchboard integration record.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::SwitchboardIntegrationsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+switchboard_id = '5d8cff3cd55b040010928b5b' # String | Identifies the switchboard.
+switchboard_integration_id = '5d8cff3cd55b040010928b5b' # String | Identifies the switchboard integration.
+switchboard_integration_update_body = {"name":"bot","integrationType":"zd:agentWorkspace","deliverStandbyEvents":true,"nextSwitchboardIntegrationId":"5ef21b86e933b7355c11c606","messageHistoryCount":5} # SwitchboardIntegrationUpdateBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Update Switchboard Integration
+  result = api_instance.update_switchboard_integration(app_id, switchboard_id, switchboard_integration_id, switchboard_integration_update_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling SwitchboardIntegrationsApi->update_switchboard_integration: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **switchboard_id** | **String**| Identifies the switchboard. | 
+ **switchboard_integration_id** | **String**| Identifies the switchboard integration. | 
+ **switchboard_integration_update_body** | [**SwitchboardIntegrationUpdateBody**](SwitchboardIntegrationUpdateBody.md)|  | 
+
+### Return type
+
+[**SwitchboardIntegrationResponse**](SwitchboardIntegrationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SwitchboardListResponse.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::SwitchboardListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**switchboards** | [**Array<Switchboard>**](Switchboard.md) | List of returned switchboards. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardListResponse.new(switchboards: null)
+```
+
+

data/docs/SwitchboardOfferControl.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::SwitchboardOfferControl
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 
+**type** | **String** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 
+**created_at** | **String** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 
+**payload** | [**SwitchboardOfferControlAllOfPayload**](SwitchboardOfferControlAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardOfferControl.new(id: null,
+                                 type: null,
+                                 created_at: null,
+                                 payload: null)
+```
+
+

data/docs/SwitchboardOfferControlAllOf.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::SwitchboardOfferControlAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payload** | [**SwitchboardOfferControlAllOfPayload**](SwitchboardOfferControlAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardOfferControlAllOf.new(payload: null)
+```
+
+

data/docs/SwitchboardOfferControlAllOfPayload.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::SwitchboardOfferControlAllOfPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. On success, the payload will include an `activeSwitchboardIntegration`, representing the integration from which control is being offered, and a `pendingSwitchboardIntegration`, representing the integration being offered control. | [optional] 
+**metadata** | [**Object**](.md) | Flat object containing custom properties. Strings, numbers and booleans  are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardOfferControlAllOfPayload.new(conversation: null,
+                                 metadata: {"lang":"en-ca"})
+```
+
+