sunshine-conversations-client 14.3.5 → 15.0.0

data/docs/IosUpdate.md

@@ -10,6 +10,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] 
 
 ## Code Sample
@@ -23,6 +24,7 @@ instance = SunshineConversationsClient::IosUpdate.new(display_name: My awesome i
                                  password: your_APN_password,
                                  production: null,
                                  auto_update_badge: null,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null)
 ```
 

data/docs/IosUpdateAllOf.md

@@ -8,6 +8,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] 
 
 ## Code Sample
@@ -19,6 +20,7 @@ instance = SunshineConversationsClient::IosUpdateAllOf.new(certificate: your_APN
                                  password: your_APN_password,
                                  production: null,
                                  auto_update_badge: null,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null)
 ```
 

data/docs/Item.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **alt_text** | **String** | An optional description of the media for accessibility purposes. The field will be saved by default with the file name as the value. | [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] 
+**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/Link.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **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] 
+**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] 
 **extra_channel_options** | [**ExtraChannelOptions**](ExtraChannelOptions.md) |  | [optional] 
 
 ## Code Sample

data/docs/LocationRequest.md

@@ -6,7 +6,7 @@ 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] 
+**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/Message.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **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] 
+**metadata** | **Hash** |  | [optional] 
 **deleted** | **Boolean** | true if the message serves as a placeholder for one that has been deleted. | [optional] 
 
 ## Code Sample

data/docs/MessagePost.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **author** | [**Author**](Author.md) | The author of the message. | 
 **content** | [**Content**](Content.md) | The content of the message. | 
 **destination** | [**Destination**](Destination.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] 
 **override** | [**MessageOverride**](MessageOverride.md) |  | [optional] 
 **schema** | **String** | When `schema` is set to `\"whatsapp\"`, the `content` key is expected to conform to the [native WhatsApp schema](https://developers.facebook.com/docs/whatsapp/api/messages/message-templates) for sending message templates. For more details, consult the documentation for [sending message templates on WhatsApp](https://docs.smooch.io/guide/whatsapp/#sending-message-templates).  | [optional] 
 

data/docs/MessageWebhook.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **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] 
+**metadata** | **Hash** |  | [optional] 
 **deleted** | **Boolean** | true if the message serves as a placeholder for one that has been deleted. | [optional] 
 
 ## Code Sample

data/docs/OAuthEndpointsApi.md

@@ -62,7 +62,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: text/plain
 
 
 ## get_token

