sunshine-conversations-client 9.3.0 → 9.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 719ee3f61c4c444a0264a8b38dcdd86043b8e547
-  data.tar.gz: 5e6800f451b323f3807b7063980b16e5ff462707
+  metadata.gz: b31d37f8852617bf2fc7401cc8e7c71d54cf70cc
+  data.tar.gz: 945665254f60b6ead48d90b88ef5e8d40a5cd821
 SHA512:
-  metadata.gz: 73d603d369751e44491edc9d28003c4952ed77537544494d54d4eb2bdefb7a90d8857c9d39e2d1a35a23d73f4015f3dd39cc83c42b2eb79d318fb00c42d9adf4
-  data.tar.gz: 40ec79344a1f876fd5d13d96c1c967493539baac5706a75d243b591137beb636da0e3a16ab0ce25f54464f3ec9667425f7f180f1a357576b94a76515347c46f1
+  metadata.gz: a6d3e297d15ac44d729213f5c246bd4151b2b799445033817e2fb8a3527ba7bcbf50147e6a5017a43e18cdc96a4add00b7faafc84875b4b48a5c13df4c3c6020
+  data.tar.gz: aa1eababc18d45cae7444b1dd5b08713173bf9c69a83e9fee49da2aa885811a59aa0de53a6d2c7158973a2f9fbbb3f59d753b98aebbaac43c0bfed6a1c3289f4

data/CHANGELOG_RB.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [9.4.0] - 2020-12-15
+
+### Added
+
+- Added a new user profile field `locale`.
+
 ## [9.3.0] - 2020-11-18
 
 ### Added

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: 9.3.0
-- Package version: 9.3.0
+- API version: 9.4.0
+- Package version: 9.4.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-9.3.0.gem
+gem install ./sunshine-conversations-client-9.4.0.gem
 ```
 
-(for development, run `gem install --dev ./sunshine-conversations-client-9.3.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./sunshine-conversations-client-9.4.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', '~> 9.3.0'
+    gem 'sunshine-conversations-client', '~> 9.4.0'
 
 ### Install from Git
 
@@ -250,6 +250,12 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::ConversationCreateEvent](docs/ConversationCreateEvent.md)
  - [SunshineConversationsClient::ConversationCreateEventAllOf](docs/ConversationCreateEventAllOf.md)
  - [SunshineConversationsClient::ConversationCreateEventAllOfPayload](docs/ConversationCreateEventAllOfPayload.md)
+ - [SunshineConversationsClient::ConversationJoinEvent](docs/ConversationJoinEvent.md)
+ - [SunshineConversationsClient::ConversationJoinEventAllOf](docs/ConversationJoinEventAllOf.md)
+ - [SunshineConversationsClient::ConversationJoinEventAllOfPayload](docs/ConversationJoinEventAllOfPayload.md)
+ - [SunshineConversationsClient::ConversationLeaveEvent](docs/ConversationLeaveEvent.md)
+ - [SunshineConversationsClient::ConversationLeaveEventAllOf](docs/ConversationLeaveEventAllOf.md)
+ - [SunshineConversationsClient::ConversationLeaveEventAllOfPayload](docs/ConversationLeaveEventAllOfPayload.md)
  - [SunshineConversationsClient::ConversationListFilter](docs/ConversationListFilter.md)
  - [SunshineConversationsClient::ConversationListResponse](docs/ConversationListResponse.md)
  - [SunshineConversationsClient::ConversationMessageDeliveryChannelEvent](docs/ConversationMessageDeliveryChannelEvent.md)
@@ -270,6 +276,9 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::ConversationReadEvent](docs/ConversationReadEvent.md)
  - [SunshineConversationsClient::ConversationReadEventAllOf](docs/ConversationReadEventAllOf.md)
  - [SunshineConversationsClient::ConversationReadEventAllOfPayload](docs/ConversationReadEventAllOfPayload.md)
+ - [SunshineConversationsClient::ConversationRemoveEvent](docs/ConversationRemoveEvent.md)
+ - [SunshineConversationsClient::ConversationRemoveEventAllOf](docs/ConversationRemoveEventAllOf.md)
+ - [SunshineConversationsClient::ConversationRemoveEventAllOfPayload](docs/ConversationRemoveEventAllOfPayload.md)
  - [SunshineConversationsClient::ConversationResponse](docs/ConversationResponse.md)
  - [SunshineConversationsClient::ConversationTruncated](docs/ConversationTruncated.md)
  - [SunshineConversationsClient::ConversationType](docs/ConversationType.md)

