hubspot-api-client 20.0.0 → 20.1.0

data/lib/hubspot/codegen/oauth/v3/models/error_detail.rb

@@ -0,0 +1,272 @@
+=begin
+#Auth Oauth
+
+#Basepom for all HubSpot Projects
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Hubspot
+  module Oauth
+    module V3
+      # Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
+      class ErrorDetail
+        # The status code associated with the error detail
+        attr_accessor :code
+
+        # Context about the error condition
+        attr_accessor :context
+
+        # The name of the field or parameter in which the error was found.
+        attr_accessor :_in
+
+        # A human readable message describing the error along with remediation steps where appropriate
+        attr_accessor :message
+
+        # A specific category that contains more specific detail about the error
+        attr_accessor :sub_category
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'code' => :'code',
+            :'context' => :'context',
+            :'_in' => :'in',
+            :'message' => :'message',
+            :'sub_category' => :'subCategory'
+          }
+        end
+
+        # Returns all the JSON keys this model knows about
+        def self.acceptable_attributes
+          attribute_map.values
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'code' => :'String',
+            :'context' => :'Hash<String, Array<String>>',
+            :'_in' => :'String',
+            :'message' => :'String',
+            :'sub_category' => :'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::Oauth::V3::ErrorDetail` 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::Oauth::V3::ErrorDetail`. 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?(:'code')
+            self.code = attributes[:'code']
+          end
+
+          if attributes.key?(:'context')
+            if (value = attributes[:'context']).is_a?(Hash)
+              self.context = value
+            end
+          end
+
+          if attributes.key?(:'_in')
+            self._in = attributes[:'_in']
+          end
+
+          if attributes.key?(:'message')
+            self.message = attributes[:'message']
+          end
+
+          if attributes.key?(:'sub_category')
+            self.sub_category = attributes[:'sub_category']
+          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
+
+          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?
+          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 &&
+              code == o.code &&
+              context == o.context &&
+              _in == o._in &&
+              message == o.message &&
+              sub_category == o.sub_category
+        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
+          [code, context, _in, message, sub_category].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)
+          attributes = attributes.transform_keys(&:to_sym)
+          self.class.openapi_types.each_pair do |key, type|
+            if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+              self.send("#{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) })
+              end
+            elsif !attributes[self.class.attribute_map[key]].nil?
+              self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+            end
+          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 :Time
+            Time.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
+            # models (e.g. Pet) or oneOf
+            klass = Hubspot::Oauth::V3.const_get(type)
+            klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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

data/lib/hubspot/codegen/oauth/v3/models/public_access_token_info_response.rb

@@ -0,0 +1,438 @@
+=begin
+#Auth Oauth
+
+#Basepom for all HubSpot Projects
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Hubspot
+  module Oauth
+    module V3
+      class PublicAccessTokenInfoResponse
+        attr_accessor :active
+
+        attr_accessor :app_id
+
+        attr_accessor :client_id
+
+        attr_accessor :expires_in
+
+        attr_accessor :hub_domain
+
+        attr_accessor :hub_id
+
+        attr_accessor :is_private_distribution
+
+        attr_accessor :scopes
+
+        attr_accessor :signed_access_token
+
+        attr_accessor :token
+
+        attr_accessor :token_type
+
+        attr_accessor :token_use
+
+        attr_accessor :user
+
+        attr_accessor :user_id
+
+        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
+          {
+            :'active' => :'active',
+            :'app_id' => :'app_id',
+            :'client_id' => :'client_id',
+            :'expires_in' => :'expires_in',
+            :'hub_domain' => :'hub_domain',
+            :'hub_id' => :'hub_id',
+            :'is_private_distribution' => :'is_private_distribution',
+            :'scopes' => :'scopes',
+            :'signed_access_token' => :'signed_access_token',
+            :'token' => :'token',
+            :'token_type' => :'token_type',
+            :'token_use' => :'token_use',
+            :'user' => :'user',
+            :'user_id' => :'user_id'
+          }
+        end
+
+        # Returns all the JSON keys this model knows about
+        def self.acceptable_attributes
+          attribute_map.values
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'active' => :'Boolean',
+            :'app_id' => :'Integer',
+            :'client_id' => :'String',
+            :'expires_in' => :'Integer',
+            :'hub_domain' => :'String',
+            :'hub_id' => :'Integer',
+            :'is_private_distribution' => :'Boolean',
+            :'scopes' => :'Array<String>',
+            :'signed_access_token' => :'SignedAccessToken',
+            :'token' => :'String',
+            :'token_type' => :'String',
+            :'token_use' => :'String',
+            :'user' => :'String',
+            :'user_id' => :'Integer'
+          }
+        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::Oauth::V3::PublicAccessTokenInfoResponse` 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::Oauth::V3::PublicAccessTokenInfoResponse`. 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?(:'active')
+            self.active = attributes[:'active']
+          end
+
+          if attributes.key?(:'app_id')
+            self.app_id = attributes[:'app_id']
+          end
+
+          if attributes.key?(:'client_id')
+            self.client_id = attributes[:'client_id']
+          end
+
+          if attributes.key?(:'expires_in')
+            self.expires_in = attributes[:'expires_in']
+          end
+
+          if attributes.key?(:'hub_domain')
+            self.hub_domain = attributes[:'hub_domain']
+          end
+
+          if attributes.key?(:'hub_id')
+            self.hub_id = attributes[:'hub_id']
+          end
+
+          if attributes.key?(:'is_private_distribution')
+            self.is_private_distribution = attributes[:'is_private_distribution']
+          end
+
+          if attributes.key?(:'scopes')
+            if (value = attributes[:'scopes']).is_a?(Array)
+              self.scopes = value
+            end
+          end
+
+          if attributes.key?(:'signed_access_token')
+            self.signed_access_token = attributes[:'signed_access_token']
+          end
+
+          if attributes.key?(:'token')
+            self.token = attributes[:'token']
+          end
+
+          if attributes.key?(:'token_type')
+            self.token_type = attributes[:'token_type']
+          end
+
+          if attributes.key?(:'token_use')
+            self.token_use = attributes[:'token_use']
+          else
+            self.token_use = 'access_token'
+          end
+
+          if attributes.key?(:'user')
+            self.user = attributes[:'user']
+          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 = Array.new
+          if @active.nil?
+            invalid_properties.push('invalid value for "active", active cannot be nil.')
+          end
+
+          if @app_id.nil?
+            invalid_properties.push('invalid value for "app_id", app_id cannot be nil.')
+          end
+
+          if @client_id.nil?
+            invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
+          end
+
+          if @expires_in.nil?
+            invalid_properties.push('invalid value for "expires_in", expires_in cannot be nil.')
+          end
+
+          if @hub_id.nil?
+            invalid_properties.push('invalid value for "hub_id", hub_id cannot be nil.')
+          end
+
+          if @is_private_distribution.nil?
+            invalid_properties.push('invalid value for "is_private_distribution", is_private_distribution cannot be nil.')
+          end
+
+          if @scopes.nil?
+            invalid_properties.push('invalid value for "scopes", scopes cannot be nil.')
+          end
+
+          if @signed_access_token.nil?
+            invalid_properties.push('invalid value for "signed_access_token", signed_access_token cannot be nil.')
+          end
+
+          if @token.nil?
+            invalid_properties.push('invalid value for "token", token cannot be nil.')
+          end
+
+          if @token_type.nil?
+            invalid_properties.push('invalid value for "token_type", token_type cannot be nil.')
+          end
+
+          if @token_use.nil?
+            invalid_properties.push('invalid value for "token_use", token_use cannot be nil.')
+          end
+
+          if @user_id.nil?
+            invalid_properties.push('invalid value for "user_id", user_id 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 @active.nil?
+          return false if @app_id.nil?
+          return false if @client_id.nil?
+          return false if @expires_in.nil?
+          return false if @hub_id.nil?
+          return false if @is_private_distribution.nil?
+          return false if @scopes.nil?
+          return false if @signed_access_token.nil?
+          return false if @token.nil?
+          return false if @token_type.nil?
+          return false if @token_use.nil?
+          token_use_validator = EnumAttributeValidator.new('String', ["access_token"])
+          return false unless token_use_validator.valid?(@token_use)
+          return false if @user_id.nil?
+          true
+        end
+
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] token_use Object to be assigned
+        def token_use=(token_use)
+          validator = EnumAttributeValidator.new('String', ["access_token"])
+          unless validator.valid?(token_use)
+            fail ArgumentError, "invalid value for \"token_use\", must be one of #{validator.allowable_values}."
+          end
+          @token_use = token_use
+        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 &&
+              active == o.active &&
+              app_id == o.app_id &&
+              client_id == o.client_id &&
+              expires_in == o.expires_in &&
+              hub_domain == o.hub_domain &&
+              hub_id == o.hub_id &&
+              is_private_distribution == o.is_private_distribution &&
+              scopes == o.scopes &&
+              signed_access_token == o.signed_access_token &&
+              token == o.token &&
+              token_type == o.token_type &&
+              token_use == o.token_use &&
+              user == o.user &&
+              user_id == o.user_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
+          [active, app_id, client_id, expires_in, hub_domain, hub_id, is_private_distribution, scopes, signed_access_token, token, token_type, token_use, user, 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)
+          attributes = attributes.transform_keys(&:to_sym)
+          self.class.openapi_types.each_pair do |key, type|
+            if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+              self.send("#{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) })
+              end
+            elsif !attributes[self.class.attribute_map[key]].nil?
+              self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+            end
+          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 :Time
+            Time.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
+            # models (e.g. Pet) or oneOf
+            klass = Hubspot::Oauth::V3.const_get(type)
+            klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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