hubspot-api-client 9.4.0 → 9.5.0

data/lib/hubspot/codegen/conversations/visitor-identification/api_error.rb

@@ -0,0 +1,61 @@
+=begin
+#Visitor Identification
+
+#The Visitor Identification API allows you to pass identification information to the HubSpot chat widget for otherwise unknown visitors that were verified by your own authentication system.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+module Hubspot
+  module Conversations
+    module VisitorIdentification
+      class ApiError < StandardError
+        attr_reader :code, :response_headers, :response_body
+
+        # Usage examples:
+        #   ApiError.new
+        #   ApiError.new("message")
+        #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
+        #   ApiError.new(:code => 404, :message => "Not Found")
+        def initialize(arg = nil)
+          if arg.is_a? Hash
+            if arg.key?(:message) || arg.key?('message')
+              super(arg[:message] || arg['message'])
+            else
+              super arg
+            end
+
+            arg.each do |k, v|
+              instance_variable_set "@#{k}", v
+            end
+          else
+            super arg
+          end
+        end
+
+        # Override to_s to display a friendly error message
+        def to_s
+          message
+        end
+
+        def message
+          if @message.nil?
+            msg = "Error message: the server returns an error"
+          else
+            msg = @message
+          end
+
+          msg += "\nHTTP status code: #{code}" if code
+          msg += "\nResponse headers: #{response_headers}" if response_headers
+          msg += "\nResponse body: #{response_body}" if response_body
+
+          msg
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/conversations/visitor-identification/configuration.rb

