sunshine-conversations-client 9.12.0 → 9.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb06eb89815473af3589eba82b1465357832c33d
-  data.tar.gz: f81f92bef2495a526f1cfb8854bfd60378f187bc
+  metadata.gz: 5cb0ebcda41a5659e4a3dc8b68724deea5548fc8
+  data.tar.gz: bd4ce4079e45358d2b59573c622a008b52c9b93c
 SHA512:
-  metadata.gz: 9214bf73758be16208229af4b2633615a68e0c2b0c14b873349348056d3bad5327fea78be1498fa65b4dec59a6d4f7fed14809bb84e12d7d65cff9e457ccb048
-  data.tar.gz: 36ccc8965d2f856edb49a2e5031d972f713a16d8861d1a65096aaef55b9ecab6f5c1e26723714adb916f2627de15fbffd5d999759420b1e091e1642f8efb315a
+  metadata.gz: 431ea779fb02dec1c48de55ca54c5a0de3a7c829c497f66d39956c5545915f1e3d96386b63b8e0997b751b83fdd2ed0a03827f4884e9ad6a37278342ca50a1bf
+  data.tar.gz: ea095ebfd0810596e3859703e68614c7cb6fd2d7192e2f0815ac97c5a653d1f14564e419c3e2f26f4b47793d168761e36d537c9db66189a03f540fab0dbc126c

data/CHANGELOG_RB.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [9.13.0] - 2023-03-30
+
+### Added
+
+-   Added a new `proactiveMessaging` creation reason for the `conversation:create` webhook event.
+-   Added a `campaign` object to the `source` object of the following webhook events:
+    -   `conversation:create`
+    -   `conversation:message`
+    -   `conversation:postback`
+    -   `conversation:referral`
+
 ## [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.

data/README.md

@@ -5,7 +5,7 @@ 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.12.0
-- Package version: 9.12.0
+- Package version: 9.13.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.12.0.gem
+gem install ./sunshine-conversations-client-9.13.0.gem
 ```
 
-(for development, run `gem install --dev ./sunshine-conversations-client-9.12.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./sunshine-conversations-client-9.13.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.12.0'
+    gem 'sunshine-conversations-client', '~> 9.13.0'
 
 ### Install from Git
 
@@ -235,6 +235,7 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::Author](docs/Author.md)
  - [SunshineConversationsClient::AuthorWebhook](docs/AuthorWebhook.md)
  - [SunshineConversationsClient::Buy](docs/Buy.md)
+ - [SunshineConversationsClient::Campaign](docs/Campaign.md)
  - [SunshineConversationsClient::CarouselMessage](docs/CarouselMessage.md)
  - [SunshineConversationsClient::CarouselMessageDisplaySettings](docs/CarouselMessageDisplaySettings.md)
  - [SunshineConversationsClient::Client](docs/Client.md)
@@ -401,6 +402,8 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::Reply](docs/Reply.md)
  - [SunshineConversationsClient::Source](docs/Source.md)
  - [SunshineConversationsClient::SourceWebhook](docs/SourceWebhook.md)
+ - [SunshineConversationsClient::SourceWithCampaignWebhook](docs/SourceWithCampaignWebhook.md)
+ - [SunshineConversationsClient::SourceWithCampaignWebhookAllOf](docs/SourceWithCampaignWebhookAllOf.md)
  - [SunshineConversationsClient::Status](docs/Status.md)
  - [SunshineConversationsClient::Switchboard](docs/Switchboard.md)
  - [SunshineConversationsClient::SwitchboardAcceptControl](docs/SwitchboardAcceptControl.md)

