sunshine-conversations-client 14.3.5 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21fbc1e500e6aca136291b088b2ad365959d79dc1ed51afe4074d63f0fab41d1
-  data.tar.gz: 953917170da2012c51c9175aa76dff77746d84ae188aec24f021c89213b6f168
+  metadata.gz: 27f1b4dee7209c9267b9d4e6946d1accbfa0da11462f3b445a1dfa9e8ca06338
+  data.tar.gz: 8d38180f5c98c8005b354a010502fbb26b87e7a68627ba6cae39f39e45053394
 SHA512:
-  metadata.gz: a4e213c40da8b89329fe6bcdb072a16edc988708bb57156bb9416d59ba3957eb4f331fa57ed6d80a09aadda5d99585e703d6996bc70bc8c57296fc300fb627e9
-  data.tar.gz: c01e181faa215e173063ccb8ebb760f5a58c52cf877c71e35c70386bf8c655d713dbcf1c36555fd44addfbeeb6218f62e2d9a2a4e8bf3dff6bbbb56467de20d8
+  metadata.gz: b13b5f8e1aa5cf0d8c5e186eed2cea9f94cffe4683862399ee6ed41586bf8414e3a68513ea0fb2de50d754a1ca4446b33558a482a9f0df9785c0c64dcfcc533b
+  data.tar.gz: 997060507e7478eead48042b05dcaef920635907980d6d4e21dacb569277f5a7c3d3111e2b7e5de0a4a90a78230565241cfc3d95808618713a13200f93565c45

data/CHANGELOG_RB.md

@@ -1,18 +1,39 @@
 # Changelog
 