@@ -0,0 +1,263 @@
+=begin
+#Visitor Identification
+
+#The Visitor Identification API allows you to pass identification information to the HubSpot chat widget for otherwise unknown visitors that were verified by your own authentication system.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+module Hubspot
+  module Conversations
+    module VisitorIdentification
+      class Configuration
+        # Defines url scheme
+        attr_accessor :scheme
+
+        # Defines url host
+        attr_accessor :host
+
+        # Defines url base path
+        attr_accessor :base_path
+
+        # Defines API keys used with API Key authentications.
+        #
+        # @return [Hash] key: parameter name, value: parameter value (API key)
+        #
+        # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+        #   config.api_key['api_key'] = 'xxx'
+        attr_accessor :api_key
+
+        # Defines API key prefixes used with API Key authentications.
+        #
+        # @return [Hash] key: parameter name, value: API key prefix
+        #
+        # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+        #   config.api_key_prefix['api_key'] = 'Token'
+        attr_accessor :api_key_prefix
+
+        # Defines the username used with HTTP basic authentication.
+        #
+        # @return [String]
+        attr_accessor :username
+
+        # Defines the password used with HTTP basic authentication.
+        #
+        # @return [String]
+        attr_accessor :password
+
+        # Defines the access token (Bearer) used with OAuth2.
+        attr_accessor :access_token
+
+        # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+        # details will be logged with `logger.debug` (see the `logger` attribute).
+        # Default to false.
+        #
+        # @return [true, false]
+        attr_accessor :debugging
+
+        # Defines the logger used for debugging.
+        # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+        #
+        # @return [#debug]
+        attr_accessor :logger
+
+        # Defines the temporary folder to store downloaded files
+        # (for API endpoints that have file response).
+        # Default to use `Tempfile`.
+        #
+        # @return [String]
+        attr_accessor :temp_folder_path
+
+        # The time limit for HTTP request in seconds.
+        # Default to 0 (never times out).
+        attr_accessor :timeout
+
+        # Set this to false to skip client side validation in the operation.
+        # Default to true.
+        # @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.
+        # 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
+        # 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
+        #
+        # @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)
+        attr_accessor :cert_file
+
+        ### TLS/SSL setting
+        # Client private key file (for client certificate)
+        attr_accessor :key_file
+
+        # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+        # Default to nil.
+        #
+        # @see The params_encoding option of Ethon. Related source code:
+        # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+        attr_accessor :params_encoding
+
+        attr_accessor :inject_format
+
+        attr_accessor :force_ending_format
+
+        attr_accessor :error_handler
+
+        def initialize
+          @scheme = 'https'
+          @host = 'api.hubapi.com'
+          @base_path = ''
+          @api_key = {}
+          @api_key_prefix = {}
+          @timeout = 0
+          @client_side_validation = true
+          @verify_ssl = true
+          @verify_ssl_host = true
+          @params_encoding = nil
+          @cert_file = nil
+          @key_file = nil
+          @debugging = false
+          @inject_format = false
+          @force_ending_format = false
+          @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+          # error_handler params: { 'status_code': { max_retries: ..., seconds_delay: ... }, ... }
+          @error_handler = {}
+
+          yield(self) if block_given?
+        end
+
+        # The default Configuration object.
+        def self.default
+          @@default ||= Configuration.new
+        end
+
+        def configure
+          yield(self) if block_given?
+        end
+
+        def scheme=(scheme)
+          # remove :// from scheme
+          @scheme = scheme.sub(/:\/\//, '')
+        end
+
+        def host=(host)
+          # remove http(s):// and anything after a slash
+          @host = host.sub(/https?:\/\//, '').split('/').first
+        end
+
+        def base_path=(base_path)
+          # Add leading and trailing slashes to base_path
+          @base_path = "/#{base_path}".gsub(/\/+/, '/')
+          @base_path = '' if @base_path == '/'
+        end
+
+        def base_url
+          "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+        end
+
+        # Gets API key (with prefix if set).
+        # @param [String] param_name the parameter name of API key auth
+        def api_key_with_prefix(param_name)
+          if @api_key_prefix[param_name]
+            "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+          else
+            @api_key[param_name]
+          end
+        end
+
+        # Gets Basic Auth token string
+        def basic_auth_token
+          'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+        end
+
+        # Returns Auth Settings hash for api client.
+        def auth_settings
+          {
+            'hapikey' =>
+              {
+                type: 'api_key',
+                in: 'query',
+                key: 'hapikey',
+                value: api_key_with_prefix('hapikey')
+              },
+            'oauth2' =>
+              {
+                type: 'oauth2',
+                in: 'header',
+                key: 'Authorization',
+                value: "Bearer #{access_token}"
+              },
+          }
+        end
+
+        # Returns an array of Server setting
+        def server_settings
+          [
+            {
+              url: "https://api.hubapi.com/",
+              description: "No description provided",
+            }
+          ]
+        end
+
+        # Returns URL based on server settings
+        #
+        # @param index array index of the server settings
+        # @param variables hash of variable and the corresponding value
+        def server_url(index, variables = {})
+          servers = server_settings
+
+          # check array index out of bound
+          if (index < 0 || index >= servers.size)
+            fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+          end
+
+          server = servers[index]
+          url = server[:url]
+
+          # go through variable and assign a value
+          server[:variables].each do |name, variable|
+            if variables.key?(name)
+              if (server[:variables][name][:enum_values].include? variables[name])
+                url.gsub! "{" + name.to_s + "}", variables[name]
+              else
+                fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
+              end
+            else
+              # use default value
+              url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+            end
+          end
+
+          url
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/conversations/visitor-identification/models/error.rb

@@ -0,0 +1,292 @@
+=begin
+#Visitor Identification
+
+#The Visitor Identification API allows you to pass identification information to the HubSpot chat widget for otherwise unknown visitors that were verified by your own authentication system.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Conversations
+    module VisitorIdentification
+      class Error
+        # A human readable message describing the error along with remediation steps where appropriate
+        attr_accessor :message
+
+        # A unique identifier for the request. Include this value with any error reports or support tickets
+        attr_accessor :correlation_id
+
+        # The error category
+        attr_accessor :category
+
+        # A specific category that contains more specific detail about the error
+        attr_accessor :sub_category
+
+        # further information about the error
+        attr_accessor :errors
+
+        # Context about the error condition
+        attr_accessor :context
+
+        # A map of link names to associated URIs containing documentation about the error or recommended remediation steps
+        attr_accessor :links
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'message' => :'message',
+            :'correlation_id' => :'correlationId',
+            :'category' => :'category',
+            :'sub_category' => :'subCategory',
+            :'errors' => :'errors',
+            :'context' => :'context',
+            :'links' => :'links'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'message' => :'String',
+            :'correlation_id' => :'String',
+            :'category' => :'String',
+            :'sub_category' => :'String',
+            :'errors' => :'Array<ErrorDetail>',
+            :'context' => :'Hash<String, Array<String>>',
+            :'links' => :'Hash<String, 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 `Hubspot::Conversations::VisitorIdentification::Error` 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 `Hubspot::Conversations::VisitorIdentification::Error`. 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?(:'message')
+            self.message = attributes[:'message']
+          end
+
+          if attributes.key?(:'correlation_id')
+            self.correlation_id = attributes[:'correlation_id']
+          end
+
+          if attributes.key?(:'category')
+            self.category = attributes[:'category']
+          end
+
+          if attributes.key?(:'sub_category')
+            self.sub_category = attributes[:'sub_category']
+          end
+
+          if attributes.key?(:'errors')
+            if (value = attributes[:'errors']).is_a?(Array)
+              self.errors = value
+            end
+          end
+
+          if attributes.key?(:'context')
+            if (value = attributes[:'context']).is_a?(Hash)
+              self.context = value
+            end
+          end
+
+          if attributes.key?(:'links')
+            if (value = attributes[:'links']).is_a?(Hash)
+              self.links = value
+            end
+          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 @message.nil?
+            invalid_properties.push('invalid value for "message", message cannot be nil.')
+          end
+
+          if @correlation_id.nil?
+            invalid_properties.push('invalid value for "correlation_id", correlation_id cannot be nil.')
+          end
+
+          if @category.nil?
+            invalid_properties.push('invalid value for "category", category 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 @message.nil?
+          return false if @correlation_id.nil?
+          return false if @category.nil?
+          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 &&
+              message == o.message &&
+              correlation_id == o.correlation_id &&
+              category == o.category &&
+              sub_category == o.sub_category &&
+              errors == o.errors &&
+              context == o.context &&
+              links == o.links
+        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
+          [message, correlation_id, category, sub_category, errors, context, links].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
+            Hubspot::Conversations::VisitorIdentification.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
+  end
+end