hubspot-api-client 17.2.0 → 19.0.0

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

@@ -162,7 +162,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(product_id, opts = {})
           data, _status_code, _headers = get_by_id_with_http_info(product_id, opts)
@@ -177,7 +177,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(product_id, opts = {})
           if @api_client.config.debugging
@@ -308,11 +308,11 @@ module Hubspot
         end
 
         # Update
-        # Perform a partial update of an Object identified by `{productId}`. `{productId}` 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 `{productId}`. `{productId}` 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 result in an error. Properties values can be cleared by passing an empty string.
         # @param product_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(product_id, simple_public_object_input, opts = {})
           data, _status_code, _headers = update_with_http_info(product_id, simple_public_object_input, opts)
@@ -320,11 +320,11 @@ module Hubspot
         end
 
         # Update
-        # Perform a partial update of an Object identified by &#x60;{productId}&#x60;. &#x60;{productId}&#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;{productId}&#x60;. &#x60;{productId}&#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 result in an error. Properties values can be cleared by passing an empty string.
         # @param product_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(product_id, simple_public_object_input, opts = {})
           if @api_client.config.debugging

data/lib/hubspot/codegen/crm/products/api/batch_api.rb

@@ -222,7 +222,7 @@ module Hubspot
           return data, status_code, headers
         end
 
-        # Update a batch of products
+        # Update a batch of products by internal ID, or unique property values
         # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
         # @param [Hash] opts the optional parameters
         # @return [BatchResponseSimplePublicObject]
@@ -231,7 +231,7 @@ module Hubspot
           data
         end
 
-        # Update a batch of products
+        # Update a batch of products by internal ID, or unique property values
         # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
@@ -287,6 +287,74 @@ module Hubspot
           end
           return data, status_code, headers
         end
+
+        # Create or update a batch of products by unique property values
+        # 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]
+        def upsert(batch_input_simple_public_object_batch_input_upsert, opts = {})
+          data, _status_code, _headers = upsert_with_http_info(batch_input_simple_public_object_batch_input_upsert, opts)
+          data
+        end
+
+        # Create or update a batch of products by unique property values
+        # 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
+        def upsert_with_http_info(batch_input_simple_public_object_batch_input_upsert, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: BatchApi.upsert ...'
+          end
+          # verify the required parameter 'batch_input_simple_public_object_batch_input_upsert' is set
+          if @api_client.config.client_side_validation && batch_input_simple_public_object_batch_input_upsert.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_batch_input_upsert' when calling BatchApi.upsert"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/products/batch/upsert'
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+
+          # header parameters
+          header_params = opts[:header_params] || {}
+          # HTTP header 'Accept' (if needed)
+          header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+          # HTTP header 'Content-Type'
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_simple_public_object_batch_input_upsert)
+
+          # return_type
+          return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicUpsertObject'
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || ['oauth2']
+
+          new_options = opts.merge(
+            :operation => :"BatchApi.upsert",
+            :header_params => header_params,
+            :query_params => query_params,
+            :form_params => form_params,
+            :body => post_body,
+            :auth_names => auth_names,
+            :return_type => return_type
+          )
+
+          data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: BatchApi#upsert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
       end
     end
   end

data/lib/hubspot/codegen/crm/products/models/batch_input_simple_public_object_batch_input_upsert.rb