data/docs/OfferControlBody.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **switchboard_integration** | **String** | The id or the name of the switchboard integration that will become pending. Also supports the `next` keyword to offer control to the next switchboard integration designated in the switchboard hierarchy configuration. This cannot match the active switchboard integration. | 
-**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:offerControl` and `switchboard:offerControl: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:offerControl` and `switchboard:offerControl:failure` webhooks. | [optional] 
 
 ## Code Sample
 

data/docs/ParticipantsApi.md

@@ -37,7 +37,7 @@ end
 api_instance = SunshineConversationsClient::ParticipantsApi.new
 app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
 conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
-participant_join_body = SunshineConversationsClient::ParticipantJoinBody.new # ParticipantJoinBody | 
+participant_join_body = {"userId":"67a11490f0305f4a391e9f8a","subscribeSDKClient":true} # ParticipantJoinBody | 
 # Be sure to add the required body parameters
 
 begin
@@ -99,7 +99,7 @@ end
 api_instance = SunshineConversationsClient::ParticipantsApi.new
 app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
 conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
-participant_leave_body = SunshineConversationsClient::ParticipantLeaveBody.new # ParticipantLeaveBody | 
+participant_leave_body = {"userId":"67a11490f0305f4a391e9f8a"} # ParticipantLeaveBody | 
 # Be sure to add the required body parameters
 
 begin

data/docs/PassControlBody.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **switchboard_integration** | **String** | The id or the name of the switchboard integration that will become active. May also use the `next` keyword to transfer control to the next switchboard integration designated in the switchboard hierarchy configuration | 
-**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:passControl` webhook. | [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:passControl` webhook. | [optional] 
 
 ## Code Sample
 

data/docs/Postback.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **type** | **String** | The type of action. | [default to 'postback']
 **text** | **String** | The button text. | 
 **payload** | **String** | The payload of a postback or reply button. | 
-**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/PostbackWebhook.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payload** | **String** | The payload associated with the postback. | [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/Reply.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **type** | **String** | The type of action. | 
 **text** | **String** | The button text. We recommend a non-empty value because some channels may not support empty ones. Text longer than 20 characters will be truncated on Facebook Messenger, and longer than 40 characters will be truncated on Web Messenger, iOS, and Android. | 
 **payload** | **String** | A string payload to help you identify the action context. Used when posting the reply. You can also use metadata for more complex needs. | 
-**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] 
 **icon_url** | **String** | An icon to render next to the reply option. | [optional] 
 
 ## Code Sample

data/docs/SwitchboardAcceptControlAllOfPayload.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. Will include an `activeSwitchboardIntegration` representing the integration that has just accepted control. | [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/SwitchboardAcceptControlFailureAllOfPayload.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **error** | [**Object**](.md) | Object containing details of what went wrong. | [optional] 
 **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. | [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/SwitchboardIntegrationCreateBody.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **integration_id** | **String** | The id of the integration to link to the switchboard integration. Must be used when linking a custom integration. One of `integrationId` or `integrationType` must be provided. | [optional] 
 **integration_type** | **String** | The type of the integration to link to the switchboard integration. Must be used when linking an OAuth integration. One of `integrationId` or `integrationType` must be provided. | [optional] 
 **deliver_standby_events** | **Boolean** |  | [optional] 
-**next_switchboard_integration_id** | **String** |  | [optional] 
+**next_switchboard_integration_id** | **String** | The switchboard integration id to which control of a conversation is passed / offered by default. | [optional] 
 **message_history_count** | **Integer** | Number of messages to include in the message history context. | [optional] 
 
 ## Code Sample
@@ -20,7 +20,7 @@ instance = SunshineConversationsClient::SwitchboardIntegrationCreateBody.new(nam
                                  integration_id: null,
                                  integration_type: null,
                                  deliver_standby_events: null,
-                                 next_switchboard_integration_id: null,
+                                 next_switchboard_integration_id: 5ef21b86e933b7355c11c606,
                                  message_history_count: 5)
 ```
 

data/docs/SwitchboardIntegrationUpdateBody.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **integration_id** | **String** | The id of the integration to link to the switchboard integration. Must be used when linking a custom integration. Can't provide both `integrationId` and `integrationType`. | [optional] 
 **integration_type** | **String** | The type of the integration to link to the switchboard integration. Must be used when linking an OAuth integration. Can't provide both `integrationId` and `integrationType`. | [optional] 
 **deliver_standby_events** | **Boolean** | Setting to determine if webhooks should be sent when the switchboard integration is not in control of a conversation (standby status) | [optional] 
-**next_switchboard_integration_id** | **String** |  | [optional] 
+**next_switchboard_integration_id** | **String** | The switchboard integration id to which control of a conversation is passed / offered by default. | [optional] 
 **message_history_count** | **Integer** | Number of messages to include in the message history context. | [optional] 
 
 ## Code Sample
@@ -20,7 +20,7 @@ instance = SunshineConversationsClient::SwitchboardIntegrationUpdateBody.new(nam
                                  integration_id: null,
                                  integration_type: null,
                                  deliver_standby_events: null,
-                                 next_switchboard_integration_id: null,
+                                 next_switchboard_integration_id: 5ef21b86e933b7355c11c606,
                                  message_history_count: 5)
 ```
 

data/docs/SwitchboardIntegrationsApi.md

@@ -223,7 +223,7 @@ api_instance = SunshineConversationsClient::SwitchboardIntegrationsApi.new
 app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
 switchboard_id = '5d8cff3cd55b040010928b5b' # String | Identifies the switchboard.
 switchboard_integration_id = '5d8cff3cd55b040010928b5b' # String | Identifies the switchboard integration.
-switchboard_integration_update_body = {"name":"bot","integrationType":"zd:agentWorkspace","deliverStandbyEvents":true,"nextSwitchboardIntegrationId":"5ef21b86e933b7355c11c606","messageHistoryCount":5} # SwitchboardIntegrationUpdateBody | 
+switchboard_integration_update_body = {"deliverStandbyEvents":true,"nextSwitchboardIntegrationId":"5ef21b86e933b7355c11c606","messageHistoryCount":5} # SwitchboardIntegrationUpdateBody | 
 # Be sure to add the required body parameters
 
 begin

data/docs/SwitchboardOfferControlAllOfPayload.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. On success, the payload will include an `activeSwitchboardIntegration`, representing the integration from which control is being offered, and a `pendingSwitchboardIntegration`, representing the integration being offered control. | [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/SwitchboardPassControlAllOfPayload.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. On success, the payload will include an `activeSwitchboardIntegration`, representing the switchboard integration that is now in control of the conversation. | [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/TextMessage.md

@@ -5,7 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | The type of message. | [default to 'text']
-**text** | **String** | The text content of the message. Optional only if actions are provided. | [optional] 
+**text** | **String** | The text content of the message. Required unless `actions`, `htmlText` or `markdownText` is provided. | [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] 
 **payload** | **String** | The payload of a [reply button](https://docs.smooch.io/guide/structured-messages/#reply-buttons) response message. | [optional] 
 
@@ -16,6 +18,8 @@ require 'SunshineConversationsClient'
 
 instance = SunshineConversationsClient::TextMessage.new(type: null,
                                  text: Hello!,
+                                 html_text: <h1>Hello!</h1>,
+                                 markdown_text: # Hello!,
                                  actions: null,
                                  payload: null)
 ```

data/docs/Unity.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | To configure a Unity integration, create an integration with type 'unity' by calling the Create Integration endpoint.  | [optional] [default to 'unity']
+**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 Unity 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] 
@@ -16,6 +17,7 @@ Name | Type | Description | Notes
 require 'SunshineConversationsClient'
 
 instance = SunshineConversationsClient::Unity.new(type: null,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null,
                                  attachments_enabled: null,
                                  default_responder_id: null,

data/docs/UnityAllOf.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | To configure a Unity integration, create an integration with type 'unity' by calling the Create Integration endpoint.  | [optional] [default to 'unity']
+**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 Unity 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] 
 
