hubspot-api-client 19.0.0 → 20.0.0

data/lib/hubspot/codegen/crm/owners/models/public_owner.rb

@@ -29,12 +29,38 @@ module Hubspot
 
         attr_accessor :id
 
+        attr_accessor :user_id_including_inactive
+
+        attr_accessor :type
+
         attr_accessor :user_id
 
         attr_accessor :email
 
         attr_accessor :updated_at
 
+        class EnumAttributeValidator
+          attr_reader :datatype
+          attr_reader :allowable_values
+
+          def initialize(datatype, allowable_values)
+            @allowable_values = allowable_values.map do |value|
+              case datatype.to_s
+              when /Integer/i
+                value.to_i
+              when /Float/i
+                value.to_f
+              else
+                value
+              end
+            end
+          end
+
+          def valid?(value)
+            !value || allowable_values.include?(value)
+          end
+        end
+
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
@@ -44,6 +70,8 @@ module Hubspot
             :'archived' => :'archived',
             :'teams' => :'teams',
             :'id' => :'id',
+            :'user_id_including_inactive' => :'userIdIncludingInactive',
+            :'type' => :'type',
             :'user_id' => :'userId',
             :'email' => :'email',
             :'updated_at' => :'updatedAt'
@@ -64,6 +92,8 @@ module Hubspot
             :'archived' => :'Boolean',
             :'teams' => :'Array<PublicTeam>',
             :'id' => :'String',
+            :'user_id_including_inactive' => :'Integer',
+            :'type' => :'String',
             :'user_id' => :'Integer',
             :'email' => :'String',
             :'updated_at' => :'Time'
@@ -117,6 +147,14 @@ module Hubspot
             self.id = attributes[:'id']
           end
 
+          if attributes.key?(:'user_id_including_inactive')
+            self.user_id_including_inactive = attributes[:'user_id_including_inactive']
+          end
+
+          if attributes.key?(:'type')
+            self.type = attributes[:'type']
+          end
+
           if attributes.key?(:'user_id')
             self.user_id = attributes[:'user_id']
           end
@@ -146,6 +184,10 @@ module Hubspot
             invalid_properties.push('invalid value for "id", id cannot be nil.')
           end
 
+          if @type.nil?
+            invalid_properties.push('invalid value for "type", type cannot be nil.')
+          end
+
           if @updated_at.nil?
             invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
           end
@@ -159,10 +201,23 @@ module Hubspot
           return false if @created_at.nil?
           return false if @archived.nil?
           return false if @id.nil?
+          return false if @type.nil?
+          type_validator = EnumAttributeValidator.new('String', ["PERSON", "QUEUE"])
+          return false unless type_validator.valid?(@type)
           return false if @updated_at.nil?
           true
         end
 
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] type Object to be assigned
+        def type=(type)
+          validator = EnumAttributeValidator.new('String', ["PERSON", "QUEUE"])
+          unless validator.valid?(type)
+            fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+          end
+          @type = type
+        end
+
         # Checks equality by comparing each attribute.
         # @param [Object] Object to be compared
         def ==(o)
@@ -174,6 +229,8 @@ module Hubspot
               archived == o.archived &&
               teams == o.teams &&
               id == o.id &&
+              user_id_including_inactive == o.user_id_including_inactive &&
+              type == o.type &&
               user_id == o.user_id &&
               email == o.email &&
               updated_at == o.updated_at
@@ -188,7 +245,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [first_name, last_name, created_at, archived, teams, id, user_id, email, updated_at].hash
+          [first_name, last_name, created_at, archived, teams, id, user_id_including_inactive, type, user_id, email, updated_at].hash
         end
 
         # Builds the object from hash

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

@@ -16,6 +16,7 @@ module Hubspot
   module Crm
     module Products
       class BasicApi
+        require 'hubspot/helpers/get_all_helper'
         include Hubspot::Helpers::GetAllHelper
 
         attr_accessor :api_client
@@ -308,11 +309,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 result in an error. Properties values can be cleared by passing an empty string.
+        # Perform a partial update of an Object identified by `{productId}`or optionally a unique property value as specified by the `idProperty` query param. `{productId}` 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 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.
+        # @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 +321,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 result in an error. Properties values can be cleared by passing an empty string.
+        # Perform a partial update of an Object identified by `{productId}`or optionally a unique property value as specified by the `idProperty` query param. `{productId}` 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 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.
+        # @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

