hubspot-api-client 2.0.0 → 2.1.0

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

@@ -47,7 +47,7 @@ module Hubspot
             fail ArgumentError, "Missing the required parameter 'contact_id' when calling BasicApi.archive"
           end
           # resource path
-          local_var_path = '/crm/v3/objects/contacts/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/contacts/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
@@ -146,12 +146,13 @@ module Hubspot
         end
 
         # Read
-        # Read an Object identified by `{contactId}`. Control what is returned via the `properties` query param.
+        # Read an Object identified by `{contactId}`. `{contactId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param.  Control what is returned via the `properties` query param.
         # @param contact_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>] :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
         # @return [SimplePublicObject]
         def get_by_id(contact_id, opts = {})
           data, _status_code, _headers = get_by_id_with_http_info(contact_id, opts)
@@ -159,12 +160,13 @@ module Hubspot
         end
 
         # Read
-        # Read an Object identified by &#x60;{contactId}&#x60;. Control what is returned via the &#x60;properties&#x60; query param.
+        # Read an Object identified by &#x60;{contactId}&#x60;. &#x60;{contactId}&#x60; refers to the internal object ID by default, or optionally any unique property value as specified by the &#x60;idProperty&#x60; query param.  Control what is returned via the &#x60;properties&#x60; query param.
         # @param contact_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>] :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
         # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
         def get_by_id_with_http_info(contact_id, opts = {})
           if @api_client.config.debugging
@@ -175,13 +177,14 @@ module Hubspot
             fail ArgumentError, "Missing the required parameter 'contact_id' when calling BasicApi.get_by_id"
           end
           # resource path
-          local_var_path = '/crm/v3/objects/contacts/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/contacts/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}
           query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].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?
 
           # header parameters
           header_params = opts[:header_params] || {}
@@ -313,7 +316,7 @@ module Hubspot
             fail ArgumentError, "Missing the required parameter 'contact_id' when calling BasicApi.update"
           end
           # resource path
-          local_var_path = '/crm/v3/objects/contacts/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s).gsub('%2F', '/'))
+          local_var_path = '/crm/v3/objects/contacts/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s))
 
           # query parameters
           query_params = opts[:query_params] || {}

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

@@ -141,7 +141,7 @@ module Hubspot
           return data, status_code, headers
         end
 
-        # Read a batch of contacts by ID
+        # Read a batch of contacts by internal ID, or unique property values
         # Read a list of contacts given a collection of IDs. Use the `properties` request body property to control which properties are returned.
         # @param [Hash] opts the optional parameters
         # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
@@ -152,7 +152,7 @@ module Hubspot
           data
         end
 
-        # Read a batch of contacts by ID
+        # Read a batch of contacts by internal ID, or unique property values
         # Read a list of contacts given a collection of IDs. Use the `properties` request body property to control which properties are returned.
         # @param [Hash] opts the optional parameters
         # @option opts [Boolean] :archived Whether to return only results that have been archived.

data/lib/hubspot/codegen/crm/contacts/api_client.rb

@@ -63,6 +63,7 @@ module Hubspot
               conn.request :url_encoded
             end
             conn.adapter(Faraday.default_adapter)
+            conn.options[:params_encoder] = Faraday::FlatParamsEncoder
 
             # Errors handler settings
             if !config.error_handler.empty?

data/lib/hubspot/codegen/crm/contacts/models/associated_id.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.2.3
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Crm
+    module Contacts
+      class AssociatedId
+        attr_accessor :id
+
+        attr_accessor :type
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'id' => :'id',
+            :'type' => :'type'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'id' => :'String',
+            :'type' => :'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::AssociatedId` 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::AssociatedId`. 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?(:'id')
+            self.id = attributes[:'id']
+          end
+
+          if attributes.key?(:'type')
+            self.type = attributes[:'type']
+          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 @id.nil?
+            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
+
+          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 @id.nil?
+          return false if @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 &&
+              id == o.id &&
+              type == o.type
+        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
+          [id, type].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/batch_read_input_simple_public_object_id.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -18,12 +18,15 @@ module Hubspot
       class BatchReadInputSimplePublicObjectId
         attr_accessor :properties
 
+        attr_accessor :id_property
+
         attr_accessor :inputs
 
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
             :'properties' => :'properties',
+            :'id_property' => :'idProperty',
             :'inputs' => :'inputs'
           }
         end
@@ -32,6 +35,7 @@ module Hubspot
         def self.openapi_types
           {
             :'properties' => :'Array<String>',
+            :'id_property' => :'String',
             :'inputs' => :'Array<SimplePublicObjectId>'
           }
         end
@@ -63,6 +67,10 @@ module Hubspot
             end
           end
 
+          if attributes.key?(:'id_property')
+            self.id_property = attributes[:'id_property']
+          end
+
           if attributes.key?(:'inputs')
             if (value = attributes[:'inputs']).is_a?(Array)
               self.inputs = value
@@ -99,6 +107,7 @@ module Hubspot
           return true if self.equal?(o)
           self.class == o.class &&
               properties == o.properties &&
+              id_property == o.id_property &&
               inputs == o.inputs
         end
 
@@ -111,7 +120,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [properties, inputs].hash
+          [properties, id_property, inputs].hash
         end
 
         # Builds the object from hash

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -140,10 +140,6 @@ module Hubspot
             invalid_properties.push('invalid value for "results", results cannot be nil.')
           end
 
-          if @errors.nil?
-            invalid_properties.push('invalid value for "errors", errors cannot be nil.')
-          end
-
           if @status.nil?
             invalid_properties.push('invalid value for "status", status cannot be nil.')
           end
@@ -163,7 +159,6 @@ module Hubspot
         # @return true if the model is valid
         def valid?
           return false if @results.nil?
-          return false if @errors.nil?
           return false if @status.nil?
           status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
           return false unless status_validator.valid?(@status)

data/lib/hubspot/codegen/crm/contacts/models/{collection_response_simple_public_object_id.rb → collection_response_associated_id.rb}

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.2
+OpenAPI Generator version: 4.2.3
 
 =end
 
@@ -15,7 +15,7 @@ require 'date'
 module Hubspot
   module Crm
     module Contacts
-      class CollectionResponseSimplePublicObjectId
+      class CollectionResponseAssociatedId
         attr_accessor :results
 
         attr_accessor :paging
@@ -31,7 +31,7 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'results' => :'Array<SimplePublicObjectId>',
+            :'results' => :'Array<AssociatedId>',
             :'paging' => :'Paging'
           }
         end
@@ -46,13 +46,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::Contacts::CollectionResponseSimplePublicObjectId` initialize method"
+            fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Contacts::CollectionResponseAssociatedId` 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::CollectionResponseSimplePublicObjectId`. 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::Contacts::CollectionResponseAssociatedId`. 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
           }