sunshine-conversations-client 9.1.1 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5014bcf7814ccf1936867d08f4d10958054587e1
-  data.tar.gz: f933c4e501c55329d5114f2c860ffc49987a0fbe
+  metadata.gz: e367b1fde0f780cf450c290d23dedd8dec6169ca
+  data.tar.gz: a48377436779a318afdde5a8bccb0969e4b6a532
 SHA512:
-  metadata.gz: 54de593ae1f99a25d9851f480c2f9cd666a8f9733cdb4a3dc42d1b35b9bb9777917cd5d58732111913aa76be33fdabadcada8e037c8d77a14bbbe3dc04917dea
-  data.tar.gz: dcfe08addfc281105ec45301c1cb3de3c33e3e4c95f8a361d604aebb874b49a6f253a648d023cca599d6c81055d82ada65929bff4d93df19bcb268bded8036d6
+  metadata.gz: 5da56361e421ffdb09b24da628d83a10a6bc46247e3a7b96465979aff9a55ef7cf7c7612fe27abe69d6383378890fe00a452e562c3f5e2b6463a81ddd1bc03df
+  data.tar.gz: 1be215df26f62414195b27e902313deb415c6f946dc8df94aecdcd85d5766e08ffb376d8c139948c184342e1f98188da8e2570c8a6e0a301ab939251ff5763ad

data/CHANGELOG_RB.md

@@ -1,4 +1,11 @@
 # Changelog
+
+## [9.2.0] - 2020-11-16
+
+### Added
+
+- Added support for Instagram Direct
+
 ## [9.1.1] - 2020-11-11
 
 ### Fixed

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.1.0
-- Package version: 9.1.1
+- Package version: 9.2.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.1.1.gem
+gem install ./sunshine-conversations-client-9.2.0.gem
 ```
 
-(for development, run `gem install --dev ./sunshine-conversations-client-9.1.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./sunshine-conversations-client-9.2.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.1.1'
+    gem 'sunshine-conversations-client', '~> 9.2.0'
 
 ### Install from Git
 
@@ -291,6 +291,10 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::FormResponseMessage](docs/FormResponseMessage.md)
  - [SunshineConversationsClient::ImageMessage](docs/ImageMessage.md)
  - [SunshineConversationsClient::InlineObject](docs/InlineObject.md)
+ - [SunshineConversationsClient::Instagram](docs/Instagram.md)
+ - [SunshineConversationsClient::InstagramAllOf](docs/InstagramAllOf.md)
+ - [SunshineConversationsClient::InstagramUpdate](docs/InstagramUpdate.md)
+ - [SunshineConversationsClient::InstagramUpdateAllOf](docs/InstagramUpdateAllOf.md)
  - [SunshineConversationsClient::Integration](docs/Integration.md)
  - [SunshineConversationsClient::IntegrationApiKey](docs/IntegrationApiKey.md)
  - [SunshineConversationsClient::IntegrationApiKeyListResponse](docs/IntegrationApiKeyListResponse.md)
@@ -348,7 +352,6 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::Messenger](docs/Messenger.md)
  - [SunshineConversationsClient::MessengerAllOf](docs/MessengerAllOf.md)
  - [SunshineConversationsClient::MessengerUpdate](docs/MessengerUpdate.md)
- - [SunshineConversationsClient::MessengerUpdateAllOf](docs/MessengerUpdateAllOf.md)
  - [SunshineConversationsClient::Meta](docs/Meta.md)
  - [SunshineConversationsClient::OfferControlBody](docs/OfferControlBody.md)
  - [SunshineConversationsClient::Page](docs/Page.md)

data/docs/Instagram.md

