sunshine-conversations-client 9.1.1

data/docs/Source.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::Source
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels. | 
+**integration_id** | **String** | Identifier indicating which integration the message was sent from. For user messages only. | [optional] 
+**original_message_id** | **String** | Message identifier assigned by the originating channel. | [optional] 
+**original_message_timestamp** | **String** | A datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing when the third party channel received the message. | [optional] 
+**client** | [**Client**](Client.md) | The client from which the user authored the message or activity, if applicable. This field is not applicable in API responses, it is used only in webhook payloads if the `includeFullSource` option is enabled. | [optional] 
+**device** | [**Device**](Device.md) | The device from which the user authored the message or activity, if applicable. This field is not applicable in API responses, it is used only in webhook payloads if the `includeFullSource` option is enabled. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Source.new(type: ios,
+                                 integration_id: de13bee15b51033b34162411,
+                                 original_message_id: 5f40256af057d0000dda9bd7,
+                                 original_message_timestamp: 2019-03-21T18:45:53.720Z,
+                                 client: null,
+                                 device: null)
+```
+
+

data/docs/SourceWebhook.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::SourceWebhook
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels. | [optional] 
+**integration_id** | **String** | Identifier indicating which integration the message was sent from. For user messages only. | [optional] 
+**original_message_id** | **String** | Message identifier assigned by the originating channel. | [optional] 
+**original_message_timestamp** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing when the third-party channel received the message. | [optional] 
+**client** | [**Client**](Client.md) | The client from which the user authored the message or activity, if applicable. This field will only be present if the `includeFullSource` option is enabled for the webhook. | [optional] 
+**device** | [**Device**](Device.md) | The device from which the user authored the message or activity, if applicable. This field will only be present if the `includeFullSource` option is enabled for the webhook | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SourceWebhook.new(type: ios,
+                                 integration_id: null,
+                                 original_message_id: null,
+                                 original_message_timestamp: null,
+                                 client: null,
+                                 device: null)
+```
+
+

data/docs/Status.md

@@ -0,0 +1,16 @@
+# SunshineConversationsClient::Status
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Status.new()
+```
+
+

data/docs/Switchboard.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::Switchboard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the switchboard. | 
+**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. | 
+**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::Switchboard.new(id: 5ef21b132f21af34f088530d,
+                                 enabled: null,
+                                 default_switchboard_integration_id: 5ef21b132f21af34f088530e)
+```
+
+

data/docs/SwitchboardAcceptControl.md

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

data/docs/SwitchboardAcceptControlAllOf.md

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

data/docs/SwitchboardAcceptControlAllOfPayload.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::SwitchboardAcceptControlAllOfPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. Will include an `activeSwitchboardIntegration` representing the integration that has just accepted 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::SwitchboardAcceptControlAllOfPayload.new(conversation: null,
+                                 metadata: {"lang":"en-ca"})
+```
+
+

data/docs/SwitchboardAcceptControlFailure.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::SwitchboardAcceptControlFailure
+
+## 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::SwitchboardAcceptControlFailure.new(id: null,
+                                 type: null,
+                                 created_at: null,
+                                 payload: null)
+```
+
+

data/docs/SwitchboardAcceptControlFailureAllOf.md

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

data/docs/SwitchboardAcceptControlFailureAllOfPayload.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::SwitchboardAcceptControlFailureAllOfPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Object**](.md) | Object containing details of what went wrong. | [optional] 
+**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. | [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::SwitchboardAcceptControlFailureAllOfPayload.new(error: null,
+                                 conversation: null,
+                                 metadata: {"lang":"en-ca"})
+```
+
+

data/docs/SwitchboardActionsApi.md

@@ -0,0 +1,197 @@
+# SunshineConversationsClient::SwitchboardActionsApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**accept_control**](SwitchboardActionsApi.md#accept_control) | **POST** /v2/apps/{appId}/conversations/{conversationId}/acceptControl | Accept Control
+[**offer_control**](SwitchboardActionsApi.md#offer_control) | **POST** /v2/apps/{appId}/conversations/{conversationId}/offerControl | Offer Control
+[**pass_control**](SwitchboardActionsApi.md#pass_control) | **POST** /v2/apps/{appId}/conversations/{conversationId}/passControl | Pass Control
+
+
+
+## accept_control
+
+> Object accept_control(app_id, conversation_id, accept_control_body)
+
+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.
+
+### 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::SwitchboardActionsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+accept_control_body = SunshineConversationsClient::AcceptControlBody.new # AcceptControlBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Accept Control
+  result = api_instance.accept_control(app_id, conversation_id, accept_control_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling SwitchboardActionsApi->accept_control: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+ **accept_control_body** | [**AcceptControlBody**](AcceptControlBody.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## offer_control
+
+> Object offer_control(app_id, conversation_id, offer_control_body)
+
+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.
+
+### 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::SwitchboardActionsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+offer_control_body = SunshineConversationsClient::OfferControlBody.new # OfferControlBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Offer Control
+  result = api_instance.offer_control(app_id, conversation_id, offer_control_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling SwitchboardActionsApi->offer_control: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+ **offer_control_body** | [**OfferControlBody**](OfferControlBody.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## pass_control
+
+> Object pass_control(app_id, conversation_id, pass_control_body)
+
+Pass Control
+
+Mark the named switchboard integration as active and transition all the other switchboard integrations to standby 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::SwitchboardActionsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+pass_control_body = SunshineConversationsClient::PassControlBody.new # PassControlBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Pass Control
+  result = api_instance.pass_control(app_id, conversation_id, pass_control_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling SwitchboardActionsApi->pass_control: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+ **pass_control_body** | [**PassControlBody**](PassControlBody.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SwitchboardIntegration.md

@@ -0,0 +1,29 @@
+# SunshineConversationsClient::SwitchboardIntegration
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the switchboard integration. | 
+**name** | **String** | Identifier for use in control transfer protocols. Restricted to alphanumeric characters, `-` and `_`. | 
+**integration_id** | **String** | Id of the integration that should deliver events routed by the switchboard. | 
+**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. | 
+**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) | 
+**next_switchboard_integration_id** | **String** | The switchboard integration id to which control of a conversation is passed / offered by default. | [optional] 
+**message_history_count** | **Integer** | Number of messages to include in the message history context. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardIntegration.new(id: 5ef21b86e933b7355c11c604,
+                                 name: bot,
+                                 integration_id: 5ef21b86e933b7355c11c605,
+                                 integration_type: zd:agentWorkspace,
+                                 deliver_standby_events: null,
+                                 next_switchboard_integration_id: 5ef21b86e933b7355c11c606,
+                                 message_history_count: 5)
+```
+
+