sunshine-conversations-client 9.4.5 → 9.4.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG_RB.md +6 -0
  3. data/README.md +14 -4
  4. data/docs/ClientAddEvent.md +23 -0
  5. data/docs/ClientAddEventAllOf.md +17 -0
  6. data/docs/ClientAddEventAllOfPayload.md +25 -0
  7. data/docs/ClientRemoveEvent.md +23 -0
  8. data/docs/ClientRemoveEventAllOf.md +17 -0
  9. data/docs/ClientRemoveEventAllOfPayload.md +27 -0
  10. data/docs/ClientUpdateEvent.md +23 -0
  11. data/docs/ClientUpdateEventAllOf.md +17 -0
  12. data/docs/ClientUpdateEventAllOfPayload.md +23 -0
  13. data/docs/InlineObject.md +2 -2
  14. data/docs/User.md +1 -1
  15. data/docs/UserMergeEventAllOfPayload.md +5 -1
  16. data/docs/UserMergeEventAllOfPayloadMergedClients.md +19 -0
  17. data/docs/UserTruncated.md +1 -1
  18. data/docs/Web.md +17 -15
  19. data/docs/WebAllOf.md +17 -15
  20. data/lib/sunshine-conversations-client/models/client_add_event.rb +241 -0
  21. data/lib/sunshine-conversations-client/models/client_add_event_all_of.rb +203 -0
  22. data/lib/sunshine-conversations-client/models/client_add_event_all_of_payload.rb +280 -0
  23. data/lib/sunshine-conversations-client/models/client_remove_event.rb +241 -0
  24. data/lib/sunshine-conversations-client/models/client_remove_event_all_of.rb +203 -0
  25. data/lib/sunshine-conversations-client/models/client_remove_event_all_of_payload.rb +291 -0
  26. data/lib/sunshine-conversations-client/models/client_update_event.rb +241 -0
  27. data/lib/sunshine-conversations-client/models/client_update_event_all_of.rb +203 -0
  28. data/lib/sunshine-conversations-client/models/client_update_event_all_of_payload.rb +269 -0
  29. data/lib/sunshine-conversations-client/models/inline_object.rb +1 -1
  30. data/lib/sunshine-conversations-client/models/user.rb +1 -1
  31. data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload.rb +59 -5
  32. data/lib/sunshine-conversations-client/models/user_merge_event_all_of_payload_merged_clients.rb +215 -0
  33. data/lib/sunshine-conversations-client/models/user_truncated.rb +1 -1
  34. data/lib/sunshine-conversations-client/models/web.rb +24 -14
  35. data/lib/sunshine-conversations-client/models/web_all_of.rb +24 -14
  36. data/lib/sunshine-conversations-client/version.rb +1 -1
  37. data/lib/sunshine-conversations-client.rb +10 -0
  38. metadata +22 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 0d044cd36878bad5bc93d1de75922023ef43f246
4
- data.tar.gz: 6b1a47382d1ff40fa5e57cd2f8b5abbd3cd6a8cd
3
+ metadata.gz: 369433b8200f3097669f8e06e2a62da685a65ddf
4
+ data.tar.gz: ac1a4d42fc7654757c1d0c537365deaa5e267fe0
5
5
  SHA512:
6
- metadata.gz: 4a392adbddf6bbe208d3d505a1884dd601042f87776182aa382830f7dc235afd76e4be7953bd78f41a841a0872954f8b5078be16cf15c454233d1d00441c1ef1
7
- data.tar.gz: 597a2d553f9a29eba425b78284a93c1c644e94090ea5493097d3aa0570cf0d29cb6ac1260c63884528b0ff9e84199612285c2bff12c8a6047d0852fb7573661d
6
+ metadata.gz: 136e8b1f5cf19c800c9ae597b61bedcd9c71de2b2ab7a476314f99018cda044175bff87799ed69f5d186a32588f9226e49e4371cb24ff7945e8b18e39831642c
7
+ data.tar.gz: b2aa35b82053ead843b6406e4f0087480684616d7352f832ef27c9dce9347899d4978a6b181f10cff64195dadbf9e2dc9a0e897130fdc1211bd56035feecf003
data/CHANGELOG_RB.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changelog
2
2
 