data/docs/Campaign.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::Campaign
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the campaign. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Campaign.new(id: de13bee15b51033b34162411)
+```
+
+

data/docs/ConversationCreateEventAllOfPayload.md

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation that was created. | [optional] 
-**creation_reason** | **String** | The reason why the conversation was created, if applicable. * `linkRequest` - The conversation was created in order to generate a link request to transfer the user to a different channel. * `message` - The conversation was created because a message was sent. * `none` - The conversation was not created for a specific purpose. Used primarily when a conversation is created via the Create Conversation API. * `notification` - The conversation was created by a call to the Notification API. * `prechatCapture` - The conversation was created because the user completed a prechat capture form in the Web Messenger. * `startConversation` - The conversation was created because of a call to the startConversation API on one of the SDK integrations, or a start conversation event was triggered from a messaging channel.  | [optional] 
-**source** | [**SourceWebhook**](SourceWebhook.md) | The source of the creation. | [optional] 
+**creation_reason** | **String** | The reason why the conversation was created, if applicable. * `linkRequest` - The conversation was created in order to generate a link request to transfer the user to a different channel. * `message` - The conversation was created because a message was sent. * `none` - The conversation was not created for a specific purpose. Used primarily when a conversation is created via the Create Conversation API. * `notification` - The conversation was created by a call to the Notification API. * `prechatCapture` - The conversation was created because the user completed a prechat capture form in the Web Messenger. * `startConversation` - The conversation was created because of a call to the startConversation API on one of the SDK integrations, or a start conversation event was triggered from a messaging channel. * `proactiveMessaging` - The conversation was created because the user interacted with a campaign.  | [optional] 
+**source** | [**SourceWithCampaignWebhook**](SourceWithCampaignWebhook.md) | The source of the creation. | [optional] 
 **user** | [**User**](User.md) | The user associated with the conversation. Only present if the created conversation was of type personal. For sdkGroup conversations, the list of participants can be fetched using the List Participants API, if required. | [optional] 
 **referral** | [**Referral**](Referral.md) | Referral information, if applicable. | [optional] 
 

data/docs/ConversationPostbackEventAllOfPayload.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **postback** | [**PostbackWebhook**](PostbackWebhook.md) | The postback associated with the event. | [optional] 
 **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation linked to the postback. | [optional] 
 **user** | [**User**](User.md) | The user that triggered the postback. | [optional] 
-**source** | [**SourceWebhook**](SourceWebhook.md) | The source of the postback. | [optional] 
+**source** | [**SourceWithCampaignWebhook**](SourceWithCampaignWebhook.md) | The source of the postback. | [optional] 
 
 ## Code Sample
 

data/docs/ConversationReferralEventAllOfPayload.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation a user lands in after being referred. See the <a href=\"https://docs.smooch.io/guide/conversation-referrals/\">conversation referrals</a> guide for more details. | [optional] 
 **user** | [**User**](User.md) | The user associated with the conversation. | [optional] 
-**source** | [**SourceWebhook**](SourceWebhook.md) | The source of the referral. | [optional] 
+**source** | [**SourceWithCampaignWebhook**](SourceWithCampaignWebhook.md) | The source of the referral. | [optional] 
 **referral** | [**Referral**](Referral.md) |  | [optional] 
 
 ## Code Sample

data/docs/Reply.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | The type of action. | 
-**text** | **String** | The button text. Text longer than 20 characters will be truncated on Facebook Messenger, and longer than 40 characters will be truncated on Web Messenger, iOS, and Android. | 
+**text** | **String** | The button text. We recommend a non-empty value because some channels may not support empty ones. Text longer than 20 characters will be truncated on Facebook Messenger, and longer than 40 characters will be truncated on Web Messenger, iOS, and Android. | 
 **payload** | **String** | A string payload to help you identify the action context. Used when posting the reply. You can also use metadata for more complex needs. | 
 **metadata** | [**Object**](.md) | Flat object containing custom properties. Strings, numbers and booleans  are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.  | [optional] 
 **icon_url** | **String** | An icon to render next to the reply option. | [optional] 

data/docs/SourceWithCampaignWebhook.md

@@ -0,0 +1,29 @@
+# SunshineConversationsClient::SourceWithCampaignWebhook
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels. | [optional] 
+**integration_id** | **String** | Identifier indicating which integration the message was sent from. For user messages only. | [optional] 
+**original_message_id** | **String** | Message identifier assigned by the originating channel. | [optional] 
+**original_message_timestamp** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing when the third-party channel received the message. | [optional] 
+**client** | [**Client**](Client.md) | The client from which the user authored the message or activity, if applicable. This field will only be present if the `includeFullSource` option is enabled for the webhook. | [optional] 
+**device** | [**Device**](Device.md) | The device from which the user authored the message or activity, if applicable. This field will only be present if the `includeFullSource` option is enabled for the webhook | [optional] 
+**campaign** | [**Campaign**](Campaign.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::SourceWithCampaignWebhook.new(type: ios,
+                                 integration_id: null,
+                                 original_message_id: null,
+                                 original_message_timestamp: null,
+                                 client: null,
+                                 device: null,
+                                 campaign: null)
+```
+
+