@@ -14,6 +15,7 @@ Name | Type | Description | Notes
 require 'SunshineConversationsClient'
 
 instance = SunshineConversationsClient::UnityAllOf.new(type: null,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null,
                                  attachments_enabled: null)
 ```

data/docs/UnityUpdate.md

@@ -6,6 +6,7 @@ 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] 
 **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] 
+**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 Unity integration. | [optional] 
 
 ## Code Sample
@@ -15,6 +16,7 @@ require 'SunshineConversationsClient'
 
 instance = SunshineConversationsClient::UnityUpdate.new(display_name: My awesome integration,
                                  default_responder_id: null,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null)
 ```
 

data/docs/UnityUpdateAllOf.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**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 Unity integration. | [optional] 
 
 ## Code Sample
@@ -11,7 +12,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'SunshineConversationsClient'
 
-instance = SunshineConversationsClient::UnityUpdateAllOf.new(can_user_create_more_conversations: null)
+instance = SunshineConversationsClient::UnityUpdateAllOf.new(can_user_see_conversation_list: false,
+                                 can_user_create_more_conversations: null)
 ```
 
 

data/docs/User.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **signed_up_at** | **String** |  | [optional] 
 **to_be_retained** | **Boolean** |  | [optional] 
 **profile** | [**Profile**](Profile.md) |  | [optional] 
-**metadata** | **Object** |  | [optional] 
+**metadata** | **Hash** |  | [optional] 
 **identities** | [**Array<Identity>**](Identity.md) | The user's connected identities. | [optional] [readonly] 
 
 ## Code Sample

data/docs/UserAllOf.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **signed_up_at** | **String** |  | [optional] 
 **to_be_retained** | **Boolean** |  | [optional] 
 **profile** | [**Profile**](Profile.md) |  | [optional] 
-**metadata** | **Object** |  | [optional] 
+**metadata** | **Hash** |  | [optional] 
 **identities** | [**Array<Identity>**](Identity.md) | The user's connected identities. | [optional] [readonly] 
 
 ## Code Sample

data/docs/UserCreateBody.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **signed_up_at** | **String** | The date at which the user signed up. Must be ISO 8601 time format `YYYY-MM-DDThh:mm:ss.sssZ`. | [optional] 
 **to_be_retained** | **Boolean** | Flag indicating whether a user should be retained after they have passed their inactive expiry. See [creating deletion schedules for bot-only conversations](https://support.zendesk.com/hc/en-us/articles/8499219792154) for more information. | [optional] 
 **profile** | [**Profile**](Profile.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/UserMergeEventAllOfPayload.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **merged_users** | [**UserMergeEventAllOfPayloadMergedUsers**](UserMergeEventAllOfPayloadMergedUsers.md) |  | [optional] 
 **merged_conversations** | [**UserMergeEventAllOfPayloadMergedConversations**](UserMergeEventAllOfPayloadMergedConversations.md) |  | [optional] 
 **merged_clients** | [**UserMergeEventAllOfPayloadMergedClients**](UserMergeEventAllOfPayloadMergedClients.md) |  | [optional] 
-**discarded_metadata** | **Object** | A flat object with the set of metadata properties that were discarded when merging the two users. This should contain values only if the combined metadata fields exceed the 4KB limit. | [optional] 
+**discarded_metadata** | **Hash** | A flat object with the set of metadata properties that were discarded when merging the two users. This should contain values only if the combined metadata fields exceed the 4KB limit. | [optional] 
 **reason** | **String** | The reason for which the users merged. * `api` - The users were merged using the API. * `channelLinking` - The users were merged as a result of initiating a channel link. * `sdkLogin` - The users were merged as a result of logging into an SDK device.  | [optional] 
 
 ## Code Sample

data/docs/UserUpdateBody.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **signed_up_at** | **String** |  | [optional] 
 **to_be_retained** | **Boolean** |  | [optional] 
 **profile** | [**Profile**](Profile.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/WebUpdate.md

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **background_image_url** | **String** | A background image url for the conversation. Image will be tiled to fit the window. | [optional] 
 **origin_whitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454: scheme \"://\" host [ \":\" port ], where scheme is http or https.  | [optional] 
 **prechat_capture** | [**PrechatCapture**](PrechatCapture.md) | Object whose properties can be set to specify the add-on’s options. See the [guide](https://docs.smooch.io/guide/web-messenger/#prechat-capture) to learn more about Prechat Capture. | [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] 
 
 ## Code Sample
@@ -43,6 +44,7 @@ instance = SunshineConversationsClient::WebUpdate.new(display_name: My awesome i
                                  background_image_url: https://a-beautiful-tile.png,
                                  origin_whitelist: null,
                                  prechat_capture: null,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null)
 ```
 