3
+ ## [9.4.6] - 2021-09-28
4
+
5
+ - Added channel linking events
6
+ - Added `canUserSeeConversationList` in the `web` integration
7
+ - Updated RESTeasy to the latest version
8
+
3
9
  ## [9.4.5] - 2021-08-23
4
10
 
5
11
  - Added page[before|after|size] query parameter constraints.
data/README.md CHANGED
@@ -5,7 +5,7 @@ SunshineConversationsClient - the Ruby gem for the Sunshine Conversations API
5
5
  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).
6
6
 
7
7
  - API version: 9.4.5
8
- - Package version: 9.4.5
8
+ - Package version: 9.4.6
9
9
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
10
10
 
11
11
  ## Sunshine Conversations API Version
@@ -32,16 +32,16 @@ gem build sunshine-conversations-client.gemspec
32
32
  Then either install the gem locally:
33
33
 
34
34
  ```shell
35
- gem install ./sunshine-conversations-client-9.4.5.gem
35
+ gem install ./sunshine-conversations-client-9.4.6.gem
36
36
  ```
37
37
 
38
- (for development, run `gem install --dev ./sunshine-conversations-client-9.4.5.gem` to install the development dependencies)
38
+ (for development, run `gem install --dev ./sunshine-conversations-client-9.4.6.gem` to install the development dependencies)
39
39
 
40
40
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
41
41
 
42
42
  Finally add this to the Gemfile:
43
43
 
44
- gem 'sunshine-conversations-client', '~> 9.4.5'
44
+ gem 'sunshine-conversations-client', '~> 9.4.6'
45
45
 
46
46
  ### Install from Git
47
47
 
@@ -237,11 +237,20 @@ Class | Method | HTTP request | Description
237
237
  - [SunshineConversationsClient::CarouselMessage](docs/CarouselMessage.md)
238
238
  - [SunshineConversationsClient::CarouselMessageDisplaySettings](docs/CarouselMessageDisplaySettings.md)
239
239
  - [SunshineConversationsClient::Client](docs/Client.md)
240
+ - [SunshineConversationsClient::ClientAddEvent](docs/ClientAddEvent.md)
241
+ - [SunshineConversationsClient::ClientAddEventAllOf](docs/ClientAddEventAllOf.md)
242
+ - [SunshineConversationsClient::ClientAddEventAllOfPayload](docs/ClientAddEventAllOfPayload.md)
240
243
  - [SunshineConversationsClient::ClientAssociation](docs/ClientAssociation.md)
241
244
  - [SunshineConversationsClient::ClientCreate](docs/ClientCreate.md)
242
245
  - [SunshineConversationsClient::ClientListResponse](docs/ClientListResponse.md)
246
+ - [SunshineConversationsClient::ClientRemoveEvent](docs/ClientRemoveEvent.md)
247
+ - [SunshineConversationsClient::ClientRemoveEventAllOf](docs/ClientRemoveEventAllOf.md)
248
+ - [SunshineConversationsClient::ClientRemoveEventAllOfPayload](docs/ClientRemoveEventAllOfPayload.md)
243
249
  - [SunshineConversationsClient::ClientResponse](docs/ClientResponse.md)
244
250
  - [SunshineConversationsClient::ClientType](docs/ClientType.md)
251
+ - [SunshineConversationsClient::ClientUpdateEvent](docs/ClientUpdateEvent.md)
252
+ - [SunshineConversationsClient::ClientUpdateEventAllOf](docs/ClientUpdateEventAllOf.md)
253
+ - [SunshineConversationsClient::ClientUpdateEventAllOfPayload](docs/ClientUpdateEventAllOfPayload.md)
245
254
  - [SunshineConversationsClient::Confirmation](docs/Confirmation.md)