-## [14.3.5] - 2025-2-1
+## [15.0.0] - 2025-03-05
+
+### Fixed
+
+- Fixed `nullable` definition on `next_switchbard_integration_id` property
+- Fixed `nullable` definition on required integration credentials
+- Changed typing of `metadata` fields from `Object` to `Hash<String, Object>`
+- Changed return type of `download_message_ref()` from `Object` to `Hash<String, Object>`
+- Changed typing of device `info` property from `Object` to `Hash<String, Object>`
+- Removed `switchboard_id` and `app_id` properties in `default_responder` schema 
+- Removed `deployment_id` in WhatsApp Integration
+
+## [14.4.0] - 2025-03-03
+
+### Added
+
+- Add `can_user_see_conversation_list` to all SDK integrations and their update schemas
+- Added new fields `html_text`, `markdown_text` to [Text](https://github.com/zendesk/sunshine-conversations-ruby/blob/master/docs/TextMessage.md), [Image](https://github.com/zendesk/sunshine-conversations-ruby/blob/master/docs/ImageMessage.md) and [File](https://github.com/zendesk/sunshine-conversations-javascript/blob/master/docs/FileMessage.md) messages.
+- See our [rich text](https://docs.smooch.io/guide/structured-messages/#rich-text) guide for more information.
+- Add definitions for ErrorResponse and Error
+
+## [14.3.5] - 2025-02-01
 
 ### Added
 
 - Update author.subtype enum to include 'activity'.
 
-## [14.3.4] - 2025-1-14
+## [14.3.4] - 2025-01-14
 
-### Added 
+### Added
 
 - Add a side note in the api documentation about providing authentication header when accessing mediaUrl with private attachments
 
-## [14.3.1 - 14.3.3] - 2025-1-7
+## [14.3.1 - 14.3.3] - 2025-01-07
 
 - Fixed errors that prevented publishing language wrappers for the new version.
 

data/README.md

@@ -4,8 +4,8 @@ SunshineConversationsClient - the Ruby gem for the Sunshine Conversations API
 
 This SDK is automatically generated by the [OpenAPI Generator Codegen](https://github.com/OpenAPITools/openapi-generator) project using the [Sunshine Conversations API spec](https://github.com/zendesk/sunshine-conversations-api-spec).
 
-- API version: 14.3.5
-- Package version: 14.3.5
+- API version: 15.0.0
+- Package version: 15.0.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Sunshine Conversations API Version
@@ -32,16 +32,16 @@ gem build sunshine-conversations-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./sunshine-conversations-client-14.3.5.gem
+gem install ./sunshine-conversations-client-15.0.0.gem
 ```
 
-(for development, run `gem install --dev ./sunshine-conversations-client-14.3.5.gem` to install the development dependencies)
+(for development, run `gem install --dev ./sunshine-conversations-client-15.0.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'sunshine-conversations-client', '~> 14.3.5'
+    gem 'sunshine-conversations-client', '~> 15.0.0'
 
 ### Install from Git
 
@@ -316,6 +316,8 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::DownloadMessageRefBodyAllOf](docs/DownloadMessageRefBodyAllOf.md)
  - [SunshineConversationsClient::DownloadMessageRefBodyAllOfApple](docs/DownloadMessageRefBodyAllOfApple.md)
  - [SunshineConversationsClient::DownloadMessageRefBodyAllOfAppleInteractiveDataRef](docs/DownloadMessageRefBodyAllOfAppleInteractiveDataRef.md)
+ - [SunshineConversationsClient::Error](docs/Error.md)
+ - [SunshineConversationsClient::ErrorResponse](docs/ErrorResponse.md)
  - [SunshineConversationsClient::EventSubSchema](docs/EventSubSchema.md)
  - [SunshineConversationsClient::ExtraChannelOptions](docs/ExtraChannelOptions.md)
  - [SunshineConversationsClient::ExtraChannelOptionsMessenger](docs/ExtraChannelOptionsMessenger.md)

data/docs/AcceptControlBody.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**metadata** | **Object** | 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. The metadata object will be included in the `switchboard:acceptControl` and `switchboard:acceptControl:failure` webhooks. | [optional] 
+**metadata** | **Hash** | 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. The metadata object will be included in the `switchboard:acceptControl` and `switchboard:acceptControl:failure` webhooks. | [optional] 
 
 ## Code Sample
 

data/docs/Action.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **text** | **String** | The button text. | 
 **amount** | **Integer** | The amount being charged. It needs to be specified in cents and is an integer (9.99$ -> 999). | 
 **currency** | **String** | An ISO 4217 standard currency code in lowercase. Used for actions of type buy. | [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] 
+**metadata** | **Hash<String, Object>** | 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] 
 **uri** | **String** | The webview URI. This is the URI that will open in the webview when clicking the button. | 
 **default** | **Boolean** | Boolean value indicating whether the action is the default action for a message item in Facebook Messenger. | [optional] 
 **extra_channel_options** | [**ExtraChannelOptions**](ExtraChannelOptions.md) |  | [optional] 

data/docs/ActionSubset.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **text** | **String** | The button text. | 
 **amount** | **Integer** | The amount being charged. It needs to be specified in cents and is an integer (9.99$ -> 999). | 
 **currency** | **String** | An ISO 4217 standard currency code in lowercase. Used for actions of type buy. | [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] 
+**metadata** | **Hash<String, Object>** | 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] 
 **uri** | **String** | The webview URI. This is the URI that will open in the webview when clicking the button. | 
 **default** | **Boolean** | Boolean value indicating whether the action is the default action for a message item in Facebook Messenger. | [optional] 
 **extra_channel_options** | [**ExtraChannelOptions**](ExtraChannelOptions.md) |  | [optional] 

data/docs/Android.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **private_key** | **String** | Your private key from your generated private key file. | [optional] 
 **server_key** | **String** | Your server key from the fcm console. | [optional] 
 **sender_id** | **String** | Your sender id from the fcm console. | [optional] 
+**can_user_see_conversation_list** | **Boolean** | Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`*.  | [optional] 
 **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the android integration. | [optional] 
 **attachments_enabled** | **Boolean** | Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center.  | [optional] [readonly] 
 **default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://docs.smooch.io/guide/switchboard/#per-channel-default-responder\">Per-channel default responder</a> guide.  | [optional] 
@@ -26,6 +27,7 @@ instance = SunshineConversationsClient::Android.new(type: null,
                                  private_key: <private-key>,
                                  server_key: <server-key>,
                                  sender_id: <sender-id>,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null,
                                  attachments_enabled: null,
                                  default_responder_id: null,

data/docs/AndroidAllOf.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **private_key** | **String** | Your private key from your generated private key file. | [optional] 
 **server_key** | **String** | Your server key from the fcm console. | [optional] 
 **sender_id** | **String** | Your sender id from the fcm console. | [optional] 
+**can_user_see_conversation_list** | **Boolean** | Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`*.  | [optional] 
 **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the android integration. | [optional] 
 **attachments_enabled** | **Boolean** | Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center.  | [optional] [readonly] 
 
