hubspot-api-client 19.0.0 → 20.0.0

data/lib/hubspot/codegen/crm/objects/goals/models/simple_public_upsert_object.rb

@@ -0,0 +1,326 @@
+=begin
+#Goal Targets
+
+#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 Goals
+        class SimplePublicUpsertObject
+          attr_accessor :created_at
+
+          attr_accessor :archived
+
+          attr_accessor :archived_at
+
+          attr_accessor :new
+
+          attr_accessor :properties_with_history
+
+          attr_accessor :id
+
+          attr_accessor :object_write_trace_id
+
+          attr_accessor :properties
+
+          attr_accessor :updated_at
+
+          # Attribute mapping from ruby-style variable name to JSON key.
+          def self.attribute_map
+            {
+              :'created_at' => :'createdAt',
+              :'archived' => :'archived',
+              :'archived_at' => :'archivedAt',
+              :'new' => :'new',
+              :'properties_with_history' => :'propertiesWithHistory',
+              :'id' => :'id',
+              :'object_write_trace_id' => :'objectWriteTraceId',
+              :'properties' => :'properties',
+              :'updated_at' => :'updatedAt'
+            }
+          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
+            {
+              :'created_at' => :'Time',
+              :'archived' => :'Boolean',
+              :'archived_at' => :'Time',
+              :'new' => :'Boolean',
+              :'properties_with_history' => :'Hash<String, Array<ValueWithTimestamp>>',
+              :'id' => :'String',
+              :'object_write_trace_id' => :'String',
+              :'properties' => :'Hash<String, String>',
+              :'updated_at' => :'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::Goals::SimplePublicUpsertObject` 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::Goals::SimplePublicUpsertObject`. 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?(:'created_at')
+              self.created_at = attributes[:'created_at']
+            end
+
+            if attributes.key?(:'archived')
+              self.archived = attributes[:'archived']
+            end
+
+            if attributes.key?(:'archived_at')
+              self.archived_at = attributes[:'archived_at']
+            end
+
+            if attributes.key?(:'new')
+              self.new = attributes[:'new']
+            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?(:'id')
+              self.id = attributes[:'id']
+            end
+
+            if attributes.key?(:'object_write_trace_id')
+              self.object_write_trace_id = attributes[:'object_write_trace_id']
+            end
+
+            if attributes.key?(:'properties')
+              if (value = attributes[:'properties']).is_a?(Hash)
+                self.properties = value
+              end
+            end
+
+            if attributes.key?(:'updated_at')
+              self.updated_at = attributes[:'updated_at']
+            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 @created_at.nil?
+              invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+            end
+
+            if @new.nil?
+              invalid_properties.push('invalid value for "new", new cannot be nil.')
+            end
+
+            if @id.nil?
+              invalid_properties.push('invalid value for "id", id cannot be nil.')
+            end
+
+            if @properties.nil?
+              invalid_properties.push('invalid value for "properties", properties cannot be nil.')
+            end
+
+            if @updated_at.nil?
+              invalid_properties.push('invalid value for "updated_at", updated_at 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 @created_at.nil?
+            return false if @new.nil?
+            return false if @id.nil?
+            return false if @properties.nil?
+            return false if @updated_at.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 &&
+                created_at == o.created_at &&
+                archived == o.archived &&
+                archived_at == o.archived_at &&
+                new == o.new &&
+                properties_with_history == o.properties_with_history &&
+                id == o.id &&
+                object_write_trace_id == o.object_write_trace_id &&
+                properties == o.properties &&
+                updated_at == o.updated_at
+          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
+            [created_at, archived, archived_at, new, properties_with_history, id, object_write_trace_id, properties, updated_at].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::Goals.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/leads/api/basic_api.rb

@@ -17,6 +17,7 @@ module Hubspot
     module Objects
       module Leads
         class BasicApi
+          require 'hubspot/helpers/get_all_helper'
           include Hubspot::Helpers::GetAllHelper
 
           attr_accessor :api_client

data/lib/hubspot/codegen/crm/objects/leads/api/batch_api.rb

@@ -89,25 +89,25 @@ module Hubspot
           end
 
           # Create a batch of leads
-          # @param batch_input_simple_public_object_input_for_create [BatchInputSimplePublicObjectInputForCreate] 
+          # @param batch_input_simple_public_object_batch_input_for_create [BatchInputSimplePublicObjectBatchInputForCreate] 
           # @param [Hash] opts the optional parameters
           # @return [BatchResponseSimplePublicObject]
-          def create(batch_input_simple_public_object_input_for_create, opts = {})
-            data, _status_code, _headers = create_with_http_info(batch_input_simple_public_object_input_for_create, opts)
+          def create(batch_input_simple_public_object_batch_input_for_create, opts = {})
+            data, _status_code, _headers = create_with_http_info(batch_input_simple_public_object_batch_input_for_create, opts)
             data
           end
 
           # Create a batch of leads
-          # @param batch_input_simple_public_object_input_for_create [BatchInputSimplePublicObjectInputForCreate] 
+          # @param batch_input_simple_public_object_batch_input_for_create [BatchInputSimplePublicObjectBatchInputForCreate] 
           # @param [Hash] opts the optional parameters
           # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
-          def create_with_http_info(batch_input_simple_public_object_input_for_create, opts = {})
+          def create_with_http_info(batch_input_simple_public_object_batch_input_for_create, opts = {})
             if @api_client.config.debugging
               @api_client.config.logger.debug 'Calling API: BatchApi.create ...'
             end
-            # verify the required parameter 'batch_input_simple_public_object_input_for_create' is set
-            if @api_client.config.client_side_validation && batch_input_simple_public_object_input_for_create.nil?
-              fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_input_for_create' when calling BatchApi.create"
+            # verify the required parameter 'batch_input_simple_public_object_batch_input_for_create' is set
+            if @api_client.config.client_side_validation && batch_input_simple_public_object_batch_input_for_create.nil?
+              fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_batch_input_for_create' when calling BatchApi.create"
             end
             # resource path
             local_var_path = '/crm/v3/objects/leads/batch/create'
@@ -129,7 +129,7 @@ module Hubspot
             form_params = opts[:form_params] || {}
 
             # http body (model)
-            post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_simple_public_object_input_for_create)
+            post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_simple_public_object_batch_input_for_create)
 
             # return_type
             return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject'