246
255
  - [SunshineConversationsClient::Content](docs/Content.md)
247
256
  - [SunshineConversationsClient::Conversation](docs/Conversation.md)
@@ -431,6 +440,7 @@ Class | Method | HTTP request | Description
431
440
  - [SunshineConversationsClient::UserMergeEvent](docs/UserMergeEvent.md)
432
441
  - [SunshineConversationsClient::UserMergeEventAllOf](docs/UserMergeEventAllOf.md)
433
442
  - [SunshineConversationsClient::UserMergeEventAllOfPayload](docs/UserMergeEventAllOfPayload.md)
443
+ - [SunshineConversationsClient::UserMergeEventAllOfPayloadMergedClients](docs/UserMergeEventAllOfPayloadMergedClients.md)
434
444
  - [SunshineConversationsClient::UserMergeEventAllOfPayloadMergedConversations](docs/UserMergeEventAllOfPayloadMergedConversations.md)
435
445
  - [SunshineConversationsClient::UserMergeEventAllOfPayloadMergedUsers](docs/UserMergeEventAllOfPayloadMergedUsers.md)
436
446
  - [SunshineConversationsClient::UserResponse](docs/UserResponse.md)
@@ -0,0 +1,23 @@
1
+ # SunshineConversationsClient::ClientAddEvent
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional]
8
+ **type** | **String** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional]
9
+ **created_at** | **String** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional]
10
+ **payload** | [**ClientAddEventAllOfPayload**](ClientAddEventAllOfPayload.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SunshineConversationsClient'
16
+
17
+ instance = SunshineConversationsClient::ClientAddEvent.new(id: null,
18
+ type: null,
19
+ created_at: null,
20
+ payload: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::ClientAddEventAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **payload** | [**ClientAddEventAllOfPayload**](ClientAddEventAllOfPayload.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::ClientAddEventAllOf.new(payload: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,25 @@
1
+ # SunshineConversationsClient::ClientAddEventAllOfPayload
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation associated with the creation of the client. This field is only present when the reason is `channelLinking` and when attaching the client to a specific conversation. | [optional]
8
+ **user** | [**UserTruncated**](UserTruncated.md) | The user associated with the client. | [optional]
9
+ **client** | [**Client**](Client.md) | The client that was just created. | [optional]
10
+ **reason** | **String** | The reason for which the client was added. * `channelLinking` - The client was created as a result of initiating a channel link. * `sdkLogin` - The client was created as a result of logging into an SDK device. * `authCode` - The client was created as a result of initializing an SDK client with an `authCode`. | [optional]
11
+ **source** | [**SourceWebhook**](SourceWebhook.md) | The source where this event originated from. This could be the API or an SDK device. | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'SunshineConversationsClient'
17
+
18
+ instance = SunshineConversationsClient::ClientAddEventAllOfPayload.new(conversation: null,
19
+ user: null,
20
+ client: null,
21
+ reason: null,
22
+ source: null)
23
+ ```
24
+
25
+
@@ -0,0 +1,23 @@
1
+ # SunshineConversationsClient::ClientRemoveEvent
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional]
8
+ **type** | **String** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional]
9
+ **created_at** | **String** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional]
10
+ **payload** | [**ClientRemoveEventAllOfPayload**](ClientRemoveEventAllOfPayload.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SunshineConversationsClient'
16
+
17
+ instance = SunshineConversationsClient::ClientRemoveEvent.new(id: null,
18
+ type: null,
19
+ created_at: null,
20
+ payload: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::ClientRemoveEventAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **payload** | [**ClientRemoveEventAllOfPayload**](ClientRemoveEventAllOfPayload.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::ClientRemoveEventAllOf.new(payload: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,27 @@
1
+ # SunshineConversationsClient::ClientRemoveEventAllOfPayload
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation associated with the removal of the client. This field is only present when the reason is `theft`, `linkCancelled` or `linkFailed`. Note that for the `theft` reason, the conversation will not be present if it has been deleted. | [optional]
8
+ **user** | [**UserTruncated**](UserTruncated.md) | The user associated with the client. | [optional]
9
+ **client** | [**Client**](Client.md) | The removed client. | [optional]
10
+ **reason** | **String** | The reason for which the client was removed. * `api` - The client was removed using the API. * `linkCancelled` - The user cancelled a channel link. * `linkFailed` - The client was removed after a channel link attempt failed. * `sdk` - The client was removed using the SDK. * `theft` - The client was transferred to another user due to a channel link. | [optional]
11
+ **error** | [**Object**](.md) | Object containing details of what went wrong. This field will only be present when the reason is `linkCancelled` or `linkFailed`. | [optional]
12
+ **source** | [**SourceWebhook**](SourceWebhook.md) | The source where this event originated from. This could be the API or an SDK device. | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'SunshineConversationsClient'
18
+
19
+ instance = SunshineConversationsClient::ClientRemoveEventAllOfPayload.new(conversation: null,
20
+ user: null,
21
+ client: null,
22
+ reason: null,
23
+ error: null,
24
+ source: null)
25
+ ```
26
+
27
+
@@ -0,0 +1,23 @@
1
+ # SunshineConversationsClient::ClientUpdateEvent
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional]
8
+ **type** | **String** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional]
9
+ **created_at** | **String** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional]
10
+ **payload** | [**ClientUpdateEventAllOfPayload**](ClientUpdateEventAllOfPayload.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SunshineConversationsClient'
16
+
17
+ instance = SunshineConversationsClient::ClientUpdateEvent.new(id: null,
18
+ type: null,
19
+ created_at: null,
20
+ payload: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,17 @@
1
+ # SunshineConversationsClient::ClientUpdateEventAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **payload** | [**ClientUpdateEventAllOfPayload**](ClientUpdateEventAllOfPayload.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SunshineConversationsClient'
13
+
14
+ instance = SunshineConversationsClient::ClientUpdateEventAllOf.new(payload: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,23 @@
1
+ # SunshineConversationsClient::ClientUpdateEventAllOfPayload
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation which triggered a change in the client. | [optional]
8
+ **user** | [**UserTruncated**](UserTruncated.md) | The user associated with the client. | [optional]
9
+ **client** | [**Client**](Client.md) | The updated client. | [optional]
10
+ **reason** | **String** | The reason for which the client was updated. * `confirmed` - The client is now active and ready to use. * `blocked` - The user has unsubscribed from the conversation. * `matched` - The channel found a user that matches the information provided. | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SunshineConversationsClient'
16
+
17
+ instance = SunshineConversationsClient::ClientUpdateEventAllOfPayload.new(conversation: null,
18
+ user: null,
19
+ client: null,
20
+ reason: null)
21
+ ```
22
+
23
+
data/docs/InlineObject.md CHANGED
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **code** | **String** | The authorization code received via /oauth/authorize |
8
- **grant_type** | **String** | Must be set to authorization_code |
8
+ **grant_type** | **String** | Must be set to the string `authorization_code` |
9
9
  **client_id** | **String** | Your integration’s unique identifier |
10
10
  **client_secret** | **String** | Your integration’s secret |
11
11
 
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
15
15
  require 'SunshineConversationsClient'
16
16
 
17
17
  instance = SunshineConversationsClient::InlineObject.new(code: 658965,
18
- grant_type: 658965,
18
+ grant_type: authorization_code,
19
19
  client_id: 5e4af71a81966cfff3ef6550,
20
20
  client_secret: 5XJ85yjUtRcaQu_pDINblPZb)
21
21
  ```
data/docs/User.md CHANGED
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **id** | **String** | The unique ID of the user. | [optional]
8
- **external_id** | **String** | An optional ID that if specified can also be used to retrieve the user. | [optional]
8
+ **external_id** | **String** | An optional ID that can also be used to retrieve the user. | [optional]
9
9
  **signed_up_at** | **String** | | [optional]
10
10
  **profile** | [**Profile**](Profile.md) | | [optional]
11
11
  **metadata** | **Object** | | [optional]
@@ -6,7 +6,9 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **merged_users** | [**UserMergeEventAllOfPayloadMergedUsers**](UserMergeEventAllOfPayloadMergedUsers.md) | | [optional]
8
8
  **merged_conversations** | [**UserMergeEventAllOfPayloadMergedConversations**](UserMergeEventAllOfPayloadMergedConversations.md) | | [optional]
9
+ **merged_clients** | [**UserMergeEventAllOfPayloadMergedClients**](UserMergeEventAllOfPayloadMergedClients.md) | | [optional]
9
10
  **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]
11
+ **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]
10
12
 
11
13
  ## Code Sample
12
14
 
@@ -15,7 +17,9 @@ require 'SunshineConversationsClient'
15
17
 
16
18
  instance = SunshineConversationsClient::UserMergeEventAllOfPayload.new(merged_users: null,
17
19
  merged_conversations: null,
18
- discarded_metadata: null)
20
+ merged_clients: null,
21
+ discarded_metadata: null,
22
+ reason: null)
19
23
  ```
20
24
 
21
25
 
@@ -0,0 +1,19 @@
1
+ # SunshineConversationsClient::UserMergeEventAllOfPayloadMergedClients
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **surviving** | [**Client**](Client.md) | The client that already existed before the merge started. | [optional]
8
+ **discarded** | [**Client**](Client.md) | The pending client that was discarded during the merge event. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'SunshineConversationsClient'
14
+
15
+ instance = SunshineConversationsClient::UserMergeEventAllOfPayloadMergedClients.new(surviving: null,
16
+ discarded: null)
17
+ ```
18
+
19
+
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **id** | **String** | The unique ID of the user. | [optional]
8
- **external_id** | **String** | An optional ID that if specified can also be used to retrieve the user. | [optional]
8
+ **external_id** | **String** | An optional ID that can also be used to retrieve the user. | [optional]
9
9
 
10
10
  ## Code Sample
11
11
 
data/docs/Web.md CHANGED
@@ -5,21 +5,22 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **type** | **String** | To configure a Web Messenger integration, acquire the required information and call the Create Integration endpoint. | [optional] [default to 'web']
8
- **brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '65758e']
9
- **fixed_intro_pane** | **Boolean** | When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. | [optional] [default to false]
10
- **conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
11
- **action_color** | **String** | This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
12
- **display_style** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. | [optional] [default to 'button']
13
- **button_icon_url** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
14
- **button_width** | **String** | With the button style Web Messenger, you have the option of specifying the button width. | [optional] [default to '58']
15
- **button_height** | **String** | With the button style Web Messenger, you have the option of specifying the button height. | [optional] [default to '58']
16
- **integration_order** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed. | [optional]
8
+ **brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '65758e']
9
+ **fixed_intro_pane** | **Boolean** | When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. | [optional] [default to false]
10
+ **conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
11
+ **action_color** | **String** | This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
12
+ **display_style** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. | [optional] [default to 'button']
13
+ **button_icon_url** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
14
+ **button_width** | **String** | With the button style Web Messenger, you have the option of specifying the button width. | [optional] [default to '58']
15
+ **button_height** | **String** | With the button style Web Messenger, you have the option of specifying the button height. | [optional] [default to '58']
16
+ **integration_order** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed. | [optional]
17
17
  **business_name** | **String** | A custom business name for the Web Messenger. | [optional]
