sunshine-conversations-client 9.1.1

data/docs/Ios.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::Ios
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'ios']
+**certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional] 
+**password** | **String** | The password for your APN certificate. | [optional] 
+**production** | **Boolean** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional] 
+**auto_update_badge** | **Boolean** | Use the unread count of the conversation as the application badge. | [optional] 
+**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the iOS integration. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Ios.new(type: null,
+                                 certificate: your_APN_certificate,
+                                 password: your_APN_password,
+                                 production: null,
+                                 auto_update_badge: null,
+                                 can_user_create_more_conversations: null)
+```
+
+

data/docs/IosAllOf.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::IosAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'ios']
+**certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional] 
+**password** | **String** | The password for your APN certificate. | [optional] 
+**production** | **Boolean** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional] 
+**auto_update_badge** | **Boolean** | Use the unread count of the conversation as the application badge. | [optional] 
+**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the iOS integration. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::IosAllOf.new(type: null,
+                                 certificate: your_APN_certificate,
+                                 password: your_APN_password,
+                                 production: null,
+                                 auto_update_badge: null,
+                                 can_user_create_more_conversations: null)
+```
+
+

data/docs/IosUpdate.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::IosUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional] 
+**certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional] 
+**password** | **String** | The password for your APN certificate. | [optional] 
+**production** | **Boolean** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional] 
+**auto_update_badge** | **Boolean** | Use the unread count of the conversation as the application badge. | [optional] 
+**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the iOS integration. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::IosUpdate.new(display_name: My awesome integration,
+                                 certificate: your_APN_certificate,
+                                 password: your_APN_password,
+                                 production: null,
+                                 auto_update_badge: null,
+                                 can_user_create_more_conversations: null)
+```
+
+

data/docs/IosUpdateAllOf.md

@@ -0,0 +1,25 @@
+# SunshineConversationsClient::IosUpdateAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional] 
+**password** | **String** | The password for your APN certificate. | [optional] 
+**production** | **Boolean** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional] 
+**auto_update_badge** | **Boolean** | Use the unread count of the conversation as the application badge. | [optional] 
+**can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the iOS integration. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::IosUpdateAllOf.new(certificate: your_APN_certificate,
+                                 password: your_APN_password,
+                                 production: null,
+                                 auto_update_badge: null,
+                                 can_user_create_more_conversations: null)
+```
+
+

data/docs/Item.md

@@ -0,0 +1,29 @@
+# SunshineConversationsClient::Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | The title of the item. | 
+**description** | **String** | The description of the item. | [optional] 
+**media_url** | **String** | The image url attached to the item. | [optional] 
+**media_type** | **String** | The MIME type for any image attached in the mediaUrl. | [optional] 
+**size** | **String** | The size of the image. | [optional] 
+**actions** | [**Array<ActionSubset>**](ActionSubset.md) | An array of objects representing the actions associated with the item. | 
+**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::Item.new(title: null,
+                                 description: null,
+                                 media_url: null,
+                                 media_type: null,
+                                 size: null,
+                                 actions: null,
+                                 metadata: {"lang":"en-ca"})
+```
+
+

data/docs/Line.md

@@ -0,0 +1,31 @@
+# SunshineConversationsClient::Line
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'line']
+**channel_id** | **String** | LINE Channel ID. | 
+**channel_secret** | **String** | LINE Channel Secret. | 
+**channel_access_token** | **String** | LINE Channel Access Token. | [optional] 
+**service_code** | **String** | LINE Service Code. | [optional] 
+**switcher_secret** | **String** | LINE Switcher Secret. | [optional] 
+**qr_code_url** | **String** | URL provided by LINE in the [Developer Console](https://developers.line.biz/console/). | [optional] 
+**line_id** | **String** | LINE Basic ID. Is automatically set when qrCodeUrl is updated. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Line.new(type: null,
+                                 channel_id: 1286564967,
+                                 channel_secret: your_line_channel_secret,
+                                 channel_access_token: your_line_channel_token,
+                                 service_code: your_line_service_code,
+                                 switcher_secret: your_line_switcher_secret,
+                                 qr_code_url: https://qr-official.line.me/M/1O4fb8.png,
+                                 line_id: 104fb8)
+```
+
+

data/docs/LineAllOf.md

