sunshine-conversations-client 14.1.0 → 14.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaf8b4c64f1df689fa46ae7904baa02f340b5754555442cf60e95d9514eb5743
-  data.tar.gz: 5b11c9e4826e893779743312a7eab59b23f0aaf2767c9f2af4f6c739402e05e2
+  metadata.gz: fd1bf065010f59c1d035554a990e21c2084e319e0554f24c7118dce5f99c7abc
+  data.tar.gz: 97aacf16b3cd6762b306728490083aeb2cf702f5e8bde79a68626a8deda07117
 SHA512:
-  metadata.gz: c40199f45418b25406b8e6c53282dbfa0044774c81ea6d4009d4c936ed00084ae8532fb81f11f297b1ca071c75d93646280e70fa6ff242d4a7e0658f7c5841df
-  data.tar.gz: 574975371db506734f73d3ccfa8ee2f3fe82d9cd70f72e707534badfc7443e719b8832ac34ceafa1bcea5ed1a305dbaed2487c0b6e19d1d5d1eb12472d5432f3
+  metadata.gz: cc75ca0051dabd0f89ea58ef2626ac77124ee529bcffa684f5650ef247ef4c111fdc2aee3eeca303994b2e4a610b1c1f976a9d7fda4259737949b6b80df974b5
+  data.tar.gz: 7ffa2fa4444741a3fa04146ee35446d13d25036630bc83210c7b95132065ef72dce48f5af1695f2ceb30376b4852defaa29358bebbeda686ec4f41365b53e35c

data/CHANGELOG_RB.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [14.3.0] - 2024-12-30
+
+### Added
+
+- Added new read-only `activity` property to [Messages](http://127.0.0.1:8081/#tag/Messages/operation/listMessages) to denote system activities.
+
+## [14.2.0] - 2024-12-11
+
+### Added
+
+- Added new `toBeRetained` property to [User](https://docs.smooch.io/rest/#tag/Users) and all relevant APIs. See [creating deletion schedules for bot-only conversations](https://support.zendesk.com/hc/en-us/articles/8499219792154) for more information.
+- Added `user:remove` [webhook event](https://docs.smooch.io/rest/#operation/eventWebhooks). This event fires when a user deleted.
+
 ## [14.1.0] - 2024-11-22
 
 ### 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: 14.1.0
-- Package version: 14.1.0
+- API version: 14.3.0
+- Package version: 14.3.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Sunshine Conversations API Version
@@ -32,16 +32,16 @@ gem build sunshine-conversations-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./sunshine-conversations-client-14.1.0.gem
+gem install ./sunshine-conversations-client-14.3.0.gem
 ```
 
-(for development, run `gem install --dev ./sunshine-conversations-client-14.1.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./sunshine-conversations-client-14.3.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'sunshine-conversations-client', '~> 14.1.0'
+    gem 'sunshine-conversations-client', '~> 14.3.0'
 
 ### Install from Git
 
@@ -204,6 +204,7 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::ActionSubset](docs/ActionSubset.md)
  - [SunshineConversationsClient::Activity](docs/Activity.md)
  - [SunshineConversationsClient::ActivityAllOf](docs/ActivityAllOf.md)
+ - [SunshineConversationsClient::ActivityMessage](docs/ActivityMessage.md)
  - [SunshineConversationsClient::ActivityPost](docs/ActivityPost.md)
  - [SunshineConversationsClient::ActivityPostAllOf](docs/ActivityPostAllOf.md)
  - [SunshineConversationsClient::ActivityTypes](docs/ActivityTypes.md)
@@ -450,6 +451,8 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::TelegramUpdate](docs/TelegramUpdate.md)
  - [SunshineConversationsClient::TemplateMessage](docs/TemplateMessage.md)
  - [SunshineConversationsClient::TextMessage](docs/TextMessage.md)
+ - [SunshineConversationsClient::TicketClosed](docs/TicketClosed.md)
+ - [SunshineConversationsClient::TransferToEmail](docs/TransferToEmail.md)
  - [SunshineConversationsClient::Twilio](docs/Twilio.md)
  - [SunshineConversationsClient::TwilioAllOf](docs/TwilioAllOf.md)
  - [SunshineConversationsClient::TwilioUpdate](docs/TwilioUpdate.md)
@@ -469,6 +472,9 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::UserMergeEventAllOfPayloadMergedClients](docs/UserMergeEventAllOfPayloadMergedClients.md)
  - [SunshineConversationsClient::UserMergeEventAllOfPayloadMergedConversations](docs/UserMergeEventAllOfPayloadMergedConversations.md)
  - [SunshineConversationsClient::UserMergeEventAllOfPayloadMergedUsers](docs/UserMergeEventAllOfPayloadMergedUsers.md)
+ - [SunshineConversationsClient::UserRemoveEvent](docs/UserRemoveEvent.md)
+ - [SunshineConversationsClient::UserRemoveEventAllOf](docs/UserRemoveEventAllOf.md)
+ - [SunshineConversationsClient::UserRemoveEventAllOfPayload](docs/UserRemoveEventAllOfPayload.md)
  - [SunshineConversationsClient::UserResponse](docs/UserResponse.md)
  - [SunshineConversationsClient::UserTruncated](docs/UserTruncated.md)
  - [SunshineConversationsClient::UserUpdateBody](docs/UserUpdateBody.md)

