hubspot-api-client 11.2.0 → 12.0.0

data/lib/hubspot/codegen/crm/contacts/models/public_merge_input.rb

@@ -0,0 +1,229 @@
+=begin
+#Contacts
+
+#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: 4.3.1
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Crm
+    module Contacts
+      class PublicMergeInput
+        attr_accessor :primary_object_id
+
+        attr_accessor :object_id_to_merge
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'primary_object_id' => :'primaryObjectId',
+            :'object_id_to_merge' => :'objectIdToMerge'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'primary_object_id' => :'String',
+            :'object_id_to_merge' => :'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::Contacts::PublicMergeInput` 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::Contacts::PublicMergeInput`. 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?(:'primary_object_id')
+            self.primary_object_id = attributes[:'primary_object_id']
+          end
+
+          if attributes.key?(:'object_id_to_merge')
+            self.object_id_to_merge = attributes[:'object_id_to_merge']
+          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 @primary_object_id.nil?
+            invalid_properties.push('invalid value for "primary_object_id", primary_object_id cannot be nil.')
+          end
+
+          if @object_id_to_merge.nil?
+            invalid_properties.push('invalid value for "object_id_to_merge", object_id_to_merge 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 @primary_object_id.nil?
+          return false if @object_id_to_merge.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 &&
+              primary_object_id == o.primary_object_id &&
+              object_id_to_merge == o.object_id_to_merge
+        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
+          [primary_object_id, object_id_to_merge].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::Crm::Contacts.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

data/lib/hubspot/codegen/crm/contacts/models/simple_public_object.rb

@@ -20,6 +20,8 @@ module Hubspot
 
         attr_accessor :properties
 
+        attr_accessor :properties_with_history
+
         attr_accessor :created_at
 
         attr_accessor :updated_at
@@ -33,6 +35,7 @@ module Hubspot
           {
             :'id' => :'id',
             :'properties' => :'properties',
+            :'properties_with_history' => :'propertiesWithHistory',
             :'created_at' => :'createdAt',
             :'updated_at' => :'updatedAt',
             :'archived' => :'archived',
@@ -45,6 +48,7 @@ module Hubspot
           {
             :'id' => :'String',
             :'properties' => :'Hash<String, String>',
+            :'properties_with_history' => :'Hash<String, Array<ValueWithTimestamp>>',
             :'created_at' => :'DateTime',
             :'updated_at' => :'DateTime',
             :'archived' => :'Boolean',
@@ -83,6 +87,12 @@ module Hubspot
             end
           end
 
+          if attributes.key?(:'properties_with_history')
+            if (value = attributes[:'properties_with_history']).is_a?(Hash)
+              self.properties_with_history = value
+            end
+          end
+
           if attributes.key?(:'created_at')
             self.created_at = attributes[:'created_at']
           end
@@ -140,6 +150,7 @@ module Hubspot
           self.class == o.class &&
               id == o.id &&
               properties == o.properties &&
+              properties_with_history == o.properties_with_history &&
               created_at == o.created_at &&
               updated_at == o.updated_at &&
               archived == o.archived &&
@@ -155,7 +166,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [id, properties, created_at, updated_at, archived, archived_at].hash
+          [id, properties, properties_with_history, created_at, updated_at, archived, archived_at].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/contacts/models/simple_public_object_with_associations.rb

@@ -20,6 +20,8 @@ module Hubspot
 
         attr_accessor :properties
 
+        attr_accessor :properties_with_history
+
         attr_accessor :created_at
 
         attr_accessor :updated_at
@@ -35,6 +37,7 @@ module Hubspot
           {
             :'id' => :'id',
             :'properties' => :'properties',
+            :'properties_with_history' => :'propertiesWithHistory',
             :'created_at' => :'createdAt',
             :'updated_at' => :'updatedAt',
             :'archived' => :'archived',
@@ -48,6 +51,7 @@ module Hubspot
           {
             :'id' => :'String',
             :'properties' => :'Hash<String, String>',
+            :'properties_with_history' => :'Hash<String, Array<ValueWithTimestamp>>',
             :'created_at' => :'DateTime',
             :'updated_at' => :'DateTime',
             :'archived' => :'Boolean',
@@ -87,6 +91,12 @@ module Hubspot
             end
           end
 
+          if attributes.key?(:'properties_with_history')
+            if (value = attributes[:'properties_with_history']).is_a?(Hash)
+              self.properties_with_history = value
+            end
+          end
+
           if attributes.key?(:'created_at')
             self.created_at = attributes[:'created_at']
           end
@@ -150,6 +160,7 @@ module Hubspot
           self.class == o.class &&
               id == o.id &&
               properties == o.properties &&
+              properties_with_history == o.properties_with_history &&
               created_at == o.created_at &&
               updated_at == o.updated_at &&
               archived == o.archived &&
@@ -166,7 +177,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [id, properties, created_at, updated_at, archived, archived_at, associations].hash
+          [id, properties, properties_with_history, created_at, updated_at, archived, archived_at, associations].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/contacts/models/value_with_timestamp.rb

@@ -0,0 +1,270 @@
+=begin
+#Contacts
+
+#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: 4.3.1
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Crm
+    module Contacts
+      class ValueWithTimestamp
+        attr_accessor :value
+
+        attr_accessor :timestamp
+
+        attr_accessor :source_type
+
+        attr_accessor :source_id
+
+        attr_accessor :source_label
+
+        attr_accessor :updated_by_user_id
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'value' => :'value',
+            :'timestamp' => :'timestamp',
+            :'source_type' => :'sourceType',
+            :'source_id' => :'sourceId',
+            :'source_label' => :'sourceLabel',
+            :'updated_by_user_id' => :'updatedByUserId'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'value' => :'String',
+            :'timestamp' => :'DateTime',
+            :'source_type' => :'String',
+            :'source_id' => :'String',
+            :'source_label' => :'String',
+            :'updated_by_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::Crm::Contacts::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::Contacts::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?(:'value')
+            self.value = attributes[:'value']
+          end
+
+          if attributes.key?(:'timestamp')
+            self.timestamp = attributes[:'timestamp']
+          end
+
+          if attributes.key?(:'source_type')
+            self.source_type = attributes[:'source_type']
+          end
+
+          if attributes.key?(:'source_id')
+            self.source_id = attributes[:'source_id']
+          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
+        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 @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
+
+          if @source_type.nil?
+            invalid_properties.push('invalid value for "source_type", source_type 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 @value.nil?
+          return false if @timestamp.nil?
+          return false if @source_type.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 &&
+              value == o.value &&
+              timestamp == o.timestamp &&
+              source_type == o.source_type &&
+              source_id == o.source_id &&
+              source_label == o.source_label &&
+              updated_by_user_id == o.updated_by_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
+          [value, timestamp, source_type, source_id, source_label, updated_by_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)
+          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::Crm::Contacts.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

data/lib/hubspot/codegen/crm/deals/api/basic_api.rb

@@ -154,6 +154,7 @@ module Hubspot
         # @param deal_id [String] 
         # @param [Hash] opts the optional parameters
         # @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
+        # @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
@@ -168,6 +169,7 @@ module Hubspot
         # @param deal_id [String] 
         # @param [Hash] opts the optional parameters
         # @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
+        # @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.
         # @option opts [String] :id_property The name of a property whose values are unique for this object type
@@ -186,6 +188,7 @@ module Hubspot
           # query parameters
           query_params = opts[:query_params] || {}
           query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
+          query_params[:'propertiesWithHistory'] = @api_client.build_collection_param(opts[:'properties_with_history'], :multi) if !opts[:'properties_with_history'].nil?
           query_params[:'associations'] = @api_client.build_collection_param(opts[:'associations'], :multi) if !opts[:'associations'].nil?
           query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
           query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].nil?
@@ -229,6 +232,7 @@ module Hubspot
         # @option opts [Integer] :limit The maximum number of results to display per page. (default to 10)
         # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
         # @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
+        # @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. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
         # @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)
         # @return [CollectionResponseSimplePublicObjectWithAssociationsForwardPaging]
@@ -243,6 +247,7 @@ module Hubspot
         # @option opts [Integer] :limit The maximum number of results to display per page.
         # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
         # @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
+        # @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. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
         # @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.
         # @return [Array<(CollectionResponseSimplePublicObjectWithAssociationsForwardPaging, Integer, Hash)>] CollectionResponseSimplePublicObjectWithAssociationsForwardPaging data, response status code and response headers
@@ -258,6 +263,7 @@ module Hubspot
           query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
           query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
           query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
+          query_params[:'propertiesWithHistory'] = @api_client.build_collection_param(opts[:'properties_with_history'], :multi) if !opts[:'properties_with_history'].nil?
           query_params[:'associations'] = @api_client.build_collection_param(opts[:'associations'], :multi) if !opts[:'associations'].nil?
           query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?