@@ -0,0 +1,31 @@
+# SunshineConversationsClient::LineAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'line']
+**channel_id** | **String** | LINE Channel ID. | 
+**channel_secret** | **String** | LINE Channel Secret. | 
+**channel_access_token** | **String** | LINE Channel Access Token. | [optional] 
+**service_code** | **String** | LINE Service Code. | [optional] 
+**switcher_secret** | **String** | LINE Switcher Secret. | [optional] 
+**qr_code_url** | **String** | URL provided by LINE in the [Developer Console](https://developers.line.biz/console/). | [optional] 
+**line_id** | **String** | LINE Basic ID. Is automatically set when qrCodeUrl is updated. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::LineAllOf.new(type: null,
+                                 channel_id: 1286564967,
+                                 channel_secret: your_line_channel_secret,
+                                 channel_access_token: your_line_channel_token,
+                                 service_code: your_line_service_code,
+                                 switcher_secret: your_line_switcher_secret,
+                                 qr_code_url: https://qr-official.line.me/M/1O4fb8.png,
+                                 line_id: 104fb8)
+```
+
+

data/docs/LineUpdate.md

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

data/docs/Link.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::Link
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of action. | [default to 'link']
+**uri** | **String** | The action URI. This is the link that will be used in the clients when clicking the button. | 
+**text** | **String** | The button text. | 
+**default** | **Boolean** | Boolean value indicating whether the action is the default action for a message item in Facebook Messenger. | [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] 
+**extra_channel_options** | [**ExtraChannelOptions**](ExtraChannelOptions.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Link.new(type: null,
+                                 uri: null,
+                                 text: null,
+                                 default: null,
+                                 metadata: {"lang":"en-ca"},
+                                 extra_channel_options: null)
+```
+
+

data/docs/Links.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::Links
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prev** | **String** | A link to the previous page. Not specified if there are no previous pages. | [optional] 
+**_next** | **String** | A link to the next page. Not specified if there are no subsequent pages. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Links.new(prev: https://api.smooch.io/v2/apps?page[before]=fcafad804c39a39648004af9,
+                                 _next: https://api.smooch.io/v2/apps?page[after]=5ea868f862cdd24abf010b38)
+```
+
+

data/docs/ListMessage.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::ListMessage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of message. | [default to 'list']
+**items** | [**Array<Item>**](Item.md) | An array of objects representing the items associated with the message. Only present in carousel and list type messages. | 
+**actions** | [**Array<ActionSubset>**](ActionSubset.md) | An array of objects representing the actions associated with the message. The array length is limited by the third party channel. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ListMessage.new(type: null,
+                                 items: null,
+                                 actions: null)
+```
+
+

data/docs/LocationMessage.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::LocationMessage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of message. | [default to 'location']
+**text** | **String** | The fallback text message used when location messages are not supported by the channel. | [optional] [readonly] 
+**coordinates** | [**LocationMessageCoordinates**](LocationMessageCoordinates.md) |  | 
+**location** | [**LocationMessageLocation**](LocationMessageLocation.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::LocationMessage.new(type: null,
+                                 text: null,
+                                 coordinates: null,
+                                 location: null)
+```
+
+

data/docs/LocationMessageCoordinates.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::LocationMessageCoordinates
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lat** | **Float** | Global latitude. | 
+**long** | **Float** | Global longitude. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::LocationMessageCoordinates.new(lat: null,
+                                 long: null)
+```
+
+

data/docs/LocationMessageLocation.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::LocationMessageLocation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **String** | A string representing the address of the location. | [optional] 
+**name** | **String** | A string representing the name of the location. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::LocationMessageLocation.new(address: null,
+                                 name: null)
+```
+
+

data/docs/LocationRequest.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::LocationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of action. | [default to 'locationRequest']
+**text** | **String** | The button text. | 
+**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::LocationRequest.new(type: null,
+                                 text: null,
+                                 metadata: {"lang":"en-ca"})
+```
+
+

data/docs/Mailgun.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::Mailgun
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'mailgun']
+**api_key** | **String** | The public API key of your Mailgun account. | 
+**domain** | **String** | The domain used to relay email. This domain must be configured and verified in your Mailgun account. | 
+**incoming_address** | **String** | Sunshine Conversations will receive all emails sent to this address. It will also be used as the Reply-To address. | 
+**hide_unsubscribe_link** | **Boolean** | A boolean value indicating whether the unsubscribe link should be omitted from outgoing emails. When enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. By default, the unsubscribe link will be included in all outgoing emails. | [optional] 
+**from_address** | **String** | Email address to use as the From and Reply-To address if it must be different from incomingAddress. Only use this option if the address that you supply is configured to forward emails to the incomingAddress, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user’s email client. May be unset with null. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Mailgun.new(type: null,
+                                 api_key: key-f265hj32f0sd897lqd2j5keb96784043,
+                                 domain: sandbox123.mailgun.org,
+                                 incoming_address: mytestemail@sandbox123.mailgun.org,
+                                 hide_unsubscribe_link: null,
+                                 from_address: test@sandbox123.mailgun.org)
+```
+
+

data/docs/MailgunAllOf.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::MailgunAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'mailgun']
+**api_key** | **String** | The public API key of your Mailgun account. | 
+**domain** | **String** | The domain used to relay email. This domain must be configured and verified in your Mailgun account. | 
+**incoming_address** | **String** | Sunshine Conversations will receive all emails sent to this address. It will also be used as the Reply-To address. | 
+**hide_unsubscribe_link** | **Boolean** | A boolean value indicating whether the unsubscribe link should be omitted from outgoing emails. When enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. By default, the unsubscribe link will be included in all outgoing emails. | [optional] 
+**from_address** | **String** | Email address to use as the From and Reply-To address if it must be different from incomingAddress. Only use this option if the address that you supply is configured to forward emails to the incomingAddress, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user’s email client. May be unset with null. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MailgunAllOf.new(type: null,
+                                 api_key: key-f265hj32f0sd897lqd2j5keb96784043,
+                                 domain: sandbox123.mailgun.org,
+                                 incoming_address: mytestemail@sandbox123.mailgun.org,
+                                 hide_unsubscribe_link: null,
+                                 from_address: test@sandbox123.mailgun.org)
+```
+
+

data/docs/MailgunUpdate.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::MailgunUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional] 
+**hide_unsubscribe_link** | **Boolean** | A boolean value indicating whether the unsubscribe link should be omitted from outgoing emails. When enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. By default, the unsubscribe link will be included in all outgoing emails. | [optional] 
+**from_address** | **String** | Email address to use as the From and Reply-To address if it must be different from incomingAddress. Only use this option if the address that you supply is configured to forward emails to the incomingAddress, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user’s email client. May be unset with null. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MailgunUpdate.new(display_name: My awesome integration,
+                                 hide_unsubscribe_link: null,
+                                 from_address: test@sandbox123.mailgun.org)
+```
+
+