data/docs/ConversationJoinEvent.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::ConversationJoinEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**type** | **String** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 
+**created_at** | **String** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 
+**payload** | [**ConversationJoinEventAllOfPayload**](ConversationJoinEventAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationJoinEvent.new(id: null,
+                                 type: null,
+                                 created_at: null,
+                                 payload: null)
+```
+
+

data/docs/ConversationJoinEventAllOf.md

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

data/docs/ConversationJoinEventAllOfPayload.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::ConversationJoinEventAllOfPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation in which the user was added. | [optional] 
+**user** | [**UserTruncated**](UserTruncated.md) | The user that joined the conversation. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationJoinEventAllOfPayload.new(conversation: null,
+                                 user: null)
+```
+
+

data/docs/ConversationLeaveEvent.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::ConversationLeaveEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**type** | **String** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 
+**created_at** | **String** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 
+**payload** | [**ConversationLeaveEventAllOfPayload**](ConversationLeaveEventAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationLeaveEvent.new(id: null,
+                                 type: null,
+                                 created_at: null,
+                                 payload: null)
+```
+
+

data/docs/ConversationLeaveEventAllOf.md

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

data/docs/ConversationLeaveEventAllOfPayload.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::ConversationLeaveEventAllOfPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation in which the user was removed. | [optional] 
+**user** | [**UserTruncated**](UserTruncated.md) | The user that left the conversation. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationLeaveEventAllOfPayload.new(conversation: null,
+                                 user: null)
+```
+
+

data/docs/ConversationRemoveEvent.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::ConversationRemoveEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**type** | **String** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 
+**created_at** | **String** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 
+**payload** | [**ConversationRemoveEventAllOfPayload**](ConversationRemoveEventAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationRemoveEvent.new(id: null,
+                                 type: null,
+                                 created_at: null,
+                                 payload: null)
+```
+
+

data/docs/ConversationRemoveEventAllOf.md

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

data/docs/ConversationRemoveEventAllOfPayload.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::ConversationRemoveEventAllOfPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation that was deleted. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationRemoveEventAllOfPayload.new(conversation: null)
+```
+
+

data/docs/Destination.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **integration_id** | **String** | The id of the integration to deliver the message to. Will return an error if the integration does not exist or if the user does not have a client for the integration attached to the conversation.  | [optional] 
-**integration_type** | **String** | The type of the integration to deliver the message to. Will return an error if the user does not have a client of that type attached to the conversation.  | [optional] 
+**integration_type** | **String** | The type of the integration to deliver the message to. Can be set to `none` if sending a [silent message](https://docs.smooch.io/guide/sending-messages/#silent-messages). Will return an error if the user does not have a client of that type attached to the conversation.  | [optional] 
 
 ## Code Sample
 

data/docs/IntegrationType.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**integration_type** | **String** | The type of the integration to deliver the message to. Will return an error if the user does not have a client of that type attached to the conversation.  | [optional] 
+**integration_type** | **String** | The type of the integration to deliver the message to. Can be set to `none` if sending a [silent message](https://docs.smooch.io/guide/sending-messages/#silent-messages). Will return an error if the user does not have a client of that type attached to the conversation.  | [optional] 
 
 ## Code Sample
 

data/docs/Profile.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **surname** | **String** | The user's surname (last name). | [optional] 
 **email** | **String** | The user's email address. | [optional] 
 **avatar_url** | **String** | The user's avatar. | [optional] 
+**locale** | **String** | End-user's locale information in BCP 47 format. | [optional] 
 
 ## Code Sample
 
@@ -17,7 +18,8 @@ require 'SunshineConversationsClient'
 instance = SunshineConversationsClient::Profile.new(given_name: Jane,
                                  surname: Doe,
                                  email: jane.doe@gmail.com,
-                                 avatar_url: https://s3.amazonaws.com/avatar.jpg)
+                                 avatar_url: https://s3.amazonaws.com/avatar.jpg,
+                                 locale: fr-CA)
 ```
 
 

data/docs/Webhook.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **id** | **String** | A unique identifier for the webhook. | [optional] [readonly] 
 **version** | **String** | Schema version of the payload delivered to this webhook. Can be `v1`, `v1.1` or `v2`. | [optional] [readonly] 
 **target** | **String** | URL to be called when the webhook is triggered. | 
-**triggers** | **Array<String>** | An array of triggers the integration is subscribed to. This property is case sensitive. Current supported triggers in v2 are `conversation:create`, `conversation:message:delivery:channel`, `conversation:message:delivery:failure`, `conversation:message:delivery:user`, `conversation:message`, `conversation:read`, `conversation:typing`, `conversation:postback`, and `user:merge` | 
+**triggers** | **Array<String>** | An array of triggers the integration is subscribed to. This property is case sensitive. [More details](https://docs.smooch.io/rest/#section/Webhook-Triggers). | 
 **secret** | **String** | Webhook secret, used to verify the origin of incoming requests. | [optional] 
 **include_full_user** | **Boolean** | A boolean specifying whether webhook payloads should include the complete user schema for events involving a specific user. | [optional] [default to false]
 **include_full_source** | **Boolean** | A boolean specifying whether webhook payloads should include the client and device object (when applicable). | [optional] [default to false]

data/docs/WebhookBody.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **target** | **String** | URL to be called when the webhook is triggered. | [optional] 
-**triggers** | **Array<String>** | An array of triggers the integration is subscribed to. This property is case sensitive. Current supported triggers in v2 are `conversation:create`, `conversation:message:delivery:channel`, `conversation:message:delivery:failure`, `conversation:message:delivery:user`, `conversation:message`, `conversation:read`, `conversation:typing`, `conversation:postback`, and `user:merge` | [optional] 
+**triggers** | **Array<String>** | An array of triggers the integration is subscribed to. This property is case sensitive. [More details](https://docs.smooch.io/rest/#section/Webhook-Triggers). | [optional] 
 **include_full_user** | **Boolean** | A boolean specifying whether webhook payloads should include the complete user schema for events involving a specific user. | [optional] [default to false]
 **include_full_source** | **Boolean** | A boolean specifying whether webhook payloads should include the client and device object (when applicable). | [optional] [default to false]
 

data/lib/sunshine-conversations-client.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.3.0
+The version of the OpenAPI document: 9.4.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -77,6 +77,12 @@ require 'sunshine-conversations-client/models/conversation_create_body'
 require 'sunshine-conversations-client/models/conversation_create_event'
 require 'sunshine-conversations-client/models/conversation_create_event_all_of'
 require 'sunshine-conversations-client/models/conversation_create_event_all_of_payload'
+require 'sunshine-conversations-client/models/conversation_join_event'
+require 'sunshine-conversations-client/models/conversation_join_event_all_of'
+require 'sunshine-conversations-client/models/conversation_join_event_all_of_payload'
+require 'sunshine-conversations-client/models/conversation_leave_event'
+require 'sunshine-conversations-client/models/conversation_leave_event_all_of'
+require 'sunshine-conversations-client/models/conversation_leave_event_all_of_payload'
 require 'sunshine-conversations-client/models/conversation_list_filter'
 require 'sunshine-conversations-client/models/conversation_list_response'
 require 'sunshine-conversations-client/models/conversation_message_delivery_channel_event'
@@ -97,6 +103,9 @@ require 'sunshine-conversations-client/models/conversation_postback_event_all_of
 require 'sunshine-conversations-client/models/conversation_read_event'
 require 'sunshine-conversations-client/models/conversation_read_event_all_of'
 require 'sunshine-conversations-client/models/conversation_read_event_all_of_payload'
+require 'sunshine-conversations-client/models/conversation_remove_event'
+require 'sunshine-conversations-client/models/conversation_remove_event_all_of'
+require 'sunshine-conversations-client/models/conversation_remove_event_all_of_payload'
 require 'sunshine-conversations-client/models/conversation_response'
 require 'sunshine-conversations-client/models/conversation_truncated'
 require 'sunshine-conversations-client/models/conversation_type'

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

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.3.0
+The version of the OpenAPI document: 9.4.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: 9.3.0
+The version of the OpenAPI document: 9.4.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: 9.3.0
+The version of the OpenAPI document: 9.4.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: 9.3.0
+The version of the OpenAPI document: 9.4.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: 9.3.0
+The version of the OpenAPI document: 9.4.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: 9.3.0
+The version of the OpenAPI document: 9.4.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

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: 9.3.0
+The version of the OpenAPI document: 9.4.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

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

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

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

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