sunshine-conversations-client 16.0.0 → 17.0.0

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

@@ -1,10 +1,10 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 15.6.0
+The version of the OpenAPI document: 17.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 7.12.0
 =end
 
 module SunshineConversationsClient
@@ -88,41 +88,38 @@ module SunshineConversationsClient
     # @return [true, false]
     attr_accessor :client_side_validation
 
-    ### TLS/SSL setting
-    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Set this to false to skip SSL certificate verification
     # Default to true.
     #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
     # @return [true, false]
     attr_accessor :verify_ssl
 
-    ### TLS/SSL setting
-    # Set this to false to skip verifying SSL host name
+    # Set this to false to skip SSL host verification
     # Default to true.
     #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
     # @return [true, false]
     attr_accessor :verify_ssl_host
 
-    ### TLS/SSL setting
-    # Set this to customize the certificate file to verify the peer.
-    #
-    # @return [String] the path to the certificate file
+    # TLS/SSL setting
+    # Set this to specify the path to SSL client cert file (.pem format)
+    # Default to nil.
     #
-    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
-    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
-    attr_accessor :ssl_ca_cert
-
-    ### TLS/SSL setting
-    # Client certificate file (for client certificate)
+    # @return [String]
     attr_accessor :cert_file
 
-    ### TLS/SSL setting
-    # Client private key file (for client certificate)
+    # TLS/SSL setting
+    # Set this to specify the path to SSL client key file (.pem format)
+    # Default to nil.
+    #
+    # @return [String]
     attr_accessor :key_file
 
+    # TLS/SSL setting
+    # Set this to specify the path to SSL CA certificate file (.pem format)
+    # Default to nil.
+    #
+    # @return [String]
+    attr_accessor :ssl_ca_cert
     # Set this to customize parameters encoding of array parameter with multi collectionFormat.
     # Default to nil.
     #
@@ -151,6 +148,7 @@ module SunshineConversationsClient
       @params_encoding = nil
       @cert_file = nil
       @key_file = nil
+      @ssl_ca_cert = nil
       @debugging = false
       @inject_format = false
       @force_ending_format = false
@@ -210,13 +208,6 @@ module SunshineConversationsClient
     # Returns Auth Settings hash for api client.
     def auth_settings
       {
-        'basicAuth' =>
-          {
-            type: 'basic',
-            in: 'header',
-            key: 'Authorization',
-            value: basic_auth_token
-          },
         'bearerAuth' =>
           {
             type: 'bearer',
@@ -225,6 +216,13 @@ module SunshineConversationsClient
             key: 'Authorization',
             value: access_token ? "Bearer #{access_token}" : nil 
           },
+        'basicAuth' =>
+          {
+            type: 'basic',
+            in: 'header',
+            key: 'Authorization',
+            value: basic_auth_token
+          },
       }
     end
 
@@ -233,11 +231,15 @@ module SunshineConversationsClient
       [
         {
           url: "https://api.smooch.io",
-          description: "United States server",
+          description: "United States server (for legacy Sunshine Conversations only)",
         },
         {
           url: "https://api.eu-1.smooch.io",
-          description: "European Union server",
+          description: "European Union server (for legacy Sunshine Conversations only)",
+        },
+        {
+          url: "https://{subdomain}.zendesk.com/sc",
+          description: "Your Zendesk subdomain",
         }
       ]
     end

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

@@ -1,13 +1,14 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 15.6.0
+The version of the OpenAPI document: 17.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 7.12.0
 =end
 
 require 'date'
+require 'time'
 
 module SunshineConversationsClient
   class AcceptControlBody
@@ -24,13 +25,14 @@ module SunshineConversationsClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'metadata' => :'Hash'
+        :'metadata' => :'Hash<String, Object>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'metadata'
       ])
     end
 
@@ -50,7 +52,9 @@ module SunshineConversationsClient
       }
 
       if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       end
     end
 
@@ -91,37 +95,33 @@ module SunshineConversationsClient
     # @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
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -151,7 +151,9 @@ module SunshineConversationsClient
           end
         end
       else # model
-        SunshineConversationsClient.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = SunshineConversationsClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -177,7 +179,7 @@ module SunshineConversationsClient
           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
@@ -200,5 +202,6 @@ module SunshineConversationsClient
         value
       end
     end
+
   end
 end

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

@@ -1,420 +1,44 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 15.6.0
+The version of the OpenAPI document: 17.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 7.12.0
 =end
 
 require 'date'
+require 'time'
 
 module SunshineConversationsClient