@@ -0,0 +1,230 @@
+=begin
+#Products
+
+#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 Products
+      class BatchInputSimplePublicObjectBatchInputUpsert
+        attr_accessor :inputs
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'inputs' => :'inputs'
+          }
+        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
+          {
+            :'inputs' => :'Array<SimplePublicObjectBatchInputUpsert>'
+          }
+        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::Products::BatchInputSimplePublicObjectBatchInputUpsert` 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::Products::BatchInputSimplePublicObjectBatchInputUpsert`. 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?(:'inputs')
+            if (value = attributes[:'inputs']).is_a?(Array)
+              self.inputs = 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 @inputs.nil?
+            invalid_properties.push('invalid value for "inputs", inputs 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 @inputs.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 &&
+              inputs == o.inputs
+        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
+          [inputs].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::Products.const_get(type)
+            klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+          end
+        end
+
+        # Returns the string representation of the object
+        # @return [String] String presentation of the object
+        def to_s
+          to_hash.to_s
+        end
+
+        # to_body is an alias to to_hash (backward compatibility)
+        # @return [Hash] Returns the object in the form of hash
+        def to_body
+          to_hash
+        end
+
+        # Returns the object in the form of hash
+        # @return [Hash] Returns the object in the form of hash
+        def to_hash
+          hash = {}
+          self.class.attribute_map.each_pair do |attr, param|
+            value = self.send(attr)
+            if value.nil?
+              is_nullable = self.class.openapi_nullable.include?(attr)
+              next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+            end
+
+            hash[param] = _to_hash(value)
+          end
+          hash
+        end
+
+        # Outputs non-array value in the form of hash
+        # For object, use to_hash. Otherwise, just return the value
+        # @param [Object] value Any valid value
+        # @return [Hash] Returns the value in the form of hash
+        def _to_hash(value)
+          if value.is_a?(Array)
+            value.compact.map { |v| _to_hash(v) }
+          elsif value.is_a?(Hash)
+            {}.tap do |hash|
+              value.each { |k, v| hash[k] = _to_hash(v) }
+            end
+          elsif value.respond_to? :to_hash
+            value.to_hash
+          else
+            value
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/hubspot/codegen/crm/products/models/batch_read_input_simple_public_object_id.rb

@@ -17,21 +17,22 @@ module Hubspot
   module Crm
     module Products
       class BatchReadInputSimplePublicObjectId
-        attr_accessor :properties
-
         attr_accessor :properties_with_history
 
+        # The name of a property whose values are unique for this object.
         attr_accessor :id_property
 
         attr_accessor :inputs
 
+        attr_accessor :properties
+
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'properties' => :'properties',
             :'properties_with_history' => :'propertiesWithHistory',
             :'id_property' => :'idProperty',
-            :'inputs' => :'inputs'
+            :'inputs' => :'inputs',
+            :'properties' => :'properties'
           }
         end
 
@@ -43,10 +44,10 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'properties' => :'Array<String>',
             :'properties_with_history' => :'Array<String>',
             :'id_property' => :'String',
-            :'inputs' => :'Array<SimplePublicObjectId>'
+            :'inputs' => :'Array<SimplePublicObjectId>',
+            :'properties' => :'Array<String>'
           }
         end
 
@@ -71,12 +72,6 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'properties')
-            if (value = attributes[:'properties']).is_a?(Array)
-              self.properties = value
-            end
-          end
-
           if attributes.key?(:'properties_with_history')
             if (value = attributes[:'properties_with_history']).is_a?(Array)
               self.properties_with_history = value
@@ -92,16 +87,18 @@ module Hubspot
               self.inputs = value
             end
           end
+
+          if attributes.key?(:'properties')
+            if (value = attributes[:'properties']).is_a?(Array)
+              self.properties = 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 @properties.nil?
-            invalid_properties.push('invalid value for "properties", properties cannot be nil.')
-          end
-
           if @properties_with_history.nil?
             invalid_properties.push('invalid value for "properties_with_history", properties_with_history cannot be nil.')
           end
@@ -110,15 +107,19 @@ module Hubspot
             invalid_properties.push('invalid value for "inputs", inputs cannot be nil.')
           end
 