data/docs/SourceWithCampaignWebhookAllOf.md

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

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

@@ -0,0 +1,205 @@
+=begin
+#Sunshine Conversations API
+
+The version of the OpenAPI document: 9.12.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+=end
+
+require 'date'
+
+module SunshineConversationsClient
+  # The campaign the user interacted with (if applicable).
+  class Campaign
+    # The unique ID of the campaign.
+    attr_accessor :id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Campaign` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::Campaign`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        SunshineConversationsClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ module SunshineConversationsClient
     # The conversation that was created.
     attr_accessor :conversation
 
-    # The reason why the conversation was created, if applicable. * `linkRequest` - The conversation was created in order to generate a link request to transfer the user to a different channel. * `message` - The conversation was created because a message was sent. * `none` - The conversation was not created for a specific purpose. Used primarily when a conversation is created via the Create Conversation API. * `notification` - The conversation was created by a call to the Notification API. * `prechatCapture` - The conversation was created because the user completed a prechat capture form in the Web Messenger. * `startConversation` - The conversation was created because of a call to the startConversation API on one of the SDK integrations, or a start conversation event was triggered from a messaging channel. 
+    # The reason why the conversation was created, if applicable. * `linkRequest` - The conversation was created in order to generate a link request to transfer the user to a different channel. * `message` - The conversation was created because a message was sent. * `none` - The conversation was not created for a specific purpose. Used primarily when a conversation is created via the Create Conversation API. * `notification` - The conversation was created by a call to the Notification API. * `prechatCapture` - The conversation was created because the user completed a prechat capture form in the Web Messenger. * `startConversation` - The conversation was created because of a call to the startConversation API on one of the SDK integrations, or a start conversation event was triggered from a messaging channel. * `proactiveMessaging` - The conversation was created because the user interacted with a campaign. 
     attr_accessor :creation_reason
 
     # The source of the creation.
@@ -65,7 +65,7 @@ module SunshineConversationsClient
       {
         :'conversation' => :'ConversationTruncated',
         :'creation_reason' => :'String',
-        :'source' => :'SourceWebhook',
+        :'source' => :'SourceWithCampaignWebhook',
         :'user' => :'User',
         :'referral' => :'Referral'
       }
@@ -125,7 +125,7 @@ module SunshineConversationsClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      creation_reason_validator = EnumAttributeValidator.new('String', ["linkRequest", "message", "none", "notification", "prechatCapture", "startConversation"])
+      creation_reason_validator = EnumAttributeValidator.new('String', ["linkRequest", "message", "none", "notification", "prechatCapture", "startConversation", "proactiveMessaging"])
       return false unless creation_reason_validator.valid?(@creation_reason)
       true
     end
@@ -133,7 +133,7 @@ module SunshineConversationsClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] creation_reason Object to be assigned
     def creation_reason=(creation_reason)
-      validator = EnumAttributeValidator.new('String', ["linkRequest", "message", "none", "notification", "prechatCapture", "startConversation"])
+      validator = EnumAttributeValidator.new('String', ["linkRequest", "message", "none", "notification", "prechatCapture", "startConversation", "proactiveMessaging"])
       unless validator.valid?(creation_reason)
         fail ArgumentError, "invalid value for \"creation_reason\", must be one of #{validator.allowable_values}."
       end

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