@@ -24,6 +25,7 @@ instance = SunshineConversationsClient::AndroidAllOf.new(type: null,
                                  private_key: <private-key>,
                                  server_key: <server-key>,
                                  sender_id: <sender-id>,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null,
                                  attachments_enabled: null)
 ```

data/docs/AndroidUpdate.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **private_key** | **String** | Your private key from your generated private key file. | [optional] 
 **server_key** | **String** | Your server key from the fcm console. | [optional] 
 **sender_id** | **String** | Your sender id from the fcm console. | [optional] 
+**can_user_see_conversation_list** | **Boolean** | Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`*.  | [optional] 
 **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the android integration. | [optional] 
 
 ## Code Sample
@@ -25,6 +26,7 @@ instance = SunshineConversationsClient::AndroidUpdate.new(display_name: My aweso
                                  private_key: <private-key>,
                                  server_key: <server-key>,
                                  sender_id: <sender-id>,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null)
 ```
 

data/docs/AndroidUpdateAllOf.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **private_key** | **String** | Your private key from your generated private key file. | [optional] 
 **server_key** | **String** | Your server key from the fcm console. | [optional] 
 **sender_id** | **String** | Your sender id from the fcm console. | [optional] 
+**can_user_see_conversation_list** | **Boolean** | Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`*.  | [optional] 
 **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the android integration. | [optional] 
 
 ## Code Sample
@@ -21,6 +22,7 @@ instance = SunshineConversationsClient::AndroidUpdateAllOf.new(project_id: <p
                                  private_key: <private-key>,
                                  server_key: <server-key>,
                                  sender_id: <sender-id>,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null)
 ```
 

data/docs/App.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **id** | **String** | A canonical ID that can be used to retrieve the Sunshine Conversations app. | [optional] 
 **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] 
+**metadata** | **Hash<String, Object>** | 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
 

data/docs/AppCreateBody.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **display_name** | **String** | The friendly name of the app. | 
 **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] 
+**metadata** | **Hash<String, Object>** | 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
 

data/docs/AppSettings.md

@@ -22,7 +22,7 @@ instance = SunshineConversationsClient::AppSettings.new(conversation_retention_s
                                  use_animal_names: null,
                                  echo_postback: null,
                                  ignore_auto_conversation_start: null,
-                                 multi_convo_enabled: false,
+                                 multi_convo_enabled: true,
                                  app_localization_enabled: null)
 ```
 

data/docs/AppUpdateBody.md

@@ -6,7 +6,7 @@ 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] 
+**metadata** | **Hash<String, Object>** | 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
 

data/docs/AttachmentSchema.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**media_url** | **String** | Uploaded attachment’s url.  <aside class=\"notice\">Note that for private attachments an authorization header is required to access the mediaUrl. See <a href=\"https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/\">Configuring private attachments for messaging</a> guide for more details.</aside>  | [optional] 
+**media_url** | **String** | Uploaded attachment’s url.  <aside class=\"notice\">Note that for private attachments an authorization header is required to access the mediaUrl. See [configuring private attachments for messaging](https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/) guide for more details.</aside>  | [optional] 
 **media_type** | **String** | Uploaded attachment's media type | [optional] 
 
 ## Code Sample

data/docs/Buy.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **text** | **String** | The button text. | 
 **amount** | **Integer** | The amount being charged. It needs to be specified in cents and is an integer (9.99$ -> 999). | 
 **currency** | **String** | An ISO 4217 standard currency code in lowercase. Used for actions of type buy. | [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] 
+**metadata** | **Hash<String, Object>** | 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
 

data/docs/ClientsApi.md

@@ -37,7 +37,7 @@ end
 api_instance = SunshineConversationsClient::ClientsApi.new
 app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
 user_id_or_external_id = '42589ad070d43be9b00ff7e5' # String | The user's id or externalId.
