sunshine-conversations-client 15.5.1 → 16.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8dc6044d02bc648be675c74b45ee17f5ca895289e496400cd84c6a0f625b609
-  data.tar.gz: b9d81a451b842d55360210285defe885005017526aae1284b37de340cb07106b
+  metadata.gz: 927645a50a807dc8bb2597ceeaa136889fa2e3d0776d0610be3593b2c843f367
+  data.tar.gz: 3b66717f291b19bea8184c1de2ec19cf2450fce7f6354f4622cac4a192bb8daf
 SHA512:
-  metadata.gz: 2e7acc67c4003b4462d74d5221990566a4b452af5fa5fc3d095816a96fbe3b05be59597598f54f507cba512a0e0d17924f26dd2f110e0a94cde178fdc55cd558
-  data.tar.gz: e1244ccbfa2628eb27736e528db9464e2b27be193486ef3c93eb3f9db62fb95bd1df89aa926dd2204bb99198a2b2ae3a9912b8c30c259faa3785ff6662585e04
+  metadata.gz: '038cf24bd64306d110005d9aa2ac63e9fabcf96417819ef2c575cf9cc219d72a32b7e84faaea93fbbcd4d946e4bd11158b912aa34ad4f3514a7cb89525fb0b5e'
+  data.tar.gz: 4a6a2ca5b018a50e0fd40a5f8f19d0a20582536e63be3bacceeaab7442b8764b9d6e23281a2843c0003289216fc79d8fc7273c7917c87f9818f203a980055623