@@ -40,7 +40,7 @@ module SunshineConversationsClient
         :'postback' => :'PostbackWebhook',
         :'conversation' => :'ConversationTruncated',
         :'user' => :'User',
-        :'source' => :'SourceWebhook'
+        :'source' => :'SourceWithCampaignWebhook'
       }
     end
 

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

@@ -38,7 +38,7 @@ module SunshineConversationsClient
       {
         :'conversation' => :'ConversationTruncated',
         :'user' => :'User',
-        :'source' => :'SourceWebhook',
+        :'source' => :'SourceWithCampaignWebhook',
         :'referral' => :'Referral'
       }
     end

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

@@ -14,7 +14,7 @@ module SunshineConversationsClient
     # The type of action.
     attr_accessor :type
 
-    # The button text. Text longer than 20 characters will be truncated on Facebook Messenger, and longer than 40 characters will be truncated on Web Messenger, iOS, and Android.
+    # The button text. We recommend a non-empty value because some channels may not support empty ones. Text longer than 20 characters will be truncated on Facebook Messenger, and longer than 40 characters will be truncated on Web Messenger, iOS, and Android.
     attr_accessor :text
 
     # A string payload to help you identify the action context. Used when posting the reply. You can also use metadata for more complex needs.

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

@@ -0,0 +1,276 @@
+=begin
+#Sunshine Conversations API
+
+The version of the OpenAPI document: 9.12.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+=end
+
+require 'date'
+
+module SunshineConversationsClient
+  class SourceWithCampaignWebhook
+    # An identifier for the channel from which a message originated. May include one of api, sdk, messenger, or any number of other channels.
+    attr_accessor :type
+
+    # Identifier indicating which integration the message was sent from. For user messages only.
+    attr_accessor :integration_id
+
+    # Message identifier assigned by the originating channel.
+    attr_accessor :original_message_id
+
+    # A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing when the third-party channel received the message.
+    attr_accessor :original_message_timestamp
+
+    # The client from which the user authored the message or activity, if applicable. This field will only be present if the `includeFullSource` option is enabled for the webhook.
+    attr_accessor :client
+
+    # The device from which the user authored the message or activity, if applicable. This field will only be present if the `includeFullSource` option is enabled for the webhook
+    attr_accessor :device
+
+    attr_accessor :campaign
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'integration_id' => :'integrationId',
+        :'original_message_id' => :'originalMessageId',
+        :'original_message_timestamp' => :'originalMessageTimestamp',
+        :'client' => :'client',
+        :'device' => :'device',
+        :'campaign' => :'campaign'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'integration_id' => :'String',
+        :'original_message_id' => :'String',
+        :'original_message_timestamp' => :'String',
+        :'client' => :'Client',
+        :'device' => :'Device',
+        :'campaign' => :'Campaign'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'original_message_id',
+        :'original_message_timestamp',
+        :'client',
+        :'device',
+        :'campaign'
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'SourceWebhook',
+      :'SourceWithCampaignWebhookAllOf'
+      ]
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::SourceWithCampaignWebhook` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::SourceWithCampaignWebhook`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'integration_id')
+        self.integration_id = attributes[:'integration_id']
+      end
+
+      if attributes.key?(:'original_message_id')
+        self.original_message_id = attributes[:'original_message_id']
+      end
+
+      if attributes.key?(:'original_message_timestamp')
+        self.original_message_timestamp = attributes[:'original_message_timestamp']
+      end
+
+      if attributes.key?(:'client')
+        self.client = attributes[:'client']
+      end
+
+      if attributes.key?(:'device')
+        self.device = attributes[:'device']
+      end
+
+      if attributes.key?(:'campaign')
+        self.campaign = attributes[:'campaign']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          type == o.type &&
+          integration_id == o.integration_id &&
+          original_message_id == o.original_message_id &&
+          original_message_timestamp == o.original_message_timestamp &&
+          client == o.client &&
+          device == o.device &&
+          campaign == o.campaign
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [type, integration_id, original_message_id, original_message_timestamp, client, device, campaign].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        SunshineConversationsClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,204 @@
+=begin
+#Sunshine Conversations API
+
+The version of the OpenAPI document: 9.12.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+=end
+
+require 'date'
+
+module SunshineConversationsClient
+  class SourceWithCampaignWebhookAllOf
+    attr_accessor :campaign
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'campaign' => :'campaign'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'campaign' => :'Campaign'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'campaign'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::SourceWithCampaignWebhookAllOf` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::SourceWithCampaignWebhookAllOf`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'campaign')
+        self.campaign = attributes[:'campaign']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          campaign == o.campaign
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [campaign].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        SunshineConversationsClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

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