-client_create = {"matchCriteria":{"type":"mailgun","integrationId":"582dedf230e788746891281a","primary":true,"address":"steveb@channel5.com","subject":"New message from {appName}"},"confirmation":{"type":"immediate","message":{"author":{"type":"business","displayName":"Steve","avatarUrl":"https://www.gravatar.com/image.jpg"},"content":{"type":"text","text":"Hello!"},"metadata":{"lang":"en-ca"}}},"target":{"conversationId":"029c31f25a21b47effd7be90"}} # ClientCreate | 
+client_create = SunshineConversationsClient::ClientCreate.new # ClientCreate | 
 # Be sure to add the required body parameters
 
 begin

data/docs/Content.md

@@ -6,11 +6,13 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | The type of message. | [default to 'template']
 **text** | **String** | The fallback text message used when location messages are not supported by the channel. | [optional] [readonly] 
+**html_text** | **String** | HTML text content of the message. Can be provided in place of `text`. Cannot be used with `markdownText`. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://docs.smooch.io/guide/structured-messages/rich-text) documentation for more information. | [optional] 
+**markdown_text** | **String** | Markdown text content of the message. Can be provided in place of `text`. Cannot be used with `htmlText`. Will be converted to `htmlText` upon reception. If converted `htmlText` exceeds 4096 characters, the message will be rejected. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://docs.smooch.io/guide/structured-messages/rich-text) documentation for more information. | [optional] 
 **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] 
 **payload** | **String** | The payload of a [reply button](https://docs.smooch.io/guide/structured-messages/#reply-buttons) response message. | [optional] 
 **items** | [**Array<Item>**](Item.md) | An array of objects representing the items associated with the message. Only present in carousel and list type messages. | 
 **display_settings** | [**CarouselMessageDisplaySettings**](CarouselMessageDisplaySettings.md) |  | [optional] 
-**media_url** | **String** | The URL for media, such as an image, attached to the message. <aside class=\"notice\">Note that for private attachments an authorization header is required to access the mediaUrl. See <a href=\"https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/\">Configuring private attachments for messaging</a> guide for more details.</aside>  | 
+**media_url** | **String** | The URL for media, such as an image, attached to the message. <aside class=\"notice\">Note that for private attachments an authorization header is required to access the mediaUrl. See [configuring private attachments for messaging](https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/) guide for more details.</aside>  | 
 **media_size** | **Float** | The size of the media in bytes. | [optional] [readonly] 
 **media_type** | **String** | The type of media. | [optional] [readonly] 
 **alt_text** | **String** | An optional description of the image for accessibility purposes. The field will be saved by default with the file name as the value. | [optional] 
@@ -30,6 +32,8 @@ require 'SunshineConversationsClient'
 
 instance = SunshineConversationsClient::Content.new(type: null,
                                  text: null,
+                                 html_text: <h1>Hello!</h1>,
+                                 markdown_text: # Hello!,
                                  actions: null,
                                  payload: null,
                                  items: null,

data/docs/Conversation.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | The unique ID of the conversation. | [optional] 
 **type** | [**ConversationType**](ConversationType.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] 
+**metadata** | **Hash<String, Object>** | 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] 
 **active_switchboard_integration** | [**SwitchboardIntegrationWebhook**](SwitchboardIntegrationWebhook.md) | The current switchboard integration that is in control of the conversation. This field is omitted if no `activeSwitchboardIntegration` exists for the conversation. | [optional] 
 **pending_switchboard_integration** | [**SwitchboardIntegrationWebhook**](SwitchboardIntegrationWebhook.md) | The switchboard integration that is awaiting control. This field is omitted if no switchboard integration has been previously offered control. | [optional] 
 **is_default** | **Boolean** | Whether the conversation is the default conversation for the user. Will be true for the first personal conversation created for the user, and false in all other cases.  | [optional] 

data/docs/ConversationCreateBody.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **display_name** | **String** | A friendly name for the conversation, may be displayed to the business or the user.  | [optional] 
 **description** | **String** | A short text describing the conversation. | [optional] 
 **icon_url** | **String** | A custom conversation icon url. The image must be in either JPG, PNG, or GIF format | [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] 
+**metadata** | **Hash<String, Object>** | 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
 

data/docs/ConversationTruncated.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | The unique ID of the conversation. | [optional] 
 **type** | [**ConversationType**](ConversationType.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] 
+**metadata** | **Hash<String, Object>** | 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] 
 **active_switchboard_integration** | [**SwitchboardIntegrationWebhook**](SwitchboardIntegrationWebhook.md) | The current switchboard integration that is in control of the conversation. This field is omitted if no `activeSwitchboardIntegration` exists for the conversation. | [optional] 
 **pending_switchboard_integration** | [**SwitchboardIntegrationWebhook**](SwitchboardIntegrationWebhook.md) | The switchboard integration that is awaiting control. This field is omitted if no switchboard integration has been previously offered control. | [optional] 
 