data/docs/WebUpdateAllOf.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **background_image_url** | **String** | A background image url for the conversation. Image will be tiled to fit the window. | [optional] 
 **origin_whitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454: scheme \"://\" host [ \":\" port ], where scheme is http or https.  | [optional] 
 **prechat_capture** | [**PrechatCapture**](PrechatCapture.md) | Object whose properties can be set to specify the add-on’s options. See the [guide](https://docs.smooch.io/guide/web-messenger/#prechat-capture) to learn more about Prechat Capture. | [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] 
 
 ## Code Sample
@@ -39,6 +40,7 @@ instance = SunshineConversationsClient::WebUpdateAllOf.new(brand_color: null,
                                  background_image_url: https://a-beautiful-tile.png,
                                  origin_whitelist: null,
                                  prechat_capture: null,
+                                 can_user_see_conversation_list: false,
                                  can_user_create_more_conversations: null)
 ```
 

data/docs/Webview.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **uri** | **String** | The webview URI. This is the URI that will open in the webview 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] 
+**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] 
 **extra_channel_options** | [**ExtraChannelOptions**](ExtraChannelOptions.md) |  | [optional] 
 **size** | **String** | The size to display a webview. Used for actions of type webview. | [optional] 
 **fallback** | **String** | The fallback uri for channels that don’t support webviews. Used for actions of type webview. | 

data/docs/Whatsapp.md

@@ -5,7 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | To configure a WhatsApp integration, use your WhatsApp API Client connection information. Sunshine Conversations can provide WhatsApp API Client hosting for approved brands. See our [WhatsApp guide](https://docs.smooch.io/guide/whatsapp/#whatsapp-api-client) for more details on WhatsApp API Client hosting.  | [optional] [default to 'whatsapp']
-**deployment_id** | **String** | The Id of the deployment. The integrationId and the appId will be added to the deployment. Additionally, the deployment’s status will be set to integrated. | 
 **hsm_fallback_language** | **String** | Specify a fallback language to use when sending WhatsApp message template using the short hand syntax. Defaults to en_US. See WhatsApp documentation for more info. | [optional] [default to 'en_US']
 **account_id** | **String** | The business ID associated with the WhatsApp account. In combination with accountManagementAccessToken, it’s used for Message Template Reconstruction. | [optional] 
 **account_management_access_token** | **String** | An access token associated with the accountId used to query the WhatsApp Account Management API. In combination with accountId, it’s used for Message Template Reconstruction. | [optional] 
@@ -19,7 +18,6 @@ Name | Type | Description | Notes
 require 'SunshineConversationsClient'
 
 instance = SunshineConversationsClient::Whatsapp.new(type: null,
-                                 deployment_id: 55c8d9758590aa1900b9b9aa,
                                  hsm_fallback_language: null,
                                  account_id: your_whatsApp_account_id,
                                  account_management_access_token: your_access_token,

data/docs/WhatsappAllOf.md

@@ -5,7 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | To configure a WhatsApp integration, use your WhatsApp API Client connection information. Sunshine Conversations can provide WhatsApp API Client hosting for approved brands. See our [WhatsApp guide](https://docs.smooch.io/guide/whatsapp/#whatsapp-api-client) for more details on WhatsApp API Client hosting.  | [optional] [default to 'whatsapp']
-**deployment_id** | **String** | The Id of the deployment. The integrationId and the appId will be added to the deployment. Additionally, the deployment’s status will be set to integrated. | 
 **hsm_fallback_language** | **String** | Specify a fallback language to use when sending WhatsApp message template using the short hand syntax. Defaults to en_US. See WhatsApp documentation for more info. | [optional] [default to 'en_US']
 **account_id** | **String** | The business ID associated with the WhatsApp account. In combination with accountManagementAccessToken, it’s used for Message Template Reconstruction. | [optional] 
 **account_management_access_token** | **String** | An access token associated with the accountId used to query the WhatsApp Account Management API. In combination with accountId, it’s used for Message Template Reconstruction. | [optional] 
@@ -17,7 +16,6 @@ Name | Type | Description | Notes
 require 'SunshineConversationsClient'
 
 instance = SunshineConversationsClient::WhatsappAllOf.new(type: null,
-                                 deployment_id: 55c8d9758590aa1900b9b9aa,
                                  hsm_fallback_language: null,
                                  account_id: your_whatsApp_account_id,
                                  account_management_access_token: your_access_token,

data/lib/sunshine-conversations-client/api/activities_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 14.3.5
+The version of the OpenAPI document: 15.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/app_keys_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 14.3.5
+The version of the OpenAPI document: 15.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/apps_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 14.3.5
+The version of the OpenAPI document: 15.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/attachments_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 14.3.5
+The version of the OpenAPI document: 15.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/clients_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 14.3.5
+The version of the OpenAPI document: 15.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/conversations_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 14.3.5
+The version of the OpenAPI document: 15.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -160,7 +160,7 @@ module SunshineConversationsClient
     # @param conversation_id [String] Identifies the conversation.
     # @param download_message_ref_body [DownloadMessageRefBody] 
     # @param [Hash] opts the optional parameters
-    # @return [Object]
+    # @return [Hash<String, Object>]
     def download_message_ref(app_id, conversation_id, download_message_ref_body, opts = {})
       data, _status_code, _headers = download_message_ref_with_http_info(app_id, conversation_id, download_message_ref_body, opts)
       data
@@ -172,7 +172,7 @@ module SunshineConversationsClient
     # @param conversation_id [String] Identifies the conversation.
     # @param download_message_ref_body [DownloadMessageRefBody] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
     def download_message_ref_with_http_info(app_id, conversation_id, download_message_ref_body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConversationsApi.download_message_ref ...'
@@ -209,7 +209,7 @@ module SunshineConversationsClient
       post_body = opts[:body] || @api_client.object_to_http_body(download_message_ref_body) 
 
       # return_type
-      return_type = opts[:return_type] || 'Object' 
+      return_type = opts[:return_type] || 'Hash<String, Object>' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

data/lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 14.3.5
+The version of the OpenAPI document: 15.0.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1