@@ -8,5 +8,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module SunshineConversationsClient
-  VERSION = '9.12.0'
+  VERSION = '9.13.0'
 end

data/lib/sunshine-conversations-client.rb

@@ -61,6 +61,7 @@ require 'sunshine-conversations-client/models/attachment_upload_body'
 require 'sunshine-conversations-client/models/author'
 require 'sunshine-conversations-client/models/author_webhook'
 require 'sunshine-conversations-client/models/buy'
+require 'sunshine-conversations-client/models/campaign'
 require 'sunshine-conversations-client/models/carousel_message'
 require 'sunshine-conversations-client/models/carousel_message_display_settings'
 require 'sunshine-conversations-client/models/client'
@@ -227,6 +228,8 @@ require 'sunshine-conversations-client/models/referral_details'
 require 'sunshine-conversations-client/models/reply'
 require 'sunshine-conversations-client/models/source'
 require 'sunshine-conversations-client/models/source_webhook'
+require 'sunshine-conversations-client/models/source_with_campaign_webhook'
+require 'sunshine-conversations-client/models/source_with_campaign_webhook_all_of'
 require 'sunshine-conversations-client/models/status'
 require 'sunshine-conversations-client/models/switchboard'
 require 'sunshine-conversations-client/models/switchboard_accept_control'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sunshine-conversations-client
 version: !ruby/object:Gem::Version
-  version: 9.12.0
+  version: 9.13.0
 platform: ruby
 authors:
 - Sunshine Conversations
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2023-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -123,6 +123,7 @@ files:
 - docs/Author.md
 - docs/AuthorWebhook.md
 - docs/Buy.md
+- docs/Campaign.md
 - docs/CarouselMessage.md
 - docs/CarouselMessageDisplaySettings.md
 - docs/Client.md
@@ -296,6 +297,8 @@ files:
 - docs/Reply.md
 - docs/Source.md
 - docs/SourceWebhook.md
+- docs/SourceWithCampaignWebhook.md
+- docs/SourceWithCampaignWebhookAllOf.md
 - docs/Status.md
 - docs/Switchboard.md
 - docs/SwitchboardAcceptControl.md
@@ -428,6 +431,7 @@ files:
 - lib/sunshine-conversations-client/models/author.rb
 - lib/sunshine-conversations-client/models/author_webhook.rb
 - lib/sunshine-conversations-client/models/buy.rb
+- lib/sunshine-conversations-client/models/campaign.rb
 - lib/sunshine-conversations-client/models/carousel_message.rb
 - lib/sunshine-conversations-client/models/carousel_message_display_settings.rb
 - lib/sunshine-conversations-client/models/client.rb
@@ -594,6 +598,8 @@ files:
 - lib/sunshine-conversations-client/models/reply.rb
 - lib/sunshine-conversations-client/models/source.rb
 - lib/sunshine-conversations-client/models/source_webhook.rb
+- lib/sunshine-conversations-client/models/source_with_campaign_webhook.rb
+- lib/sunshine-conversations-client/models/source_with_campaign_webhook_all_of.rb
 - lib/sunshine-conversations-client/models/status.rb
 - lib/sunshine-conversations-client/models/switchboard.rb
 - lib/sunshine-conversations-client/models/switchboard_accept_control.rb