data/docs/ConversationUpdateBody.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **display_name** | **String** | A friendly name for the conversation, may be displayed to the business or the user.  | [optional] 
 **description** | **String** | A short text describing the conversation. | [optional] 
 **icon_url** | **String** | A custom conversation icon url. The image must be in either JPG, PNG, or GIF format | [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] 
+**metadata** | **Hash<String, Object>** | 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
 

data/docs/ConversationsApi.md

@@ -135,7 +135,7 @@ Name | Type | Description  | Notes
 
 ## download_message_ref
 
-> Object download_message_ref(app_id, conversation_id, download_message_ref_body)
+> Hash<String, Object> download_message_ref(app_id, conversation_id, download_message_ref_body)
 
 Download Message Ref
 
@@ -160,7 +160,7 @@ end
 api_instance = SunshineConversationsClient::ConversationsApi.new
 app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
 conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
-download_message_ref_body = {"userId":"6e416caac6a5e9544e3fb6d7","apple":{"interactiveDateRef":{"url":"https://p61-content.icloud.com/M58C0A1A2EB62B6E899B4F28996E8DA229E1914295299C39944B2F2CA7482AE50.C01USN00","bid":"com.apple.messages.MSMessageExtensionBalloonPlugin:0000000000:com.apple.icloud.apps.messages.business.extension","key":"00c0d1827fdc858fe7b42421de1fb289c2ee0a9463d787ce4f118506f970bd6e38","signature":"81a619c81da5a01c6139219a5d20e17430c631e1eb","owner":"M58C0A2A1EB62B4E859B4F28996E8DA229E1914295299C39944B2F2CA7482AE50.C01USN00"}}} # DownloadMessageRefBody | 
+download_message_ref_body = {"userId":"6e416caac6a5e9544e3fb6d7","apple":{"interactiveDataRef":{"url":"https://p61-content.icloud.com/M58C0A1A2EB62B6E899B4F28996E8DA229E1914295299C39944B2F2CA7482AE50.C01USN00","bid":"com.apple.messages.MSMessageExtensionBalloonPlugin:0000000000:com.apple.icloud.apps.messages.business.extension","key":"00c0d1827fdc858fe7b42421de1fb289c2ee0a9463d787ce4f118506f970bd6e38","signature":"81a619c81da5a01c6139219a5d20e17430c631e1eb","owner":"M58C0A2A1EB62B4E859B4F28996E8DA229E1914295299C39944B2F2CA7482AE50.C01USN00"}}} # DownloadMessageRefBody | 
 # Be sure to add the required body parameters
 
 begin
@@ -183,7 +183,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-**Object**
+**Hash<String, Object>**
 
 ### Authorization
 

data/docs/DefaultResponderDefaultResponder.md

@@ -4,26 +4,22 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**switchboard_id** | **String** | The unique ID of the switchboard. | [optional] 
-**app_id** | **String** | Identifies the app. | [optional] 
+**name** | **String** | The name of the switchboard integration. | [optional] 
 **integration_id** | **String** | The unique ID of the integration. | [optional] 
 **integration_type** | **String** | The type of the integration. | [optional] 
-**name** | **String** | The name of the switchboard. | [optional] 
 **deliver_standby_events** | **Boolean** | Indicates whether the switchboard should deliver standby events. | [optional] 
 **next_switchboard_integration_id** | **String** | The unique ID of the next switchboard integration. | [optional] 
 **message_history_count** | **Float** | The number of messages to keep in the message history. | [optional] 
-**inherited** | **Boolean** | Indicates whether the switchboard is inherited. | [optional] 
+**inherited** | **Boolean** | Indicates whether the default responder is inherited from the switchboard's global config or not. Returns `false` if a per-channel responder override has been set for this integration, and `true` otherwise. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'SunshineConversationsClient'
 
