sunshine-conversations-client 9.1.1

data/docs/AppKey.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::AppKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the API key, used when signing JWTs or accessing the API using Basic Authentication. | [optional] 
+**display_name** | **String** | The name of the API key. | [optional] 
+**secret** | **String** | The secret of the API key, used when signing JWTs or accessing the API using Basic Authentication | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AppKey.new(id: app_5723a347f82ba0516cb4ea34,
+                                 display_name: Key 1,
+                                 secret: 5XJ85yjUtRcaQu_pDINblPZb)
+```
+
+

data/docs/AppKeyCreateBody.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::AppKeyCreateBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** | The name of the API key. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AppKeyCreateBody.new(display_name: Key 1)
+```
+
+

data/docs/AppKeyListResponse.md

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

data/docs/AppKeyResponse.md

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

data/docs/AppKeysApi.md

@@ -0,0 +1,250 @@
+# SunshineConversationsClient::AppKeysApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_app_key**](AppKeysApi.md#create_app_key) | **POST** /v2/apps/{appId}/keys | Create App Key
+[**delete_app_key**](AppKeysApi.md#delete_app_key) | **DELETE** /v2/apps/{appId}/keys/{keyId} | Delete App Key
+[**get_app_key**](AppKeysApi.md#get_app_key) | **GET** /v2/apps/{appId}/keys/{keyId} | Get App Key
+[**list_app_keys**](AppKeysApi.md#list_app_keys) | **GET** /v2/apps/{appId}/keys | List App Keys
+
+
+
+## create_app_key
+
+> AppKeyResponse create_app_key(app_id, app_key_create_body)
+
+Create App Key
+
+Creates an API key for the specified app. The response body will include a secret  as well as its corresponding id, which you can use to generate JSON Web Tokens to  securely make API calls on behalf of 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::AppKeysApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+app_key_create_body = SunshineConversationsClient::AppKeyCreateBody.new # AppKeyCreateBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Create App Key
+  result = api_instance.create_app_key(app_id, app_key_create_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AppKeysApi->create_app_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **app_key_create_body** | [**AppKeyCreateBody**](AppKeyCreateBody.md)|  | 
+
+### Return type
+
+[**AppKeyResponse**](AppKeyResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_app_key
+
+> Object delete_app_key(app_id, key_id)
+
+Delete App 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::AppKeysApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+key_id = 'int_5d8cff3cd55b040010928b5b' # String | The id of the key.
+# Be sure to add the required body parameters
+
+begin
+  #Delete App Key
+  result = api_instance.delete_app_key(app_id, key_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AppKeysApi->delete_app_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **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_app_key
+
+> AppKeyResponse get_app_key(app_id, key_id)
+
+Get App Key
+
+Returns 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::AppKeysApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+key_id = 'int_5d8cff3cd55b040010928b5b' # String | The id of the key.
+# Be sure to add the required body parameters
+
+begin
+  #Get App Key
+  result = api_instance.get_app_key(app_id, key_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AppKeysApi->get_app_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **key_id** | **String**| The id of the key. | 
+
+### Return type
+
+[**AppKeyResponse**](AppKeyResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_app_keys
+
+> AppKeyListResponse list_app_keys(app_id)
+
+List App Keys
+
+Lists all API keys for a given 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::AppKeysApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+# Be sure to add the required body parameters
+
+begin
+  #List App Keys
+  result = api_instance.list_app_keys(app_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AppKeysApi->list_app_keys: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+
+### Return type
+
+[**AppKeyListResponse**](AppKeyListResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AppListFilter.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::AppListFilter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**service_account_id** | **String** | When specified, lists only the apps that the service account has access to. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AppListFilter.new(service_account_id: null)
+```
+
+

data/docs/AppListResponse.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::AppListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**apps** | [**Array<App>**](App.md) | List of returned apps. | [optional] 
+**meta** | [**Meta**](Meta.md) |  | [optional] 
+**links** | [**Links**](Links.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AppListResponse.new(apps: null,
+                                 meta: null,
+                                 links: null)
+```
+
+

data/docs/AppResponse.md

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

data/docs/AppSettings.md

@@ -0,0 +1,31 @@
+# SunshineConversationsClient::AppSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_retention_seconds** | **Integer** | Number of seconds of inactivity before a conversation’s messages  will be automatically deleted. See  [Conversation Retention Seconds](https://docs.smooch.io/rest/#conversation-retention-seconds) for more information.  | [optional] 
+**mask_credit_card_numbers** | **Boolean** | A boolean specifying whether credit card numbers should be masked  when sent through Sunshine Conversations.  | [optional] 
+**use_animal_names** | **Boolean** | A boolean specifying whether animal names should be used for  unnamed users. See the  [user naming guide](https://docs.smooch.io/guide/receiving-messages/#message-author-name) for details.  | [optional] 
+**echo_postback** | **Boolean** | A boolean specifying whether a message should be added to the conversation  history when a postback button is clicked. See  [Echo Postbacks](https://docs.smooch.io/rest/#echo-postbacks) for more information.  | [optional] 
+**ignore_auto_conversation_start** | **Boolean** | A boolean specifying whether a non message event coming from a channel will  trigger a  [start conversation](https://docs.smooch.io/rest/#section/Webhook-Triggers) event and count as a monthly active user (MAU). <aside class=\"notice\">Calling <code>startConversation()</code> (or equivalent) from the Android,  iOS or Web SDK will count as a MAU, regardless of the value of this setting.</aside>  | [optional] 
+**multi_convo_enabled** | **Boolean** | A boolean specifying whether users are allowed to be part of several conversations. Enabling `multiConvo` is **irreversible**.  | [optional] 
+**attachments_access** | **String** | A string specifying whether attachments should be stored in a publicly or privately accessible cloud storage. attachmentsAccess is set to public by default but can be modified to private. See <a href=\"https://docs.smooch.io/guide/private-attachments/\">Private Attachments</a> for more information.  | [optional] 
+**attachments_token_expiration_seconds** | **Integer** | Number of seconds representing the expiration time of the generated media tokens for private attachments. The JWT will be valid for 2 hours by default. See See <a href=\"https://docs.smooch.io/guide/private-attachments/\">Private Attachments</a> for more information.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AppSettings.new(conversation_retention_seconds: null,
+                                 mask_credit_card_numbers: null,
+                                 use_animal_names: null,
+                                 echo_postback: null,
+                                 ignore_auto_conversation_start: null,
+                                 multi_convo_enabled: null,
+                                 attachments_access: public,
+                                 attachments_token_expiration_seconds: 64028)
+```
+
+

data/docs/AppSubSchema.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::AppSubSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the app. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AppSubSchema.new(id: 5e4af71a81966cfff3ef6550)
+```
+
+

data/docs/AppUpdateBody.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::AppUpdateBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** | The friendly name of the app. | [optional] 
+**settings** | [**AppSettings**](AppSettings.md) |  | [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::AppUpdateBody.new(display_name: My App,
+                                 settings: null,
+                                 metadata: {"lang":"en-ca"})
+```
+
+