sunshine-conversations-client 9.1.1

data/docs/MailgunUpdateAllOf.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::MailgunUpdateAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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::MailgunUpdateAllOf.new(hide_unsubscribe_link: null,
+                                 from_address: test@sandbox123.mailgun.org)
+```
+
+

data/docs/MatchCriteria.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::MatchCriteria
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The channel type. | [default to 'whatsapp']
+**integration_id** | **String** | The ID of the integration to link. Must match the provided type. | 
+**primary** | **Boolean** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to true]
+**address** | **String** | The user’s email address. | 
+**subject** | **String** | May be specified to set the subject for the outgoing email. | [optional] [default to 'New message from {appName}']
+**phone_number** | **String** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368.  | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MatchCriteria.new(type: null,
+                                 integration_id: 582dedf230e788746891281a,
+                                 primary: null,
+                                 address: steveb@channel5.com,
+                                 subject: null,
+                                 phone_number: +15550001234)
+```
+
+

data/docs/MatchCriteriaBase.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::MatchCriteriaBase
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The channel type. | 
+**integration_id** | **String** | The ID of the integration to link. Must match the provided type. | 
+**primary** | **Boolean** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to true]
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MatchCriteriaBase.new(type: null,
+                                 integration_id: 582dedf230e788746891281a,
+                                 primary: null)
+```
+
+

data/docs/MatchCriteriaMailgun.md

@@ -0,0 +1,25 @@
+# SunshineConversationsClient::MatchCriteriaMailgun
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The channel type. | [default to 'mailgun']
+**integration_id** | **String** | The ID of the integration to link. Must match the provided type. | 
+**primary** | **Boolean** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to true]
+**address** | **String** | The user’s email address. | 
+**subject** | **String** | May be specified to set the subject for the outgoing email. | [optional] [default to 'New message from {appName}']
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MatchCriteriaMailgun.new(type: null,
+                                 integration_id: 582dedf230e788746891281a,
+                                 primary: null,
+                                 address: steveb@channel5.com,
+                                 subject: null)
+```
+
+

data/docs/MatchCriteriaMailgunAllOf.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::MatchCriteriaMailgunAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The channel type. | [optional] [default to 'mailgun']
+**address** | **String** | The user’s email address. | 
+**subject** | **String** | May be specified to set the subject for the outgoing email. | [optional] [default to 'New message from {appName}']
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MatchCriteriaMailgunAllOf.new(type: null,
+                                 address: steveb@channel5.com,
+                                 subject: null)
+```
+
+

data/docs/MatchCriteriaMessagebird.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::MatchCriteriaMessagebird
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The channel type. | [default to 'messagebird']
+**integration_id** | **String** | The ID of the integration to link. Must match the provided type. | 
+**primary** | **Boolean** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to true]
+**phone_number** | **String** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368.  | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MatchCriteriaMessagebird.new(type: null,
+                                 integration_id: 582dedf230e788746891281a,
+                                 primary: null,
+                                 phone_number: +15550001234)
+```
+
+

data/docs/MatchCriteriaMessagebirdAllOf.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::MatchCriteriaMessagebirdAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The channel type. | [optional] [default to 'messagebird']
+**phone_number** | **String** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368.  | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MatchCriteriaMessagebirdAllOf.new(type: null,
+                                 phone_number: +15550001234)
+```
+
+

data/docs/MatchCriteriaTwilio.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::MatchCriteriaTwilio
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The channel type. | [default to 'twilio']
+**integration_id** | **String** | The ID of the integration to link. Must match the provided type. | 
+**primary** | **Boolean** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to true]
+**phone_number** | **String** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368.  | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MatchCriteriaTwilio.new(type: null,
+                                 integration_id: 582dedf230e788746891281a,
+                                 primary: null,
+                                 phone_number: +15550001234)
+```
+
+

data/docs/MatchCriteriaTwilioAllOf.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::MatchCriteriaTwilioAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The channel type. | [optional] [default to 'twilio']
+**phone_number** | **String** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368.  | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MatchCriteriaTwilioAllOf.new(type: null,
+                                 phone_number: +15550001234)
+```
+
+

data/docs/MatchCriteriaWhatsapp.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::MatchCriteriaWhatsapp
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The channel type. | [default to 'whatsapp']
+**integration_id** | **String** | The ID of the integration to link. Must match the provided type. | 
+**primary** | **Boolean** | Flag indicating whether the client will become the primary for the target conversation once linking is complete. | [optional] [default to true]
+**phone_number** | **String** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368.  | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MatchCriteriaWhatsapp.new(type: null,
+                                 integration_id: 582dedf230e788746891281a,
+                                 primary: null,
+                                 phone_number: +15550001234)
+```
+
+

data/docs/MatchCriteriaWhatsappAllOf.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::MatchCriteriaWhatsappAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The channel type. | [optional] [default to 'whatsapp']
+**phone_number** | **String** | The user’s phone number. It must contain the + prefix and the country code. Examples of valid phone numbers: +1 212-555-2368, +12125552368, +1 212 555 2368. Examples of invalid phone numbers: 212 555 2368, 1 212 555 2368.  | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MatchCriteriaWhatsappAllOf.new(type: null,
+                                 phone_number: +15550001234)
+```
+
+

data/docs/Message.md

@@ -0,0 +1,31 @@
+# SunshineConversationsClient::Message
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the message. | [optional] 
+**received** | **String** | A datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing when Sunshine Conversations received the message. | [optional] 
+**author** | [**Author**](Author.md) |  | [optional] 
+**content** | [**Content**](Content.md) | The content of the message. | [optional] 
+**source** | [**Source**](Source.md) |  | [optional] 
+**quoted_message** | [**QuotedMessage**](QuotedMessage.md) | The quoted message is currently only available for WhatsApp and Web Messenger `formResponse` messages. | [optional] 
+**metadata** | **Object** |  | [optional] 
+**deleted** | **Boolean** | true if the message serves as a placeholder for one that has been deleted. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Message.new(id: 5e552ef595e5206375bb835d,
+                                 received: 2019-03-21T18:48:52.760Z,
+                                 author: null,
+                                 content: null,
+                                 source: null,
+                                 quoted_message: null,
+                                 metadata: null,
+                                 deleted: null)
+```
+
+

data/docs/MessageBirdUpdate.md

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

data/docs/MessageListResponse.md

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

data/docs/MessageOverride.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::MessageOverride
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**apple** | [**MessageOverridePayload**](MessageOverridePayload.md) |  | [optional] 
+**line** | [**MessageOverridePayload**](MessageOverridePayload.md) |  | [optional] 
+**messenger** | [**MessageOverridePayload**](MessageOverridePayload.md) |  | [optional] 
+**whatsapp** | [**MessageOverridePayload**](MessageOverridePayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MessageOverride.new(apple: null,
+                                 line: null,
+                                 messenger: null,
+                                 whatsapp: null)
+```
+
+

data/docs/MessageOverrideApple.md

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

data/docs/MessageOverrideLine.md

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

data/docs/MessageOverrideMessenger.md

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

data/docs/MessageOverridePayload.md

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

data/docs/MessageOverrideWhatsapp.md

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