-instance = SunshineConversationsClient::DefaultResponderDefaultResponder.new(switchboard_id: 5e4af71a81966cfff3ef6551,
-                                 app_id: 5e4af71a81966cfff3ef6552,
+instance = SunshineConversationsClient::DefaultResponderDefaultResponder.new(name: null,
                                  integration_id: 5e4af71a81966cfff3ef6550,
                                  integration_type: null,
-                                 name: null,
                                  deliver_standby_events: null,
                                  next_switchboard_integration_id: null,
                                  message_history_count: null,

data/docs/Device.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **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] 
+**info** | **Hash<String, Object>** | 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

data/docs/DevicesApi.md

@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 Get Device
 
-Fetches a specific Device.  ```shell /v2/apps/:appId/users/:userId ``` 
+Fetches a specific Device. 
 
 ### Example
 
@@ -77,7 +77,7 @@ Name | Type | Description  | Notes
 
 List Devices
 
-Get all the devices for a particular user. The Devices are sorted based on last seen time.  ```shell /v2/apps/:appId/users/:userId/devices ``` 
+Get all the devices for a particular user. The Devices are sorted based on last seen time. 
 
 ### Example
 

data/docs/Error.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::Error
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Error code used for classifying similar error types | [optional] 
+**title** | **String** | Description of the error | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Error.new(code: not_found,
+                                 title: Resource not found)
+```
+
+

data/docs/ErrorResponse.md

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

data/docs/FileMessage.md

@@ -5,11 +5,13 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | The type of message. | [default to 'file']
-**media_url** | **String** | The URL for media, such as an image, attached to the message. <aside class=\"notice\">Note that for private attachments an authorization header is required to access the mediaUrl. See <a href=\"https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/\">Configuring private attachments for messaging</a> guide for more details.</aside>  | 
+**media_url** | **String** | The URL for media, such as an image, attached to the message. <aside class=\"notice\">Note that for private attachments an authorization header is required to access the mediaUrl. See [configuring private attachments for messaging](https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/) guide for more details.</aside>  | 
 **media_size** | **Float** | The size of the media. | [optional] [readonly] 
 **media_type** | **String** | The media type of the file. | [optional] [readonly] 
 **alt_text** | **String** | An optional description of the file for accessibility purposes. The field will be saved by default with the file name as the value. | [optional] 
 **text** | **String** | The text content of the message. | [optional] 
+**html_text** | **String** | HTML text content of the message. Can be provided in place of `text`. Cannot be used with `markdownText`. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://docs.smooch.io/guide/structured-messages/rich-text) documentation for more information. | [optional] 
+**markdown_text** | **String** | Markdown text content of the message. Can be provided in place of `text`. Cannot be used with `htmlText`. Will be converted to `htmlText` upon reception. If converted `htmlText` exceeds 4096 characters, the message will be rejected. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://docs.smooch.io/guide/structured-messages/rich-text) documentation for more information. | [optional] 
 **attachment_id** | **String** | An identifier used by Sunshine Conversations for internal purposes. | [optional] 
 
 ## Code Sample
@@ -23,6 +25,8 @@ instance = SunshineConversationsClient::FileMessage.new(type: null,
                                  media_type: null,
                                  alt_text: null,
                                  text: null,
+                                 html_text: <h1>Hello!</h1>,
+                                 markdown_text: # Hello!,
                                  attachment_id: null)
 ```
 

data/docs/ImageMessage.md

@@ -5,11 +5,13 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | The type of message. | [default to 'image']
-**media_url** | **String** | The URL for media, such as an image, attached to the message. <aside class=\"notice\">Note that for private attachments an authorization header is required to access the mediaUrl. See <a href=\"https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/\">Configuring private attachments for messaging</a> guide for more details.</aside>  | 
+**media_url** | **String** | The URL for media, such as an image, attached to the message. <aside class=\"notice\">Note that for private attachments an authorization header is required to access the mediaUrl. See [configuring private attachments for messaging](https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/messaging_private_attachments/) guide for more details.</aside>  | 
 **media_type** | **String** | The type of media. | [optional] [readonly] 
 **media_size** | **Float** | The size of the media in bytes. | [optional] [readonly] 
 **alt_text** | **String** | An optional description of the image for accessibility purposes. The field will be saved by default with the file name as the value. | [optional] 
-**text** | **String** | The text content of the message. Optional only if actions are provided. | [optional] 
+**text** | **String** | The text content of the message. | [optional] 
+**html_text** | **String** | HTML text content of the message. Can be provided in place of `text`. Cannot be used with `markdownText`. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://docs.smooch.io/guide/structured-messages/rich-text) documentation for more information. | [optional] 
+**markdown_text** | **String** | Markdown text content of the message. Can be provided in place of `text`. Cannot be used with `htmlText`. Will be converted to `htmlText` upon reception. If converted `htmlText` exceeds 4096 characters, the message will be rejected. If no `text` is provided, will be converted to `text` upon reception to be displayed on channels that do not support rich text. See [rich text](https://docs.smooch.io/guide/structured-messages/rich-text) documentation for more information. | [optional] 
 **actions** | [**Array<Action>**](Action.md) | Array of message actions. | [optional] 
 **attachment_id** | **String** | An identifier used by Sunshine Conversations for internal purposes. | [optional] 
 
@@ -24,6 +26,8 @@ instance = SunshineConversationsClient::ImageMessage.new(type: null,
                                  media_size: null,
                                  alt_text: null,
                                  text: null,
+                                 html_text: <h1>Hello!</h1>,
+                                 markdown_text: # Hello!,
                                  actions: null,
                                  attachment_id: null)
 ```

data/docs/IntegrationUpdate.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **private_key** | **String** | Your private key from your generated private key file. | [optional] 
 **server_key** | **String** | Your server key from the fcm console. | [optional] 
 **sender_id** | **String** | Your sender id from the fcm console. | [optional] 
+**can_user_see_conversation_list** | **Boolean** | Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`*.  | [optional] 
 **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional] 
 **authentication_message_secret** | **String** | A secret used to create the state value when sending Apple authentication 2.0 messages | [optional] 
 **page_access_token** | **String** | A Facebook Page Access Token. | [optional] 
@@ -50,6 +51,7 @@ instance = SunshineConversationsClient::IntegrationUpdate.new(display_name: My a
                                  private_key: <private-key>,
                                  server_key: <server-key>,
                                  sender_id: <sender-id>,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null,
                                  authentication_message_secret: eH3Ea4329FzUGEsWkjQr1dbD1JDpn5Ygo/kbW0/f8gOQ4eHTr31bjDUcCfv3s9QaAwRgpd4sckdlSXwMOAGHBQ==,
                                  page_access_token: your_access_token,

data/docs/IntegrationsApi.md

@@ -283,7 +283,7 @@ end
 api_instance = SunshineConversationsClient::IntegrationsApi.new
 app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
 integration_id = '029c31f25a21b47effd7be90' # String | The id of the integration.
-integration_update = SunshineConversationsClient::IntegrationUpdate.new # IntegrationUpdate | 
+integration_update = {"displayName":"My Test Integration"} # IntegrationUpdate | 
 # Be sure to add the required body parameters
 
 begin

data/docs/Ios.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **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_see_conversation_list** | **Boolean** | Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`*.  | [optional] 
 **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the iOS integration. | [optional] 
 **attachments_enabled** | **Boolean** | Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center.  | [optional] [readonly] 
 **default_responder_id** | **String** | The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://docs.smooch.io/guide/switchboard/#per-channel-default-responder\">Per-channel default responder</a> guide.  | [optional] 
@@ -24,6 +25,7 @@ instance = SunshineConversationsClient::Ios.new(type: null,
                                  password: your_APN_password,
                                  production: null,
                                  auto_update_badge: null,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null,
                                  attachments_enabled: null,
                                  default_responder_id: null,

data/docs/IosAllOf.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **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_see_conversation_list** | **Boolean** | Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`*.  | [optional] 
 **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the iOS integration. | [optional] 
 **attachments_enabled** | **Boolean** | Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center.  | [optional] [readonly] 
 
@@ -22,6 +23,7 @@ instance = SunshineConversationsClient::IosAllOf.new(type: null,
                                  password: your_APN_password,
                                  production: null,
                                  auto_update_badge: null,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null,
                                  attachments_enabled: null)
 ```