18
- **business_icon_url** | **String** | A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
19
- **background_image_url** | **String** | A background image url for the conversation. Image will be tiled to fit the window. | [optional]
18
+ **business_icon_url** | **String** | A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
19
+ **background_image_url** | **String** | A background image url for the conversation. Image will be tiled to fit the window. | [optional]
20
20
  **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]
21
- **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]
22
- **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional]
21
+ **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]
22
+ **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]
23
+ **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional]
23
24
 
24
25
  ## Code Sample
25
26
 
@@ -35,12 +36,13 @@ instance = SunshineConversationsClient::Web.new(type: null,
35
36
  button_icon_url: https://domain.com/images/avatar.png,
36
37
  button_width: null,
37
38
  button_height: null,
38
- integration_order: ["59fc8466260f48003505228b","59d79780481d34002b7d3617"],
39
+ integration_order: ["59fc8466260f48003505228b", "59d79780481d34002b7d3617"],
39
40
  business_name: Kent Shop,
40
41
  business_icon_url: https://www.gravatar.com/image.jpg,
41
42
  background_image_url: https://a-beautiful-tile.png,
42
- origin_whitelist: ["https://yourdomain.com"],
43
+ origin_whitelist: https://yourdomain.com,
43
44
  prechat_capture: null,
45
+ can_user_see_conversation_list: false,
44
46
  can_user_create_more_conversations: null)
