sunshine-conversations-client 9.1.1

data/docs/Custom.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::Custom
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'custom']
+**webhooks** | [**Array<Webhook>**](Webhook.md) | An array of webhooks associated with the custom integration. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Custom.new(type: null,
+                                 webhooks: null)
+```
+
+

data/docs/CustomAllOf.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::CustomAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'custom']
+**webhooks** | [**Array<Webhook>**](Webhook.md) | An array of webhooks associated with the custom integration. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::CustomAllOf.new(type: null,
+                                 webhooks: null)
+```
+
+

data/docs/CustomIntegrationApiKeysApi.md

@@ -0,0 +1,258 @@
+# SunshineConversationsClient::CustomIntegrationApiKeysApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_custom_integration_key**](CustomIntegrationApiKeysApi.md#create_custom_integration_key) | **POST** /v2/apps/{appId}/integrations/{integrationId}/keys | Create Integration Key
+[**delete_custom_integration_key**](CustomIntegrationApiKeysApi.md#delete_custom_integration_key) | **DELETE** /v2/apps/{appId}/integrations/{integrationId}/keys/{keyId} | Delete Integration Key
+[**get_custom_integration_key**](CustomIntegrationApiKeysApi.md#get_custom_integration_key) | **GET** /v2/apps/{appId}/integrations/{integrationId}/keys/{keyId} | Get Integration Key
+[**list_custom_integration_keys**](CustomIntegrationApiKeysApi.md#list_custom_integration_keys) | **GET** /v2/apps/{appId}/integrations/{integrationId}/keys | List Integration Keys
+
+
+
+## create_custom_integration_key
+
+> IntegrationApiKeyResponse create_custom_integration_key(app_id, integration_id, integration_api_key)
+
+Create Integration Key
+
+Creates an API key for the specified custom integration. The response body will include a secret as well it’s corresponding id, which you can use to generate JSON Web Tokens to securely make API calls on behalf of the 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::CustomIntegrationApiKeysApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
+integration_api_key = SunshineConversationsClient::IntegrationApiKey.new # IntegrationApiKey | 
+# Be sure to add the required body parameters
+
+begin
+  #Create Integration Key
+  result = api_instance.create_custom_integration_key(app_id, integration_id, integration_api_key)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling CustomIntegrationApiKeysApi->create_custom_integration_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **integration_id** | **String**| The id of the integration. | 
+ **integration_api_key** | [**IntegrationApiKey**](IntegrationApiKey.md)|  | 
+
+### Return type
+
+[**IntegrationApiKeyResponse**](IntegrationApiKeyResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_custom_integration_key
+
+> Object delete_custom_integration_key(app_id, integration_id, key_id)
+
+Delete Integration Key
+
+Removes an API key.
+
+### 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::CustomIntegrationApiKeysApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
+key_id = 'int_5d8cff3cd55b040010928b5b' # String | The id of the key.
+# Be sure to add the required body parameters
+
+begin
+  #Delete Integration Key
+  result = api_instance.delete_custom_integration_key(app_id, integration_id, key_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling CustomIntegrationApiKeysApi->delete_custom_integration_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **integration_id** | **String**| The id of the integration. | 
+ **key_id** | **String**| The id of the key. | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_custom_integration_key
+
+> IntegrationApiKeyResponse get_custom_integration_key(app_id, integration_id, key_id)
+
+Get Integration Key
+
+Get the specified API key.
+
+### 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::CustomIntegrationApiKeysApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
+key_id = 'int_5d8cff3cd55b040010928b5b' # String | The id of the key.
+# Be sure to add the required body parameters
+
+begin
+  #Get Integration Key
+  result = api_instance.get_custom_integration_key(app_id, integration_id, key_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling CustomIntegrationApiKeysApi->get_custom_integration_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **integration_id** | **String**| The id of the integration. | 
+ **key_id** | **String**| The id of the key. | 
+
+### Return type
+
+[**IntegrationApiKeyResponse**](IntegrationApiKeyResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_custom_integration_keys
+
+> IntegrationApiKeyListResponse list_custom_integration_keys(app_id, integration_id)
+
+List Integration Keys
+
+Lists all API keys for a given 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::CustomIntegrationApiKeysApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
+# Be sure to add the required body parameters
+
+begin
+  #List Integration Keys
+  result = api_instance.list_custom_integration_keys(app_id, integration_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling CustomIntegrationApiKeysApi->list_custom_integration_keys: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **integration_id** | **String**| The id of the integration. | 
+
+### Return type
+
+[**IntegrationApiKeyListResponse**](IntegrationApiKeyListResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CustomUpdate.md

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

data/docs/Destination.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::Destination
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integration_id** | **String** | The id of the integration to deliver the message to. Will return an error if the integration does not exist or if the user does not have a client for the integration attached to the conversation.  | [optional] 
+**integration_type** | **String** | The type of the integration to deliver the message to. Will return an error if the user does not have a client of that type attached to the conversation.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Destination.new(integration_id: 582dedf230e788746891281a,
+                                 integration_type: whatsapp)
+```
+
+

data/docs/Device.md

@@ -0,0 +1,35 @@
+# SunshineConversationsClient::Device
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the device. | [optional] 
+**type** | **String** | The type of integration that the device represents. | [optional] 
+**guid** | **String** | A unique identifier for the device, generated client-side by the SDK. | [optional] 
+**client_id** | **String** | The id of the client to which this device is associated. | [optional] 
+**status** | **String** | The device status. Indicates if the device will receive push notifications or not. | [optional] 
+**integration_id** | **String** | The ID of the integration that the device was created for. | [optional] 
+**last_seen** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the last time the user interacted with this device. | [optional] 
+**push_notification_token** | **String** | The token used for push notifications on Android and iOS devices. | [optional] 
+**info** | [**Object**](.md) | A flat curated object with properties that vary for each SDK platform. All keys are optional and not guaranteed to be available. | [optional] 
+**app_version** | **String** | Version of the mobile app in which the SDK is embedded. Not applicable for devices of type web. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Device.new(id: de13bee15b51033b34162411,
+                                 type: null,
+                                 guid: null,
+                                 client_id: null,
+                                 status: null,
+                                 integration_id: null,
+                                 last_seen: null,
+                                 push_notification_token: null,
+                                 info: null,
+                                 app_version: null)
+```
+
+

data/docs/EventSubSchema.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::EventSubSchema
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::EventSubSchema.new(id: null,
+                                 type: null,
+                                 created_at: null)
+```
+
+

data/docs/ExtraChannelOptions.md

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

data/docs/ExtraChannelOptionsMessenger.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::ExtraChannelOptionsMessenger
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messenger_extensions** | **Boolean** | For webview type actions, a boolean value indicating whether the URL should be loaded with Messenger Extensions enabled. [More info](https://developers.facebook.com/docs/messenger-platform/send-api-reference/url-button). | [optional] [default to false]
+**webview_share_button** | **String** | For webview type actions, a string value indicating if the share button should be hidden. [More Info](https://developers.facebook.com/docs/messenger-platform/reference/buttons/url). | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ExtraChannelOptionsMessenger.new(messenger_extensions: false,
+                                 webview_share_button: null)
+```
+
+

data/docs/Field.md

@@ -0,0 +1,35 @@
+# SunshineConversationsClient::Field
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The field type. | 
+**name** | **String** | The name of the field. Must be unique per form or formResponse. | 
+**label** | **String** | The label of the field. What the field is displayed as on Web Messenger. | 
+**placeholder** | **String** | Placeholder text for the field. form message only. | [optional] 
+**min_size** | **Integer** | The minimum allowed length for the response for a field of type text. form message only. | [optional] [default to 1]
+**max_size** | **Integer** | The maximum allowed length for the response for a field of type text. form message only. | [optional] [default to 128]
+**text** | **String** | Specifies the response for a text field. | [optional] 
+**email** | **String** | Specifies the response for a email field. | [optional] 
+**select** | **Array<Object>** | Array of objects representing the response for a field of type select. form and formResponse messages only. | [optional] 
+**options** | **Array<Object>** | Array of objects representing options for a field of type select. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Field.new(type: null,
+                                 name: null,
+                                 label: null,
+                                 placeholder: null,
+                                 min_size: null,
+                                 max_size: null,
+                                 text: null,
+                                 email: null,
+                                 select: null,
+                                 options: null)
+```
+
+