-  class Action
-    # The type of action.
-    attr_accessor :type
-
-    # The button text.
-    attr_accessor :text
-
-    # The amount being charged. It needs to be specified in cents and is an integer (9.99$ -> 999).
-    attr_accessor :amount
-
-    # An ISO 4217 standard currency code in lowercase. Used for actions of type buy.
-    attr_accessor :currency
-
-    # 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. 
-    attr_accessor :metadata
-
-    # The webview URI. This is the URI that will open in the webview when clicking the button.
-    attr_accessor :uri
-
-    # Boolean value indicating whether the action is the default action for a message item in Facebook Messenger.
-    attr_accessor :default
-
-    attr_accessor :extra_channel_options
-
-    # A string payload to help you identify the action context. Used when posting the reply. You can also use metadata for more complex needs.
-    attr_accessor :payload
-
-    # An icon to render next to the reply option.
-    attr_accessor :icon_url
-
-    # The size to display a webview. Used for actions of type webview.
-    attr_accessor :size
-
-    # The fallback uri for channels that don’t support webviews. Used for actions of type webview.
-    attr_accessor :fallback
-
-    # Boolean value indicating if the webview should open automatically. Only one action per message can be set to true. Currently only supported on the Web Messenger.
-    attr_accessor :open_on_receive
-
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
-
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'type' => :'type',
-        :'text' => :'text',
-        :'amount' => :'amount',
-        :'currency' => :'currency',
-        :'metadata' => :'metadata',
-        :'uri' => :'uri',
-        :'default' => :'default',
-        :'extra_channel_options' => :'extraChannelOptions',
-        :'payload' => :'payload',
-        :'icon_url' => :'iconUrl',
-        :'size' => :'size',
-        :'fallback' => :'fallback',
-        :'open_on_receive' => :'openOnReceive'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'type' => :'String',
-        :'text' => :'String',
-        :'amount' => :'Integer',
-        :'currency' => :'String',
-        :'metadata' => :'Hash<String, Object>',
-        :'uri' => :'String',
-        :'default' => :'Boolean',
-        :'extra_channel_options' => :'ExtraChannelOptions',
-        :'payload' => :'String',
-        :'icon_url' => :'String',
-        :'size' => :'String',
-        :'fallback' => :'String',
-        :'open_on_receive' => :'Boolean'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-        :'metadata',
-      ])
-    end
-
-    # List of class defined in oneOf (OpenAPI v3)
-    def self.openapi_one_of
-      [
-      :'Buy',
-      :'Link',
-      :'LocationRequest',
-      :'Postback',
-      :'Reply',
-      :'Webview'
-      ]
-    end
-
-    # discriminator's property name in OpenAPI v3
-    def self.openapi_discriminator_name
-      :'type'
-    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::Action` 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::Action`. 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?(:'text')
-        self.text = attributes[:'text']
-      end
-
-      if attributes.key?(:'amount')
-        self.amount = attributes[:'amount']
-      end
-
-      if attributes.key?(:'currency')
-        self.currency = attributes[:'currency']
-      end
-
-      if attributes.key?(:'metadata')
-      end
-
-      if attributes.key?(:'uri')
-        self.uri = attributes[:'uri']
-      end
-
-      if attributes.key?(:'default')
-        self.default = attributes[:'default']
-      end
-
-      if attributes.key?(:'extra_channel_options')
-        self.extra_channel_options = attributes[:'extra_channel_options']
-      end
-
-      if attributes.key?(:'payload')
-        self.payload = attributes[:'payload']
-      end
-
-      if attributes.key?(:'icon_url')
-        self.icon_url = attributes[:'icon_url']
-      end
-
-      if attributes.key?(:'size')
-        self.size = attributes[:'size']
-      end
-
-      if attributes.key?(:'fallback')
-        self.fallback = attributes[:'fallback']
-      end
-
-      if attributes.key?(:'open_on_receive')
-        self.open_on_receive = attributes[:'open_on_receive']
-      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
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-
-      if @text.nil?
-        invalid_properties.push('invalid value for "text", text cannot be nil.')
-      end
-
-      if @amount.nil?
-        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
-      end
-
-      if @uri.nil?
-        invalid_properties.push('invalid value for "uri", uri cannot be nil.')
-      end
-
-      if @payload.nil?
-        invalid_properties.push('invalid value for "payload", payload cannot be nil.')
-      end
-
-      if @fallback.nil?
-        invalid_properties.push('invalid value for "fallback", fallback 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 @type.nil?
-      return false if @text.nil?
-      return false if @amount.nil?
-      return false if @uri.nil?
-      return false if @payload.nil?
-      size_validator = EnumAttributeValidator.new('String', ["compact", "tall", "full"])
-      return false unless size_validator.valid?(@size)
-      return false if @fallback.nil?
-      _one_of_found = false
-      self.class.openapi_one_of.each do |_class|
-        _one_of = SunshineConversationsClient.const_get(_class).build_from_hash(self.to_hash)
-        if _one_of.valid?
-          if _one_of_found
-            return false
-          else
-            _one_of_found = true
-          end
-        end
-      end
-
-      if !_one_of_found
-        return false
-      end
-
-      true
-    end
-
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] size Object to be assigned
-    def size=(size)
-      validator = EnumAttributeValidator.new('String', ["compact", "tall", "full"])
-      unless validator.valid?(size)
-        fail ArgumentError, "invalid value for \"size\", must be one of #{validator.allowable_values}."
-      end
-      @size = size
-    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 &&
-          text == o.text &&
-          amount == o.amount &&
-          currency == o.currency &&
-          metadata == o.metadata &&
-          uri == o.uri &&
-          default == o.default &&
-          extra_channel_options == o.extra_channel_options &&
-          payload == o.payload &&
-          icon_url == o.icon_url &&
-          size == o.size &&
-          fallback == o.fallback &&
-          open_on_receive == o.open_on_receive
-    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, text, amount, currency, metadata, uri, default, extra_channel_options, payload, icon_url, size, fallback, open_on_receive].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
+  module Action
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Buy',
+          :'Link',
+          :'LocationRequest',
+          :'Postback',
+          :'Reply',
+          :'Webview'
+        ]
+      end
+
+      # Discriminator's property name (OpenAPI v3)
+      def openapi_discriminator_name
+        :'type'
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        discriminator_value = data[openapi_discriminator_name]
+        return nil if discriminator_value.nil?
+        SunshineConversationsClient.const_get(discriminator_value).build_from_hash(data)
       end
     end
   end
+
 end