hubspot-api-client 1.0.1

data/lib/hubspot/codegen/crm/objects/models/error.rb

@@ -0,0 +1,286 @@
+=begin
+#CRM Objects
+
+#CRM objects such as companies, contacts, deals, line items, products, tickets, and quotes are native objects in HubSpot’s CRM. These core building blocks support custom properties, store critical information, and play a central role in the HubSpot application.  ## Supported Object Types  This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the [CRM Object Properties API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview).  |Object Type |Properties returned by default | |--|--| | `companies` | `name`, `domain` | | `contacts` | `firstname`, `lastname`, `email` | | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` | | `products` | `name`, `description`, `price` | | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`, `hs_ticket_category`, `hs_ticket_priority`, `subject` |  Find a list of all properties for an object type using the [CRM Object Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties) API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`. Change the properties returned in the response using the `properties` array in the request body.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Client
+    module Crm
+      module Objects
+        module Models
+          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
+
+            # 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',
+                :'errors' => :'errors',
+                :'context' => :'context',
+                :'links' => :'links'
+              }
+            end
+
+            # Attribute type mapping.
+            def self.openapi_types
+              {
+                :'message' => :'String',
+                :'correlation_id' => :'String',
+                :'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::Client::Crm::Objects::Models::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::Client::Crm::Objects::Models::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?(:'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 &&
+                  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, 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::Client::Crm::Objects::Models.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
+  end
+end

data/lib/hubspot/codegen/crm/objects/models/error_detail.rb

@@ -0,0 +1,265 @@
+=begin
+#CRM Objects
+
+#CRM objects such as companies, contacts, deals, line items, products, tickets, and quotes are native objects in HubSpot’s CRM. These core building blocks support custom properties, store critical information, and play a central role in the HubSpot application.  ## Supported Object Types  This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the [CRM Object Properties API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview).  |Object Type |Properties returned by default | |--|--| | `companies` | `name`, `domain` | | `contacts` | `firstname`, `lastname`, `email` | | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` | | `products` | `name`, `description`, `price` | | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`, `hs_ticket_category`, `hs_ticket_priority`, `subject` |  Find a list of all properties for an object type using the [CRM Object Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties) API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`. Change the properties returned in the response using the `properties` array in the request body.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Client
+    module Crm
+      module Objects
+        module Models
+          class ErrorDetail
+            attr_accessor :sub_category
+
+            # A human readable message describing the error along with remediation steps where appropriate
+            attr_accessor :message
+
+            attr_accessor :code
+
+            # The name of the field or parameter in which the error was found.
+            attr_accessor :_in
+
+            # Context about the error condition
+            attr_accessor :context
+
+            # Attribute mapping from ruby-style variable name to JSON key.
+            def self.attribute_map
+              {
+                :'sub_category' => :'subCategory',
+                :'message' => :'message',
+                :'code' => :'code',
+                :'_in' => :'in',
+                :'context' => :'context'
+              }
+            end
+
+            # Attribute type mapping.
+            def self.openapi_types
+              {
+                :'sub_category' => :'String',
+                :'message' => :'String',
+                :'code' => :'String',
+                :'_in' => :'String',
+                :'context' => :'Hash<String, Array<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::Client::Crm::Objects::Models::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::Client::Crm::Objects::Models::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?(:'sub_category')
+                self.sub_category = attributes[:'sub_category']
+              end
+
+              if attributes.key?(:'message')
+                self.message = attributes[:'message']
+              end
+
+              if attributes.key?(:'code')
+                self.code = attributes[:'code']
+              end
+
+              if attributes.key?(:'_in')
+                self._in = attributes[:'_in']
+              end
+
+              if attributes.key?(:'context')
+                if (value = attributes[:'context']).is_a?(Hash)
+                  self.context = 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 @context.nil?
+                invalid_properties.push('invalid value for "context", context 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 @context.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 &&
+                  sub_category == o.sub_category &&
+                  message == o.message &&
+                  code == o.code &&
+                  _in == o._in &&
+                  context == o.context
+            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
+              [sub_category, message, code, _in, context].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::Client::Crm::Objects::Models.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
+  end
+end