data/CHANGELOG_RB.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [15.6.0] - 2025-07-24
+
+- Added [conversion events](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/conversation-referrals/#conversion-events) API.
+- Added `reason` field to `switchboard:passControl` and `switchboard:releaseControl` webhook events.
+- Updated various links in documentation.
+
+## [15.5.2] - 2025-07-08
+
+- Added release control in the webhook and webhook event documentation.
+
 ## [15.5.1] - 2025-06-02
 
 - Fix various docs links
@@ -252,7 +262,7 @@
 
 ## [9.12.0] - 2022-08-30
 
-- The Switchboard `passControl` action is now idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://docs.smooch.io/guide/oauth/#redirect-and-acquiring-an-oauth-token) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded.
+- The Switchboard `passControl` action is now idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://developer.zendesk.com/documentation/conversations/how-to-guides/building-a-marketplace-bot/) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded.
 - For more information, see [Switchboard passControl](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#pass-control).
 
 ## [9.11.0] - 2022-07-28

data/README.md

@@ -4,18 +4,18 @@ 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: 15.5.1
-- Package version: 15.5.1
+- API version: 15.6.0
+- Package version: 16.0.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Sunshine Conversations API Version
 
-The Sunshine Conversations API offers multiple [versions](https://docs.smooch.io/guide/versioning/). Each release of this project targets one and only one Sunshine Conversations API version. If you depend on an older version of the Sunshine Conversations API, you may need to use an older release of this library. Use the table below as your guide:
+The Sunshine Conversations API offers multiple [versions](https://developer.zendesk.com/documentation/conversations/references/api-versioning/). Each release of this project targets one and only one Sunshine Conversations API version. If you depend on an older version of the Sunshine Conversations API, you may need to use an older release of this library. Use the table below as your guide:
 
 | Sunshine Conversations API version | `zendesk/sunshine-conversations-ruby` version to use |
 |--------------------|--------------------------------|
-| `v2` [Implementation guide](https://docs.smooch.io/guide/multi-party-conversations/#implementation-guide/) | `9.*` or newer      |
-| `v1.1` [Upgrade guide](https://docs.smooch.io/guide/versioning/#upgrading-to-v11-from-v1) | `4.0.0` or newer      |
+| `v2` [Upgrade guide](https://developer.zendesk.com/documentation/conversations/references/api-versioning/#upgrading-from-v11-to-v2) | `9.*` or newer      |
+| `v1.1` [Upgrade guide](https://developer.zendesk.com/documentation/conversations/references/api-versioning/#upgrading-from-v1-to-v11) | `4.0.0` or newer      |
 | `v1`               | `3.*` or older                 |
 
 
@@ -32,16 +32,16 @@ gem build sunshine-conversations-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./sunshine-conversations-client-15.5.1.gem
+gem install ./sunshine-conversations-client-16.0.0.gem
 ```
 
-(for development, run `gem install --dev ./sunshine-conversations-client-15.5.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./sunshine-conversations-client-16.0.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'sunshine-conversations-client', '~> 15.5.1'
+    gem 'sunshine-conversations-client', '~> 16.0.0'
 
 ### Install from Git
 
@@ -151,6 +151,7 @@ Class | Method | HTTP request | Description
 *SunshineConversationsClient::ConversationsApi* | [**download_message_ref**](docs/ConversationsApi.md#download_message_ref) | **POST** /v2/apps/{appId}/conversations/{conversationId}/download | Download Message Ref
 *SunshineConversationsClient::ConversationsApi* | [**get_conversation**](docs/ConversationsApi.md#get_conversation) | **GET** /v2/apps/{appId}/conversations/{conversationId} | Get Conversation
 *SunshineConversationsClient::ConversationsApi* | [**list_conversations**](docs/ConversationsApi.md#list_conversations) | **GET** /v2/apps/{appId}/conversations | List Conversations
+*SunshineConversationsClient::ConversationsApi* | [**post_conversion_events**](docs/ConversationsApi.md#post_conversion_events) | **POST** /v2/apps/{appId}/conversations/{conversationId}/conversionEvents | Post Conversion Events
 *SunshineConversationsClient::ConversationsApi* | [**update_conversation**](docs/ConversationsApi.md#update_conversation) | **PATCH** /v2/apps/{appId}/conversations/{conversationId} | Update Conversation
 *SunshineConversationsClient::CustomIntegrationApiKeysApi* | [**create_custom_integration_key**](docs/CustomIntegrationApiKeysApi.md#create_custom_integration_key) | **POST** /v2/apps/{appId}/integrations/{integrationId}/keys | Create Integration Key
 *SunshineConversationsClient::CustomIntegrationApiKeysApi* | [**delete_custom_integration_key**](docs/CustomIntegrationApiKeysApi.md#delete_custom_integration_key) | **DELETE** /v2/apps/{appId}/integrations/{integrationId}/keys/{keyId} | Delete Integration Key
@@ -304,6 +305,7 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::ConversationTypingEventAllOf](docs/ConversationTypingEventAllOf.md)
  - [SunshineConversationsClient::ConversationTypingEventAllOfPayload](docs/ConversationTypingEventAllOfPayload.md)
  - [SunshineConversationsClient::ConversationUpdateBody](docs/ConversationUpdateBody.md)
+ - [SunshineConversationsClient::ConversionEventsBody](docs/ConversionEventsBody.md)
  - [SunshineConversationsClient::Custom](docs/Custom.md)
  - [SunshineConversationsClient::CustomAllOf](docs/CustomAllOf.md)
  - [SunshineConversationsClient::CustomUpdate](docs/CustomUpdate.md)
@@ -336,6 +338,7 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::InlineObject](docs/InlineObject.md)
  - [SunshineConversationsClient::Instagram](docs/Instagram.md)
  - [SunshineConversationsClient::InstagramAllOf](docs/InstagramAllOf.md)
+ - [SunshineConversationsClient::InstagramConversionEventsBody](docs/InstagramConversionEventsBody.md)
  - [SunshineConversationsClient::InstagramUpdate](docs/InstagramUpdate.md)
  - [SunshineConversationsClient::InstagramUpdateAllOf](docs/InstagramUpdateAllOf.md)
  - [SunshineConversationsClient::Integration](docs/Integration.md)
@@ -394,8 +397,11 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::MessagebirdAllOf](docs/MessagebirdAllOf.md)
  - [SunshineConversationsClient::Messenger](docs/Messenger.md)
  - [SunshineConversationsClient::MessengerAllOf](docs/MessengerAllOf.md)
+ - [SunshineConversationsClient::MessengerConversionEventsBody](docs/MessengerConversionEventsBody.md)
  - [SunshineConversationsClient::MessengerUpdate](docs/MessengerUpdate.md)
  - [SunshineConversationsClient::Meta](docs/Meta.md)
+ - [SunshineConversationsClient::MetaConversionEvent](docs/MetaConversionEvent.md)
+ - [SunshineConversationsClient::MetaConversionEventPayload](docs/MetaConversionEventPayload.md)
  - [SunshineConversationsClient::OfferControlBody](docs/OfferControlBody.md)
  - [SunshineConversationsClient::Page](docs/Page.md)
  - [SunshineConversationsClient::Participant](docs/Participant.md)
@@ -448,6 +454,9 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::SwitchboardPassControlAllOf](docs/SwitchboardPassControlAllOf.md)
  - [SunshineConversationsClient::SwitchboardPassControlAllOfPayload](docs/SwitchboardPassControlAllOfPayload.md)
  - [SunshineConversationsClient::SwitchboardPassControlFailure](docs/SwitchboardPassControlFailure.md)
+ - [SunshineConversationsClient::SwitchboardReleaseControl](docs/SwitchboardReleaseControl.md)
+ - [SunshineConversationsClient::SwitchboardReleaseControlAllOf](docs/SwitchboardReleaseControlAllOf.md)
+ - [SunshineConversationsClient::SwitchboardReleaseControlAllOfPayload](docs/SwitchboardReleaseControlAllOfPayload.md)
  - [SunshineConversationsClient::SwitchboardResponse](docs/SwitchboardResponse.md)
  - [SunshineConversationsClient::SwitchboardUpdateBody](docs/SwitchboardUpdateBody.md)
  - [SunshineConversationsClient::SyncUserBody](docs/SyncUserBody.md)
@@ -501,6 +510,7 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::WebhookResponse](docs/WebhookResponse.md)
  - [SunshineConversationsClient::WebhookSubSchema](docs/WebhookSubSchema.md)
  - [SunshineConversationsClient::Webview](docs/Webview.md)
+ - [SunshineConversationsClient::WhatsAppConversionEventsBody](docs/WhatsAppConversionEventsBody.md)
  - [SunshineConversationsClient::WhatsAppUpdate](docs/WhatsAppUpdate.md)
  - [SunshineConversationsClient::WhatsAppUpdateAllOf](docs/WhatsAppUpdateAllOf.md)
  - [SunshineConversationsClient::Whatsapp](docs/Whatsapp.md)

data/docs/AttachmentsApi.md

@@ -75,7 +75,7 @@ Name | Type | Description  | Notes
 
 Upload Attachment
 
-Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://docs.smooch.io/guide/validating-files\">file validation</a> guide for more details.</aside> 
+Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://support.zendesk.com/hc/en-us/articles/8435939957914#topic_v1r_rwr_mdc\">file validation</a> guide for more details.</aside> 
 
 ### Example
 

data/docs/Content.md

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
 **text_fallback** | **String** | A string containing the `label: value` of all fields, each separated by a newline character. | [optional] [readonly] 
 **coordinates** | [**LocationMessageCoordinates**](LocationMessageCoordinates.md) |  | 
 **location** | [**LocationMessageLocation**](LocationMessageLocation.md) |  | [optional] 
-**template** | [**Object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://docs.smooch.io/guide/whatsapp#sending-message-templates). `schema` must be set to `whatsapp`. | 
+**template** | [**Object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/message-overrides/#template-messages). `schema` must be set to `whatsapp`. | 
 
 ## Code Sample
 

data/docs/ConversationsApi.md

@@ -9,6 +9,7 @@ Method | HTTP request | Description
 [**download_message_ref**](ConversationsApi.md#download_message_ref) | **POST** /v2/apps/{appId}/conversations/{conversationId}/download | Download Message Ref
 [**get_conversation**](ConversationsApi.md#get_conversation) | **GET** /v2/apps/{appId}/conversations/{conversationId} | Get Conversation
 [**list_conversations**](ConversationsApi.md#list_conversations) | **GET** /v2/apps/{appId}/conversations | List Conversations
+[**post_conversion_events**](ConversationsApi.md#post_conversion_events) | **POST** /v2/apps/{appId}/conversations/{conversationId}/conversionEvents | Post Conversion Events
 [**update_conversation**](ConversationsApi.md#update_conversation) | **PATCH** /v2/apps/{appId}/conversations/{conversationId} | Update Conversation
 
 
@@ -319,6 +320,68 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## post_conversion_events
+
+> Hash<String, Object> post_conversion_events(app_id, conversation_id, conversion_events_body)
+
+Post Conversion Events
+
+This API can be used to track your end user's interactions with third party channels.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::ConversationsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+conversion_events_body = {"instagram":{"payload":{"data":[{"action_source":"business_messaging","event_name":"TestEvent","event_time":1752161233,"messaging_channel":"instagram"}]}}} # ConversionEventsBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Post Conversion Events
+  result = api_instance.post_conversion_events(app_id, conversation_id, conversion_events_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ConversationsApi->post_conversion_events: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+ **conversion_events_body** | [**ConversionEventsBody**](ConversionEventsBody.md)|  | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## update_conversation
 
 > ConversationResponse update_conversation(app_id, conversation_id, conversation_update_body)

data/docs/ConversionEventsBody.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::ConversionEventsBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messenger** | [**MetaConversionEvent**](MetaConversionEvent.md) |  | [optional] 
+**instagram** | [**MetaConversionEvent**](MetaConversionEvent.md) |  | [optional] 
+**whatsapp** | [**MetaConversionEvent**](MetaConversionEvent.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversionEventsBody.new(messenger: null,
+                                 instagram: null,
+                                 whatsapp: null)
+```
+
+

data/docs/InstagramConversionEventsBody.md

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

data/docs/MessagePost.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **destination** | [**Destination**](Destination.md) |  | [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] 
+**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://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/message-overrides/#template-messages).  | [optional] 
 
 ## Code Sample
 

data/docs/MessengerConversionEventsBody.md

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

data/docs/MetaConversionEvent.md

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

data/docs/MetaConversionEventPayload.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::MetaConversionEventPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **Array<Object>** | The array of conversion events to be sent to Meta's conversion events API. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MetaConversionEventPayload.new(data: null)
+```
+
+

data/docs/SwitchboardActionsApi.md

@@ -141,7 +141,7 @@ Name | Type | Description  | Notes
 
 Pass Control
 
-The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://docs.smooch.io/guide/oauth/#redirect-and-acquiring-an-oauth-token) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded. For more information, see [Switchboard passControl](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#pass-control).
+The passControl action marks the named switchboard integration as active and transitions all the other switchboard integrations to standby status. The `passControl` action is idempotent if either the target `switchboardIntegration` is specified explicitly by its `id` or `name`, or the `next` keyword is used for the `switchboardIntegration` field, and the invoking integration can be identified by its [OAuth token](https://developer.zendesk.com/documentation/conversations/how-to-guides/building-a-marketplace-bot/) or [Custom Integration API Key](https://docs.smooch.io/rest/#tag/CustomIntegrationApiKeys) credentials. Duplicate passControl actions using the `next` keyword and their metadata are disregarded. For more information, see [Switchboard passControl](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#pass-control).
 
 ### Example
 

data/docs/SwitchboardPassControlAllOfPayload.md

@@ -6,6 +6,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** | **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] 
+**reason** | **String** | Reason for the pass control action, if applicable. | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'SunshineConversationsClient'
 
 instance = SunshineConversationsClient::SwitchboardPassControlAllOfPayload.new(conversation: null,
-                                 metadata: {"lang":"en-ca"})
+                                 metadata: {"lang":"en-ca"},
+                                 reason: null)
 ```
 
 

data/docs/SwitchboardReleaseControl.md

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

data/docs/SwitchboardReleaseControlAllOf.md

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

data/docs/SwitchboardReleaseControlAllOfPayload.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::SwitchboardReleaseControlAllOfPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation from which the switchboard event was fired. The payload will omit `activeSwitchboardIntegration`, representing that no switchboard integration is in control of the conversation. | [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] 
+**reason** | **String** | Reason for the release control action, if applicable. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SwitchboardReleaseControlAllOfPayload.new(conversation: null,
+                                 metadata: {"lang":"en-ca"},
+                                 reason: null)
+```
+
+

data/docs/TemplateMessage.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | The type of message. | [default to 'template']
 **block_chat_input** | **Boolean** | When set to true, the chat input will be disabled on supported client implementations when the message is the most recent one in the history. Can be used for guided flows or to temporarily disable the user's ability to send messages in the conversation. | [optional] 
-**template** | [**Object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://docs.smooch.io/guide/whatsapp#sending-message-templates). `schema` must be set to `whatsapp`. | 
+**template** | [**Object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/message-overrides/#template-messages). `schema` must be set to `whatsapp`. | 
 
 ## Code Sample
 

data/docs/WhatsAppConversionEventsBody.md

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

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

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 15.5.1
+The version of the OpenAPI document: 15.6.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: 15.5.1
+The version of the OpenAPI document: 15.6.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: 15.5.1
+The version of the OpenAPI document: 15.6.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: 15.5.1
+The version of the OpenAPI document: 15.6.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -87,7 +87,7 @@ module SunshineConversationsClient
     end
 
     # Upload Attachment
-    # Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://docs.smooch.io/guide/validating-files\">file validation</a> guide for more details.</aside> 
+    # Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://support.zendesk.com/hc/en-us/articles/8435939957914#topic_v1r_rwr_mdc\">file validation</a> guide for more details.</aside> 
     # @param app_id [String] Identifies the app.
     # @param access [String] The access level for the attachment. Currently the only available access level is public. Private is not supported.
     # @param source [File] 
@@ -101,7 +101,7 @@ module SunshineConversationsClient
     end
 
     # Upload Attachment
-    # Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. &lt;aside class&#x3D;\&quot;notice\&quot;&gt;Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the &lt;a href&#x3D;\&quot;https://docs.smooch.io/guide/validating-files\&quot;&gt;file validation&lt;/a&gt; guide for more details.&lt;/aside&gt; 
+    # Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. &lt;aside class&#x3D;\&quot;notice\&quot;&gt;Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the &lt;a href&#x3D;\&quot;https://support.zendesk.com/hc/en-us/articles/8435939957914#topic_v1r_rwr_mdc\&quot;&gt;file validation&lt;/a&gt; guide for more details.&lt;/aside&gt; 
     # @param app_id [String] Identifies the app.
     # @param access [String] The access level for the attachment. Currently the only available access level is public. Private is not supported.
     # @param source [File] 

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

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 15.5.1
+The version of the OpenAPI document: 15.6.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: 15.5.1
+The version of the OpenAPI document: 15.6.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -370,6 +370,82 @@ module SunshineConversationsClient
       return data, status_code, headers
     end
 
+    # Post Conversion Events
+    # This API can be used to track your end user's interactions with third party channels.
+    # @param app_id [String] Identifies the app.
+    # @param conversation_id [String] Identifies the conversation.
+    # @param conversion_events_body [ConversionEventsBody] 
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    def post_conversion_events(app_id, conversation_id, conversion_events_body, opts = {})
+      data, _status_code, _headers = post_conversion_events_with_http_info(app_id, conversation_id, conversion_events_body, opts)
+      data
+    end
+
+    # Post Conversion Events
+    # This API can be used to track your end user&#39;s interactions with third party channels.
+    # @param app_id [String] Identifies the app.
+    # @param conversation_id [String] Identifies the conversation.
+    # @param conversion_events_body [ConversionEventsBody] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
+    def post_conversion_events_with_http_info(app_id, conversation_id, conversion_events_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationsApi.post_conversion_events ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling ConversationsApi.post_conversion_events"
+      end
+      # verify the required parameter 'conversation_id' is set
+      if @api_client.config.client_side_validation && conversation_id.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversion_events"
+      end
+      # verify the required parameter 'conversion_events_body' is set
+      if @api_client.config.client_side_validation && conversion_events_body.nil?
+        fail ArgumentError, "Missing the required parameter 'conversion_events_body' when calling ConversationsApi.post_conversion_events"
+      end
+      # resource path
+      local_var_path = '/v2/apps/{appId}/conversations/{conversationId}/conversionEvents'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'conversationId' + '}', CGI.escape(conversation_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(conversion_events_body) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Hash<String, Object>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationsApi#post_conversion_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update Conversation
     # Updates a conversation record.
     # @param app_id [String] Identifies the app.