@@ -0,0 +1,35 @@
+# SunshineConversationsClient::Instagram
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'instagram']
+**page_access_token** | **String** | The Facebook Page Access Token of the Facebook page that is linked to your Instagram account. | 
+**app_id** | **String** | Your Facebook App ID. | 
+**app_secret** | **String** | Your Facebook App secret. | 
+**business_name** | **String** | Your Instagram Business account name | [optional] [readonly] 
+**business_username** | **String** | Your Instagram Business unique username | [optional] [readonly] 
+**page_id** | **String** | The ID of the Facebook Page linked to your Instagram Business account | [optional] [readonly] 
+**business_id** | **String** | The ID of the Instagram Business account | [optional] [readonly] 
+**username** | **String** | The Facebook user's username. This is returned when integrating through the Dashboard | [optional] [readonly] 
+**user_id** | **String** | The Facebook user's user ID. This is returned when integrating through the Dashboard | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Instagram.new(type: null,
+                                 page_access_token: your_page_access_token,
+                                 app_id: your_facebook_app_id,
+                                 app_secret: your_facebook_app_secret,
+                                 business_name: instagram_name,
+                                 business_username: instagram_username,
+                                 page_id: 106731941223392,
+                                 business_id: 17841444303043201,
+                                 username: facebook_username,
+                                 user_id: 100885965124932)
+```
+
+

data/docs/InstagramAllOf.md

@@ -0,0 +1,35 @@
+# SunshineConversationsClient::InstagramAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'instagram']
+**page_access_token** | **String** | The Facebook Page Access Token of the Facebook page that is linked to your Instagram account. | 
+**app_id** | **String** | Your Facebook App ID. | 
+**app_secret** | **String** | Your Facebook App secret. | 
+**business_name** | **String** | Your Instagram Business account name | [optional] [readonly] 
+**business_username** | **String** | Your Instagram Business unique username | [optional] [readonly] 
+**page_id** | **String** | The ID of the Facebook Page linked to your Instagram Business account | [optional] [readonly] 
+**business_id** | **String** | The ID of the Instagram Business account | [optional] [readonly] 
+**username** | **String** | The Facebook user's username. This is returned when integrating through the Dashboard | [optional] [readonly] 
+**user_id** | **String** | The Facebook user's user ID. This is returned when integrating through the Dashboard | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::InstagramAllOf.new(type: null,
+                                 page_access_token: your_page_access_token,
+                                 app_id: your_facebook_app_id,
+                                 app_secret: your_facebook_app_secret,
+                                 business_name: instagram_name,
+                                 business_username: instagram_username,
+                                 page_id: 106731941223392,
+                                 business_id: 17841444303043201,
+                                 username: facebook_username,
+                                 user_id: 100885965124932)
+```
+
+

data/docs/InstagramUpdate.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::InstagramUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional] 
+**page_access_token** | **String** | A Facebook Page Access Token. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::InstagramUpdate.new(display_name: My awesome integration,
+                                 page_access_token: your_access_token)
+```
+
+

data/docs/{MessengerUpdateAllOf.md → InstagramUpdateAllOf.md}

@@ -1,4 +1,4 @@
-# SunshineConversationsClient::MessengerUpdateAllOf
+# SunshineConversationsClient::InstagramUpdateAllOf
 
 ## Properties
 
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'SunshineConversationsClient'
 
-instance = SunshineConversationsClient::MessengerUpdateAllOf.new(page_access_token: your_access_token)
+instance = SunshineConversationsClient::InstagramUpdateAllOf.new(page_access_token: your_access_token)
 ```
 
 

data/docs/IntegrationUpdate.md

@@ -8,13 +8,13 @@ Name | Type | Description | Notes
 **server_key** | **String** | Your server key from the fcm console. | [optional] 
 **sender_id** | **String** | Your sender id from the fcm console. | [optional] 
 **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the web messenger integration. | [optional] 
+**page_access_token** | **String** | A Facebook Page Access Token. | [optional] 
 **certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional] 
 **password** | **String** | The password for your APN certificate. | [optional] 
 **production** | **Boolean** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional] 
 **auto_update_badge** | **Boolean** | Use the unread count of the conversation as the application badge. | [optional] 
 **hide_unsubscribe_link** | **Boolean** | A boolean value indicating whether the unsubscribe link should be omitted from outgoing emails. When enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. By default, the unsubscribe link will be included in all outgoing emails. | [optional] 
 **from_address** | **String** | Email address to use as the From and Reply-To address if it must be different from incomingAddress. Only use this option if the address that you supply is configured to forward emails to the incomingAddress, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user’s email client. May be unset with null. | [optional] 
-**page_access_token** | **String** | A Facebook Page Access Token. | [optional] 
 **brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '65758e']
 **fixed_intro_pane** | **Boolean** | When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. | [optional] [default to false]
 **conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. | [optional] [default to '0099ff']