data/docs/ActivityMessage.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::ActivityMessage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of system activity that generated the message. The value of this field determines the dynamic content that is rendered to the end-user / agent when viewing this message. Each `type` value will have a set of pre-defined, localized strings that describe the activity. | [default to 'transferToEmail']
+**data** | [**Object**](.md) | No additional data is supplied with the \"transferToEmail\" activity type at this time. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ActivityMessage.new(type: null,
+                                 data: null)
+```
+
+

data/docs/Message.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **id** | **String** | The unique ID of the message. | [optional] 
 **received** | **String** | A datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing when Sunshine Conversations received the message. | [optional] 
 **author** | [**Author**](Author.md) |  | [optional] 
+**activity** | [**ActivityMessage**](ActivityMessage.md) | Details of the system activity that generated this message. This field is used when actions taken by the system generate a persisted message to notify the user or agent of an event that occurred. For example, when a user's Ticket gets closed. This property applies only to informational text messages generated via system events. | [optional] 
 **content** | [**Content**](Content.md) | The content of the message. | [optional] 
 **source** | [**Source**](Source.md) |  | [optional] 
 **quoted_message** | [**QuotedMessage**](QuotedMessage.md) | The quoted message is currently only available for WhatsApp and Web Messenger `formResponse` messages. | [optional] 
@@ -21,6 +22,7 @@ require 'SunshineConversationsClient'
 instance = SunshineConversationsClient::Message.new(id: 5e552ef595e5206375bb835d,
                                  received: 2019-03-21T18:48:52.760Z,
                                  author: null,
+                                 activity: null,
                                  content: null,
                                  source: null,
                                  quoted_message: null,

data/docs/TicketClosed.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::TicketClosed
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of system activity that generated the message. The value of this field determines the dynamic content that is rendered to the end-user / agent when viewing this message. Each `type` value will have a set of pre-defined, localized strings that describe the activity. | [default to 'ticketClosed']
+**data** | [**Object**](.md) | No additional data is supplied with the \"ticketClosed\" activity type at this time. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::TicketClosed.new(type: null,
+                                 data: null)
+```
+
+

data/docs/TransferToEmail.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::TransferToEmail
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of system activity that generated the message. The value of this field determines the dynamic content that is rendered to the end-user / agent when viewing this message. Each `type` value will have a set of pre-defined, localized strings that describe the activity. | [default to 'transferToEmail']
+**data** | [**Object**](.md) | No additional data is supplied with the \"transferToEmail\" activity type at this time. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::TransferToEmail.new(type: null,
+                                 data: null)
+```
+
+

data/docs/User.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **id** | **String** | The unique ID of the user. | [optional] 
 **external_id** | **String** | An optional ID that can also be used to retrieve the user.  | [optional] 
 **signed_up_at** | **String** |  | [optional] 
+**to_be_retained** | **Boolean** |  | [optional] 
 **profile** | [**Profile**](Profile.md) |  | [optional] 
 **metadata** | **Object** |  | [optional] 
 **identities** | [**Array<Identity>**](Identity.md) | The user's connected identities. | [optional] [readonly] 
@@ -19,6 +20,7 @@ require 'SunshineConversationsClient'
 instance = SunshineConversationsClient::User.new(id: 7494535bff5cef41a15be74d,
                                  external_id: your-own-id,
                                  signed_up_at: null,
+                                 to_be_retained: null,
                                  profile: null,
                                  metadata: null,
                                  identities: null)

data/docs/UserAllOf.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **signed_up_at** | **String** |  | [optional] 
+**to_be_retained** | **Boolean** |  | [optional] 
 **profile** | [**Profile**](Profile.md) |  | [optional] 
 **metadata** | **Object** |  | [optional] 
 **identities** | [**Array<Identity>**](Identity.md) | The user's connected identities. | [optional] [readonly] 
@@ -15,6 +16,7 @@ Name | Type | Description | Notes
 require 'SunshineConversationsClient'
 
 instance = SunshineConversationsClient::UserAllOf.new(signed_up_at: null,
+                                 to_be_retained: null,
                                  profile: null,
                                  metadata: null,
                                  identities: null)

data/docs/UserCreateBody.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **external_id** | **String** | A unique identifier for the user. The `externalId` can be used to link a user to the same conversation [across multiple devices](https://docs.smooch.io/guide/authenticating-users/).  | 
 **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] 
 
@@ -16,6 +17,7 @@ require 'SunshineConversationsClient'
 
 instance = SunshineConversationsClient::UserCreateBody.new(external_id: your-own-id,
                                  signed_up_at: 2020-05-21T15:53:30.197Z,
+                                 to_be_retained: null,
                                  profile: null,
                                  metadata: {"lang":"en-ca"})
 ```

data/docs/UserRemoveEvent.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::UserRemoveEvent
+
+## 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** | [**UserRemoveEventAllOfPayload**](UserRemoveEventAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::UserRemoveEvent.new(id: null,
+                                 type: null,
+                                 created_at: null,
+                                 payload: null)
+```
+
+

data/docs/UserRemoveEventAllOf.md

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

data/docs/UserRemoveEventAllOfPayload.md

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

data/docs/UserUpdateBody.md

@@ -5,6 +5,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] 
 
@@ -14,6 +15,7 @@ Name | Type | Description | Notes
 require 'SunshineConversationsClient'
 
 instance = SunshineConversationsClient::UserUpdateBody.new(signed_up_at: null,
+                                 to_be_retained: null,
                                  profile: null,
                                  metadata: {"lang":"en-ca"})
 ```

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data/lib/sunshine-conversations-client/api_client.rb

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

data/lib/sunshine-conversations-client/api_error.rb

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

data/lib/sunshine-conversations-client/configuration.rb

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

data/lib/sunshine-conversations-client/models/accept_control_body.rb

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

data/lib/sunshine-conversations-client/models/action.rb

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

data/lib/sunshine-conversations-client/models/action_subset.rb

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

data/lib/sunshine-conversations-client/models/activity.rb

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

data/lib/sunshine-conversations-client/models/activity_all_of.rb

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