@@ -155,6 +155,7 @@ module Hubspot
           end
 
           # Read a batch of leads by internal ID, or unique property values
+          # Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. 
           # @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId] 
           # @param [Hash] opts the optional parameters
           # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
@@ -165,6 +166,7 @@ module Hubspot
           end
 
           # Read a batch of leads by internal ID, or unique property values
+          # Retrieve records by record ID or include the &#x60;idProperty&#x60; parameter to retrieve records by a custom unique value property. 
           # @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId] 
           # @param [Hash] opts the optional parameters
           # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
@@ -290,7 +292,7 @@ module Hubspot
           end
 
           # Create or update a batch of leads by unique property values
-          # Create or update records identified by `{leadsId}` or optionally a unique property value as specified by the `idProperty` query param. `{leadsId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object.
+          # Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
           # @param batch_input_simple_public_object_batch_input_upsert [BatchInputSimplePublicObjectBatchInputUpsert] 
           # @param [Hash] opts the optional parameters
           # @return [BatchResponseSimplePublicUpsertObject]
@@ -300,7 +302,7 @@ module Hubspot
           end
 
           # Create or update a batch of leads by unique property values
-          # Create or update records identified by &#x60;{leadsId}&#x60; or optionally a unique property value as specified by the &#x60;idProperty&#x60; query param. &#x60;{leadsId}&#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.
+          # Create or update records identified by a unique property value as specified by the &#x60;idProperty&#x60; query param. &#x60;idProperty&#x60; query param refers to a property whose values are unique for the object.
           # @param batch_input_simple_public_object_batch_input_upsert [BatchInputSimplePublicObjectBatchInputUpsert] 
           # @param [Hash] opts the optional parameters
           # @return [Array<(BatchResponseSimplePublicUpsertObject, Integer, Hash)>] BatchResponseSimplePublicUpsertObject data, response status code and response headers