45
47
  ```
46
48
 
data/docs/WebAllOf.md CHANGED
@@ -5,21 +5,22 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **type** | **String** | To configure a Web Messenger integration, acquire the required information and call the Create Integration endpoint. | [optional] [default to 'web']
8
- **brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '65758e']
9
- **fixed_intro_pane** | **Boolean** | When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. | [optional] [default to false]
10
- **conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
11
- **action_color** | **String** | This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
12
- **display_style** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. | [optional] [default to 'button']
13
- **button_icon_url** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
14
- **button_width** | **String** | With the button style Web Messenger, you have the option of specifying the button width. | [optional] [default to '58']
15
- **button_height** | **String** | With the button style Web Messenger, you have the option of specifying the button height. | [optional] [default to '58']
16
- **integration_order** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed. | [optional]
8
+ **brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '65758e']
9
+ **fixed_intro_pane** | **Boolean** | When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. | [optional] [default to false]
10
+ **conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
11
+ **action_color** | **String** | This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
12
+ **display_style** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. | [optional] [default to 'button']
13
+ **button_icon_url** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
14
+ **button_width** | **String** | With the button style Web Messenger, you have the option of specifying the button width. | [optional] [default to '58']
15
+ **button_height** | **String** | With the button style Web Messenger, you have the option of specifying the button height. | [optional] [default to '58']
16
+ **integration_order** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed. | [optional]
17
17
  **business_name** | **String** | A custom business name for the Web Messenger. | [optional]
18
- **business_icon_url** | **String** | A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
19
- **background_image_url** | **String** | A background image url for the conversation. Image will be tiled to fit the window. | [optional]
18
+ **business_icon_url** | **String** | A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. | [optional]
19
+ **background_image_url** | **String** | A background image url for the conversation. Image will be tiled to fit the window. | [optional]
20
20
  **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]
21
- **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]
22
- **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional]
21
+ **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]
22
+ **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]
23
+ **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional]
23
24
 
24
25
  ## Code Sample
25
26
 
@@ -35,12 +36,13 @@ instance = SunshineConversationsClient::WebAllOf.new(type: null,
35
36
  button_icon_url: https://domain.com/images/avatar.png,
36
37
  button_width: null,
37
38
  button_height: null,
38
- integration_order: ["59fc8466260f48003505228b","59d79780481d34002b7d3617"],
39
+ integration_order: ["59fc8466260f48003505228b", "59d79780481d34002b7d3617"],
39
40
  business_name: Kent Shop,
40
41
  business_icon_url: https://www.gravatar.com/image.jpg,
41
42
  background_image_url: https://a-beautiful-tile.png,
42
- origin_whitelist: ["https://yourdomain.com"],
43
+ origin_whitelist: https://yourdomain.com,
43
44
  prechat_capture: null,
45
+ can_user_see_conversation_list: false,
44
46
  can_user_create_more_conversations: null)
45
47
  ```
46
48