sunshine-conversations-client 9.1.1

data/docs/SwitchboardOfferControlFailure.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::SwitchboardOfferControlFailure
+
+## 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** | [**SwitchboardAcceptControlFailureAllOfPayload**](SwitchboardAcceptControlFailureAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardOfferControlFailure.new(id: null,
+                                 type: null,
+                                 created_at: null,
+                                 payload: null)
+```
+
+

data/docs/SwitchboardPassControl.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::SwitchboardPassControl
+
+## 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** | [**SwitchboardPassControlAllOfPayload**](SwitchboardPassControlAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardPassControl.new(id: null,
+                                 type: null,
+                                 created_at: null,
+                                 payload: null)
+```
+
+

data/docs/SwitchboardPassControlAllOf.md

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

data/docs/SwitchboardPassControlAllOfPayload.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::SwitchboardPassControlAllOfPayload
+
+## 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 switchboard integration that is now in control of the conversation. | [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::SwitchboardPassControlAllOfPayload.new(conversation: null,
+                                 metadata: {"lang":"en-ca"})
+```
+
+

data/docs/SwitchboardPassControlFailure.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::SwitchboardPassControlFailure
+
+## 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** | [**SwitchboardAcceptControlFailureAllOfPayload**](SwitchboardAcceptControlFailureAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardPassControlFailure.new(id: null,
+                                 type: null,
+                                 created_at: null,
+                                 payload: null)
+```
+
+

data/docs/SwitchboardResponse.md

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

data/docs/SwitchboardUpdateBody.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::SwitchboardUpdateBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **Boolean** | Whether the switchboard is enabled. Allows creating the switchboard in a disabled state so that messages don't get lost or misrouted during switchboard configuration. When a switchboard is disabled, integrations linked to the switchboard will receive all events. | [optional] 
+**default_switchboard_integration_id** | **String** | The id of the switchboard integration that will be given control when a new conversation begins. It will also be used for conversations that existed before the switchboard was enabled. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardUpdateBody.new(enabled: null,
+                                 default_switchboard_integration_id: 5ef21b132f21af34f088530e)
+```
+
+

data/docs/SwitchboardsApi.md

@@ -0,0 +1,250 @@
+# SunshineConversationsClient::SwitchboardsApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_switchboard**](SwitchboardsApi.md#create_switchboard) | **POST** /v2/apps/{appId}/switchboards | Create Switchboard
+[**delete_switchboard**](SwitchboardsApi.md#delete_switchboard) | **DELETE** /v2/apps/{appId}/switchboards/{switchboardId} | Delete Switchboard
+[**list_switchboards**](SwitchboardsApi.md#list_switchboards) | **GET** /v2/apps/{appId}/switchboards | List Switchboards
+[**update_switchboard**](SwitchboardsApi.md#update_switchboard) | **PATCH** /v2/apps/{appId}/switchboards/{switchboardId} | Update Switchboard
+
+
+
+## create_switchboard
+
+> SwitchboardResponse create_switchboard(app_id)
+
+Create Switchboard
+
+Create a 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::SwitchboardsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+# Be sure to add the required body parameters
+
+begin
+  #Create Switchboard
+  result = api_instance.create_switchboard(app_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling SwitchboardsApi->create_switchboard: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+
+### Return type
+
+[**SwitchboardResponse**](SwitchboardResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_switchboard
+
+> Object delete_switchboard(app_id, switchboard_id)
+
+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.
+
+### 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::SwitchboardsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+switchboard_id = '5d8cff3cd55b040010928b5b' # String | Identifies the switchboard.
+# Be sure to add the required body parameters
+
+begin
+  #Delete Switchboard
+  result = api_instance.delete_switchboard(app_id, switchboard_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling SwitchboardsApi->delete_switchboard: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **switchboard_id** | **String**| Identifies the switchboard. | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_switchboards
+
+> SwitchboardListResponse list_switchboards(app_id)
+
+List Switchboards
+
+Lists all switchboards belonging to the app. 
+
+### 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::SwitchboardsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+# Be sure to add the required body parameters
+
+begin
+  #List Switchboards
+  result = api_instance.list_switchboards(app_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling SwitchboardsApi->list_switchboards: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+
+### Return type
+
+[**SwitchboardListResponse**](SwitchboardListResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_switchboard
+
+> SwitchboardResponse update_switchboard(app_id, switchboard_id, switchboard_update_body)
+
+Update Switchboard
+
+Updates a switchboard 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::SwitchboardsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+switchboard_id = '5d8cff3cd55b040010928b5b' # String | Identifies the switchboard.
+switchboard_update_body = SunshineConversationsClient::SwitchboardUpdateBody.new # SwitchboardUpdateBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Update Switchboard
+  result = api_instance.update_switchboard(app_id, switchboard_id, switchboard_update_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling SwitchboardsApi->update_switchboard: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **switchboard_id** | **String**| Identifies the switchboard. | 
+ **switchboard_update_body** | [**SwitchboardUpdateBody**](SwitchboardUpdateBody.md)|  | 
+
+### Return type
+
+[**SwitchboardResponse**](SwitchboardResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Target.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::Target
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_id** | **String** | The conversation ID of the target conversation. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Target.new(conversation_id: 029c31f25a21b47effd7be90)
+```
+
+

data/docs/Telegram.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::Telegram
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'telegram']
+**token** | **String** | Telegram Bot Token. | 
+**username** | **String** | Username of the botId | [optional] [readonly] 
+**bot_id** | **String** | A human-friendly name used to identify the integration. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Telegram.new(type: null,
+                                 token: 192033615:AAEuee2FS2JYKWfDlTulfygjaIGJi4s,
+                                 username: null,
+                                 bot_id: null)
+```
+
+

data/docs/TelegramAllOf.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::TelegramAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'telegram']
+**token** | **String** | Telegram Bot Token. | 
+**username** | **String** | Username of the botId | [optional] [readonly] 
+**bot_id** | **String** | A human-friendly name used to identify the integration. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::TelegramAllOf.new(type: null,
+                                 token: 192033615:AAEuee2FS2JYKWfDlTulfygjaIGJi4s,
+                                 username: null,
+                                 bot_id: null)
+```
+
+