+          if @properties.nil?
+            invalid_properties.push('invalid value for "properties", properties 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 @properties.nil?
           return false if @properties_with_history.nil?
           return false if @inputs.nil?
+          return false if @properties.nil?
           true
         end
 
@@ -127,10 +128,10 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              properties == o.properties &&
               properties_with_history == o.properties_with_history &&
               id_property == o.id_property &&
-              inputs == o.inputs
+              inputs == o.inputs &&
+              properties == o.properties
         end
 
         # @see the `==` method
@@ -142,7 +143,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [properties, properties_with_history, id_property, inputs].hash
+          [properties_with_history, id_property, inputs, properties].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/products/models/batch_response_simple_public_object.rb

@@ -17,18 +17,18 @@ module Hubspot
   module Crm
     module Products
       class BatchResponseSimplePublicObject
-        attr_accessor :status
-
-        attr_accessor :results
+        attr_accessor :completed_at
 
         attr_accessor :requested_at
 
         attr_accessor :started_at
 
-        attr_accessor :completed_at
-
         attr_accessor :links
 
+        attr_accessor :results
+
+        attr_accessor :status
+
         class EnumAttributeValidator
           attr_reader :datatype
           attr_reader :allowable_values
@@ -54,12 +54,12 @@ module Hubspot
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'status' => :'status',
-            :'results' => :'results',
+            :'completed_at' => :'completedAt',
             :'requested_at' => :'requestedAt',
             :'started_at' => :'startedAt',
-            :'completed_at' => :'completedAt',
-            :'links' => :'links'
+            :'links' => :'links',
+            :'results' => :'results',
+            :'status' => :'status'
           }
         end
 
@@ -71,12 +71,12 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'status' => :'String',
-            :'results' => :'Array<SimplePublicObject>',
+            :'completed_at' => :'Time',
             :'requested_at' => :'Time',
             :'started_at' => :'Time',
-            :'completed_at' => :'Time',
-            :'links' => :'Hash<String, String>'
+            :'links' => :'Hash<String, String>',
+            :'results' => :'Array<SimplePublicObject>',
+            :'status' => :'String'
           }
         end
 
@@ -101,14 +101,8 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'status')
-            self.status = attributes[:'status']
-          end
-
-          if attributes.key?(:'results')
-            if (value = attributes[:'results']).is_a?(Array)
-              self.results = value
-            end
+          if attributes.key?(:'completed_at')
+            self.completed_at = attributes[:'completed_at']
           end
 
           if attributes.key?(:'requested_at')
@@ -119,35 +113,41 @@ module Hubspot
             self.started_at = attributes[:'started_at']
           end
 
-          if attributes.key?(:'completed_at')
-            self.completed_at = attributes[:'completed_at']
-          end
-
           if attributes.key?(:'links')
             if (value = attributes[:'links']).is_a?(Hash)
               self.links = value
             end
           end
+
+          if attributes.key?(:'results')
+            if (value = attributes[:'results']).is_a?(Array)
+              self.results = 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 @status.nil?
-            invalid_properties.push('invalid value for "status", status cannot be nil.')
-          end
-
-          if @results.nil?
-            invalid_properties.push('invalid value for "results", results cannot be nil.')
+          if @completed_at.nil?
+            invalid_properties.push('invalid value for "completed_at", completed_at cannot be nil.')
           end
 
           if @started_at.nil?
             invalid_properties.push('invalid value for "started_at", started_at cannot be nil.')
           end
 
-          if @completed_at.nil?
-            invalid_properties.push('invalid value for "completed_at", completed_at cannot be nil.')
+          if @results.nil?
+            invalid_properties.push('invalid value for "results", results cannot be nil.')
+          end
+
+          if @status.nil?
+            invalid_properties.push('invalid value for "status", status cannot be nil.')
           end
 
           invalid_properties
@@ -156,12 +156,12 @@ module Hubspot
         # 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 @completed_at.nil?
+          return false if @started_at.nil?
+          return false if @results.nil?
           return false if @status.nil?
           status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
           return false unless status_validator.valid?(@status)
-          return false if @results.nil?
-          return false if @started_at.nil?
-          return false if @completed_at.nil?
           true
         end
 
@@ -180,12 +180,12 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              status == o.status &&
-              results == o.results &&
+              completed_at == o.completed_at &&
               requested_at == o.requested_at &&
               started_at == o.started_at &&
-              completed_at == o.completed_at &&
-              links == o.links
+              links == o.links &&
+              results == o.results &&
+              status == o.status
         end
 
         # @see the `==` method
@@ -197,7 +197,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [status, results, requested_at, started_at, completed_at, links].hash
+          [completed_at, requested_at, started_at, links, results, status].hash
         end
 
         # Builds the object from hash