@@ -88,25 +88,25 @@ module Hubspot
         end
 
         # Create a batch of products
-        # @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 products
-        # @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/products/batch/create'
@@ -128,7 +128,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'
@@ -154,6 +154,7 @@ module Hubspot
         end
 
         # Read a batch of products 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)
@@ -164,6 +165,7 @@ module Hubspot
         end
 
         # Read a batch of products 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)

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

@@ -16,7 +16,7 @@ require 'time'
 module Hubspot
   module Crm
     module Products
-      class BatchInputSimplePublicObjectInputForCreate
+      class BatchInputSimplePublicObjectBatchInputForCreate
         attr_accessor :inputs
 
         # Attribute mapping from ruby-style variable name to JSON key.
@@ -34,7 +34,7 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'inputs' => :'Array<SimplePublicObjectInputForCreate>'
+            :'inputs' => :'Array<SimplePublicObjectBatchInputForCreate>'
           }
         end
 
@@ -48,13 +48,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::Products::BatchInputSimplePublicObjectInputForCreate` initialize method"
+            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Products::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::Products::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::Products::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/products/models/batch_read_input_simple_public_object_id.rb

@@ -19,7 +19,7 @@ module Hubspot
       class BatchReadInputSimplePublicObjectId
         attr_accessor :properties_with_history
 
-        # The name of a property whose values are unique for this object.
+        # 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/products/models/simple_public_object.rb

@@ -27,6 +27,8 @@ module Hubspot
 
         attr_accessor :id
 
+        attr_accessor :object_write_trace_id
+
         attr_accessor :properties
 
         attr_accessor :updated_at
@@ -39,6 +41,7 @@ module Hubspot
             :'archived_at' => :'archivedAt',
             :'properties_with_history' => :'propertiesWithHistory',
             :'id' => :'id',
+            :'object_write_trace_id' => :'objectWriteTraceId',
             :'properties' => :'properties',
             :'updated_at' => :'updatedAt'
           }
@@ -57,6 +60,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'
           }
@@ -105,6 +109,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
@@ -159,6 +167,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
@@ -172,7 +181,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/products/models/simple_public_object_batch_input_for_create.rb

@@ -0,0 +1,250 @@
+=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 SimplePublicObjectBatchInputForCreate
+        attr_accessor :associations
+
+        attr_accessor :object_write_trace_id
+
+        attr_accessor :properties
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'associations' => :'associations',
+            :'object_write_trace_id' => :'objectWriteTraceId',
+            :'properties' => :'properties'
+          }
+        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
+          {
+            :'associations' => :'Array<PublicAssociationsForObject>',
+            :'object_write_trace_id' => :'String',
+            :'properties' => :'Hash<String, String>'
+          }
+        end
+
+        # List of attributes with nullable: true
+        def self.openapi_nullable
+          Set.new([
+          ])
+        end
+
+        # Initializes the object
+        # @param [Hash] attributes Model attributes in the form of hash
+        def initialize(attributes = {})
+          if (!attributes.is_a?(Hash))
+            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Products::SimplePublicObjectBatchInputForCreate` 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::SimplePublicObjectBatchInputForCreate`. 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?(:'associations')
+            if (value = attributes[:'associations']).is_a?(Array)
+              self.associations = value
+            end
+          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
+        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
+
+          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?
+          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 &&
+              associations == o.associations &&
+              object_write_trace_id == o.object_write_trace_id &&
+              properties == o.properties
+        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
+          [associations, object_write_trace_id, properties].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/simple_public_object_input.rb

@@ -17,14 +17,11 @@ module Hubspot
   module Crm
     module Products
       class SimplePublicObjectInput
-        attr_accessor :object_write_trace_id
-
         attr_accessor :properties
 
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'object_write_trace_id' => :'objectWriteTraceId',
             :'properties' => :'properties'
           }
         end
@@ -37,7 +34,6 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'object_write_trace_id' => :'String',
             :'properties' => :'Hash<String, String>'
           }
         end
@@ -63,10 +59,6 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          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
@@ -97,7 +89,6 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              object_write_trace_id == o.object_write_trace_id &&
               properties == o.properties
         end
 
@@ -110,7 +101,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [object_write_trace_id, properties].hash
+          [properties].hash
         end
 
         # Builds the object from hash