@@ -42,13 +42,13 @@ instance = SunshineConversationsClient::IntegrationUpdate.new(display_name: My a
                                  server_key: <server-key>,
                                  sender_id: <sender-id>,
                                  can_user_create_more_conversations: null,
+                                 page_access_token: your_access_token,
                                  certificate: your_APN_certificate,
                                  password: your_APN_password,
                                  production: null,
                                  auto_update_badge: null,
                                  hide_unsubscribe_link: null,
                                  from_address: test@sandbox123.mailgun.org,
-                                 page_access_token: your_access_token,
                                  brand_color: null,
                                  fixed_intro_pane: null,
                                  conversation_color: null,

data/lib/sunshine-conversations-client.rb

@@ -118,6 +118,10 @@ require 'sunshine-conversations-client/models/form_message'
 require 'sunshine-conversations-client/models/form_response_message'
 require 'sunshine-conversations-client/models/image_message'
 require 'sunshine-conversations-client/models/inline_object'
+require 'sunshine-conversations-client/models/instagram'
+require 'sunshine-conversations-client/models/instagram_all_of'
+require 'sunshine-conversations-client/models/instagram_update'
+require 'sunshine-conversations-client/models/instagram_update_all_of'
 require 'sunshine-conversations-client/models/integration'
 require 'sunshine-conversations-client/models/integration_api_key'
 require 'sunshine-conversations-client/models/integration_api_key_list_response'
@@ -175,7 +179,6 @@ require 'sunshine-conversations-client/models/messagebird_all_of'
 require 'sunshine-conversations-client/models/messenger'
 require 'sunshine-conversations-client/models/messenger_all_of'
 require 'sunshine-conversations-client/models/messenger_update'
-require 'sunshine-conversations-client/models/messenger_update_all_of'
 require 'sunshine-conversations-client/models/meta'
 require 'sunshine-conversations-client/models/offer_control_body'
 require 'sunshine-conversations-client/models/page'

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

@@ -0,0 +1,323 @@
+=begin
+#Sunshine Conversations API
+
+The version of the OpenAPI document: 9.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+=end
+
+require 'date'
+
+module SunshineConversationsClient
+  class Instagram < Integration
+    # The type of integration.
+    attr_accessor :type
+
+    # The Facebook Page Access Token of the Facebook page that is linked to your Instagram account.
+    attr_accessor :page_access_token
+
+    # Your Facebook App ID.
+    attr_accessor :app_id
+
+    # Your Facebook App secret.
+    attr_accessor :app_secret
+
+    # Your Instagram Business account name
+    attr_accessor :business_name
+
+    # Your Instagram Business unique username
+    attr_accessor :business_username
+
+    # The ID of the Facebook Page linked to your Instagram Business account
+    attr_accessor :page_id
+
+    # The ID of the Instagram Business account
+    attr_accessor :business_id
+
+    # The Facebook user's username. This is returned when integrating through the Dashboard
+    attr_accessor :username
+
+    # The Facebook user's user ID. This is returned when integrating through the Dashboard
+    attr_accessor :user_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'page_access_token' => :'pageAccessToken',
+        :'app_id' => :'appId',
+        :'app_secret' => :'appSecret',
+        :'business_name' => :'businessName',
+        :'business_username' => :'businessUsername',
+        :'page_id' => :'pageId',
+        :'business_id' => :'businessId',
+        :'username' => :'username',
+        :'user_id' => :'userId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'page_access_token' => :'String',
+        :'app_id' => :'String',
+        :'app_secret' => :'String',
+        :'business_name' => :'String',
+        :'business_username' => :'String',
+        :'page_id' => :'String',
+        :'business_id' => :'String',
+        :'username' => :'String',
+        :'user_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'InstagramAllOf',
+      :'Integration'
+      ]
+    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::Instagram` 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::Instagram`. 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
+      }
+
+      # call parent's initialize
+      super(attributes)
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 'instagram'
+      end
+
+      if attributes.key?(:'page_access_token')
+        self.page_access_token = attributes[:'page_access_token']
+      end
+
+      if attributes.key?(:'app_id')
+        self.app_id = attributes[:'app_id']
+      end
+
+      if attributes.key?(:'app_secret')
+        self.app_secret = attributes[:'app_secret']
+      end
+
+      if attributes.key?(:'business_name')
+        self.business_name = attributes[:'business_name']
+      end
+
+      if attributes.key?(:'business_username')
+        self.business_username = attributes[:'business_username']
+      end
+
+      if attributes.key?(:'page_id')
+        self.page_id = attributes[:'page_id']
+      end
+
+      if attributes.key?(:'business_id')
+        self.business_id = attributes[:'business_id']
+      end
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_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 = super
+      if @page_access_token.nil?
+        invalid_properties.push('invalid value for "page_access_token", page_access_token cannot be nil.')
+      end
+
+      if @app_id.nil?
+        invalid_properties.push('invalid value for "app_id", app_id cannot be nil.')
+      end
+
+      if @app_secret.nil?
+        invalid_properties.push('invalid value for "app_secret", app_secret cannot be nil.')
+      end
+
+      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?
+      return false if @page_access_token.nil?
+      return false if @app_id.nil?
+      return false if @app_secret.nil?
+      true && super
+    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 &&
+          page_access_token == o.page_access_token &&
+          app_id == o.app_id &&
+          app_secret == o.app_secret &&
+          business_name == o.business_name &&
+          business_username == o.business_username &&
+          page_id == o.page_id &&
+          business_id == o.business_id &&
+          username == o.username &&
+          user_id == o.user_id && super(o)
+    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, page_access_token, app_id, app_secret, business_name, business_username, page_id, business_id, username, user_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)
+      super(attributes)
+      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 = super
+      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