data/lib/hubspot/codegen/crm/objects/leads/models/{batch_input_simple_public_object_input_for_create.rb → batch_input_simple_public_object_batch_input_for_create.rb}

@@ -17,7 +17,7 @@ module Hubspot
   module Crm
     module Objects
       module Leads
-        class BatchInputSimplePublicObjectInputForCreate
+        class BatchInputSimplePublicObjectBatchInputForCreate
           attr_accessor :inputs
 
           # Attribute mapping from ruby-style variable name to JSON key.
@@ -35,7 +35,7 @@ module Hubspot
           # Attribute type mapping.
           def self.openapi_types
             {
-              :'inputs' => :'Array<SimplePublicObjectInputForCreate>'
+              :'inputs' => :'Array<SimplePublicObjectBatchInputForCreate>'
             }
           end
 
@@ -49,13 +49,13 @@ module Hubspot
           # @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::Leads::BatchInputSimplePublicObjectInputForCreate` initialize method"
+              fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Objects::Leads::BatchInputSimplePublicObjectBatchInputForCreate` 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::Leads::BatchInputSimplePublicObjectInputForCreate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+                fail ArgumentError, "`#{k}` is not a valid attribute in `Hubspot::Crm::Objects::Leads::BatchInputSimplePublicObjectBatchInputForCreate`. 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
             }

data/lib/hubspot/codegen/crm/objects/leads/models/batch_read_input_simple_public_object_id.rb

@@ -20,6 +20,7 @@ module Hubspot
         class BatchReadInputSimplePublicObjectId
           attr_accessor :properties_with_history
 
+          # When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
           attr_accessor :id_property
 
           attr_accessor :inputs

data/lib/hubspot/codegen/crm/objects/leads/models/simple_public_object.rb

@@ -28,6 +28,8 @@ module Hubspot
 
           attr_accessor :id
 
+          attr_accessor :object_write_trace_id
+
           attr_accessor :properties
 
           attr_accessor :updated_at
@@ -40,6 +42,7 @@ module Hubspot
               :'archived_at' => :'archivedAt',
               :'properties_with_history' => :'propertiesWithHistory',
               :'id' => :'id',
+              :'object_write_trace_id' => :'objectWriteTraceId',
               :'properties' => :'properties',
               :'updated_at' => :'updatedAt'
             }
@@ -58,6 +61,7 @@ module Hubspot
               :'archived_at' => :'Time',
               :'properties_with_history' => :'Hash<String, Array<ValueWithTimestamp>>',
               :'id' => :'String',
+              :'object_write_trace_id' => :'String',
               :'properties' => :'Hash<String, String>',
               :'updated_at' => :'Time'
             }
@@ -106,6 +110,10 @@ module Hubspot
               self.id = attributes[:'id']
             end
 
+            if attributes.key?(:'object_write_trace_id')
+              self.object_write_trace_id = attributes[:'object_write_trace_id']
+            end
+
             if attributes.key?(:'properties')
               if (value = attributes[:'properties']).is_a?(Hash)
                 self.properties = value
@@ -160,6 +168,7 @@ module Hubspot
                 archived_at == o.archived_at &&
                 properties_with_history == o.properties_with_history &&
                 id == o.id &&
+                object_write_trace_id == o.object_write_trace_id &&
                 properties == o.properties &&
                 updated_at == o.updated_at
           end
@@ -173,7 +182,7 @@ module Hubspot
           # Calculates hash code according to all attributes.
           # @return [Integer] Hash code
           def hash
-            [created_at, archived, archived_at, properties_with_history, id, properties, updated_at].hash
+            [created_at, archived, archived_at, properties_with_history, id, object_write_trace_id, properties, updated_at].hash
           end
 
           # Builds the object from hash

data/lib/hubspot/codegen/crm/objects/leads/models/simple_public_object_batch_input.rb

@@ -18,10 +18,12 @@ module Hubspot
     module Objects
       module Leads
         class SimplePublicObjectBatchInput
+          # The name of a property whose values are unique for this object
           attr_accessor :id_property
 
           attr_accessor :object_write_trace_id
 
+          # The id to be updated. This can be the object id, or the unique property value of the idProperty property
           attr_accessor :id
 
           attr_accessor :properties