hubspot-api-client 19.0.0 → 20.0.0.pre.beta.1

data/lib/hubspot/codegen/crm/objects/deal_splits/models/standard_error.rb

@@ -0,0 +1,331 @@
+=begin
+#CRM Deal Splits
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+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 Crm
+    module Objects
+      module DealSplits
+        class StandardError
+          # A specific category that contains more specific detail about the error
+          attr_accessor :sub_category
+
+          # 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
+
+          # The id of the error
+          attr_accessor :id
+
+          # The error category
+          attr_accessor :category
+
+          # The error message
+          attr_accessor :message
+
+          attr_accessor :errors
+
+          # A human readable message describing the error along with remediation steps where appropriate
+          attr_accessor :status
+
+          # Attribute mapping from ruby-style variable name to JSON key.
+          def self.attribute_map
+            {
+              :'sub_category' => :'subCategory',
+              :'context' => :'context',
+              :'links' => :'links',
+              :'id' => :'id',
+              :'category' => :'category',
+              :'message' => :'message',
+              :'errors' => :'errors',
+              :'status' => :'status'
+            }
+          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
+            {
+              :'sub_category' => :'Object',
+              :'context' => :'Hash<String, Array<String>>',
+              :'links' => :'Hash<String, String>',
+              :'id' => :'String',
+              :'category' => :'String',
+              :'message' => :'String',
+              :'errors' => :'Array<ErrorDetail>',
+              :'status' => :'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::Crm::Objects::DealSplits::StandardError` 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::Crm::Objects::DealSplits::StandardError`. 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?(:'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
+
+            if attributes.key?(:'id')
+              self.id = attributes[:'id']
+            end
+
+            if attributes.key?(:'category')
+              self.category = attributes[:'category']
+            end
+
+            if attributes.key?(:'message')
+              self.message = attributes[:'message']
+            end
+
+            if attributes.key?(:'errors')
+              if (value = attributes[:'errors']).is_a?(Array)
+                self.errors = value
+              end
+            end
+
+            if attributes.key?(:'status')
+              self.status = attributes[:'status']
+            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 @context.nil?
+              invalid_properties.push('invalid value for "context", context cannot be nil.')
+            end
+
+            if @links.nil?
+              invalid_properties.push('invalid value for "links", links cannot be nil.')
+            end
+
+            if @category.nil?
+              invalid_properties.push('invalid value for "category", category cannot be nil.')
+            end
+
+            if @message.nil?
+              invalid_properties.push('invalid value for "message", message cannot be nil.')
+            end
+
+            if @errors.nil?
+              invalid_properties.push('invalid value for "errors", errors cannot be nil.')
+            end
+
+            if @status.nil?
+              invalid_properties.push('invalid value for "status", status 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 @context.nil?
+            return false if @links.nil?
+            return false if @category.nil?
+            return false if @message.nil?
+            return false if @errors.nil?
+            return false if @status.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 &&
+                context == o.context &&
+                links == o.links &&
+                id == o.id &&
+                category == o.category &&
+                message == o.message &&
+                errors == o.errors &&
+                status == o.status
+          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, context, links, id, category, message, errors, status].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::Crm::Objects::DealSplits.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
+end

data/lib/hubspot/codegen/crm/objects/deal_splits/models/value_with_timestamp.rb

@@ -0,0 +1,285 @@
+=begin
+#CRM Deal Splits
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+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 Crm
+    module Objects
+      module DealSplits
+        class ValueWithTimestamp
+          attr_accessor :source_id
+
+          attr_accessor :source_type
+
+          attr_accessor :source_label
+
+          attr_accessor :updated_by_user_id
+
+          attr_accessor :value
+
+          attr_accessor :timestamp
+
+          # Attribute mapping from ruby-style variable name to JSON key.
+          def self.attribute_map
+            {
+              :'source_id' => :'sourceId',
+              :'source_type' => :'sourceType',
+              :'source_label' => :'sourceLabel',
+              :'updated_by_user_id' => :'updatedByUserId',
+              :'value' => :'value',
+              :'timestamp' => :'timestamp'
+            }
+          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
+            {
+              :'source_id' => :'String',
+              :'source_type' => :'String',
+              :'source_label' => :'String',
+              :'updated_by_user_id' => :'Integer',
+              :'value' => :'String',
+              :'timestamp' => :'Time'
+            }
+          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::Crm::Objects::DealSplits::ValueWithTimestamp` 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::Crm::Objects::DealSplits::ValueWithTimestamp`. 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?(:'source_id')
+              self.source_id = attributes[:'source_id']
+            end
+
+            if attributes.key?(:'source_type')
+              self.source_type = attributes[:'source_type']
+            end
+
+            if attributes.key?(:'source_label')
+              self.source_label = attributes[:'source_label']
+            end
+
+            if attributes.key?(:'updated_by_user_id')
+              self.updated_by_user_id = attributes[:'updated_by_user_id']
+            end
+
+            if attributes.key?(:'value')
+              self.value = attributes[:'value']
+            end
+
+            if attributes.key?(:'timestamp')
+              self.timestamp = attributes[:'timestamp']
+            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 @source_type.nil?
+              invalid_properties.push('invalid value for "source_type", source_type cannot be nil.')
+            end
+
+            if @value.nil?
+              invalid_properties.push('invalid value for "value", value cannot be nil.')
+            end
+
+            if @timestamp.nil?
+              invalid_properties.push('invalid value for "timestamp", timestamp 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 @source_type.nil?
+            return false if @value.nil?
+            return false if @timestamp.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 &&
+                source_id == o.source_id &&
+                source_type == o.source_type &&
+                source_label == o.source_label &&
+                updated_by_user_id == o.updated_by_user_id &&
+                value == o.value &&
+                timestamp == o.timestamp
+          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
+            [source_id, source_type, source_label, updated_by_user_id, value, timestamp].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::Crm::Objects::DealSplits.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
+end

data/lib/hubspot/codegen/crm/objects/emails/api/basic_api.rb

@@ -17,6 +17,7 @@ module Hubspot
     module Objects
       module Emails
         class BasicApi
+          require 'hubspot/helpers/get_all_helper'
           include Hubspot::Helpers::GetAllHelper
 
           attr_accessor :api_client
@@ -163,7 +164,7 @@ module Hubspot
           # @option opts [Array<String>] :properties_with_history A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
           # @option opts [Array<String>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
           # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
-          # @option opts [String] :id_property The name of a property whose values are unique for this object type
+          # @option opts [String] :id_property The name of a property whose values are unique for this object
           # @return [SimplePublicObjectWithAssociations]
           def get_by_id(email_id, opts = {})
             data, _status_code, _headers = get_by_id_with_http_info(email_id, opts)
@@ -178,7 +179,7 @@ module Hubspot
           # @option opts [Array<String>] :properties_with_history A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
           # @option opts [Array<String>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
           # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
-          # @option opts [String] :id_property The name of a property whose values are unique for this object type
+          # @option opts [String] :id_property The name of a property whose values are unique for this object
           # @return [Array<(SimplePublicObjectWithAssociations, Integer, Hash)>] SimplePublicObjectWithAssociations data, response status code and response headers
           def get_by_id_with_http_info(email_id, opts = {})
             if @api_client.config.debugging
@@ -309,11 +310,11 @@ module Hubspot
           end
 
           # Update
-          # Perform a partial update of an Object identified by `{emailId}`. `{emailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
+          # Perform a partial update of an Object identified by `{emailId}`or optionally a unique property value as specified by the `idProperty` query param. `{emailId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
           # @param email_id [String] 
           # @param simple_public_object_input [SimplePublicObjectInput] 
           # @param [Hash] opts the optional parameters
-          # @option opts [String] :id_property The name of a property whose values are unique for this object type
+          # @option opts [String] :id_property The name of a property whose values are unique for this object
           # @return [SimplePublicObject]
           def update(email_id, simple_public_object_input, opts = {})
             data, _status_code, _headers = update_with_http_info(email_id, simple_public_object_input, opts)
@@ -321,11 +322,11 @@ module Hubspot
           end
 
           # Update
-          # Perform a partial update of an Object identified by &#x60;{emailId}&#x60;. &#x60;{emailId}&#x60; refers to the internal object ID by default, or optionally any unique property value as specified by the &#x60;idProperty&#x60; query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
+          # Perform a partial update of an Object identified by &#x60;{emailId}&#x60;or optionally a unique property value as specified by the &#x60;idProperty&#x60; query param. &#x60;{emailId}&#x60; refers to the internal object ID by default, and the &#x60;idProperty&#x60; query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
           # @param email_id [String] 
           # @param simple_public_object_input [SimplePublicObjectInput] 
           # @param [Hash] opts the optional parameters
-          # @option opts [String] :id_property The name of a property whose values are unique for this object type
+          # @option opts [String] :id_property The name of a property whose values are unique for this object
           # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
           def update_with_http_info(email_id, simple_public_object_input, opts = {})
             if @api_client.config.debugging