hubspot-api-client 3.1.1 → 6.0.0

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

@@ -23,23 +23,27 @@ module Hubspot
         end
         # Filter, Sort, and Search CRM Objects
         # Filter, Sort, and Search CRM Objects
+        # @param public_object_search_request [PublicObjectSearchRequest] 
         # @param [Hash] opts the optional parameters
-        # @option opts [PublicObjectSearchRequest] :public_object_search_request 
         # @return [CollectionResponseWithTotalSimplePublicObject]
-        def do_search(opts = {})
-          data, _status_code, _headers = do_search_with_http_info(opts)
+        def do_search(public_object_search_request, opts = {})
+          data, _status_code, _headers = do_search_with_http_info(public_object_search_request, opts)
           data
         end
 
         # Filter, Sort, and Search CRM Objects
         # Filter, Sort, and Search CRM Objects
+        # @param public_object_search_request [PublicObjectSearchRequest] 
         # @param [Hash] opts the optional parameters
-        # @option opts [PublicObjectSearchRequest] :public_object_search_request 
         # @return [Array<(CollectionResponseWithTotalSimplePublicObject, Integer, Hash)>] CollectionResponseWithTotalSimplePublicObject data, response status code and response headers
-        def do_search_with_http_info(opts = {})
+        def do_search_with_http_info(public_object_search_request, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: SearchApi.do_search ...'
           end
+          # verify the required parameter 'public_object_search_request' is set
+          if @api_client.config.client_side_validation && public_object_search_request.nil?
+            fail ArgumentError, "Missing the required parameter 'public_object_search_request' when calling SearchApi.do_search"
+          end
           # resource path
           local_var_path = '/crm/v3/objects/contacts/search'
 
@@ -57,7 +61,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'public_object_search_request']) 
+          post_body = opts[:body] || @api_client.object_to_http_body(public_object_search_request) 
 
           # return_type
           return_type = opts[:return_type] || 'CollectionResponseWithTotalSimplePublicObject' 

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

@@ -194,6 +194,13 @@ module Hubspot
         # Returns Auth Settings hash for api client.
         def auth_settings
           {
+            'developer-hapikey' =>
+              {
+                type: 'api_key',
+                in: 'query',
+                key: 'hapikey',
+                value: api_key_with_prefix('hapikey')
+              },
             'hapikey' =>
               {
                 type: 'api_key',

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

@@ -16,27 +16,27 @@ module Hubspot
   module Crm
     module Contacts
       class BatchReadInputSimplePublicObjectId
+        attr_accessor :inputs
+
         attr_accessor :properties
 
         attr_accessor :id_property
 
-        attr_accessor :inputs
-
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
+            :'inputs' => :'inputs',
             :'properties' => :'properties',
-            :'id_property' => :'idProperty',
-            :'inputs' => :'inputs'
+            :'id_property' => :'idProperty'
           }
         end
 
         # Attribute type mapping.
         def self.openapi_types
           {
+            :'inputs' => :'Array<SimplePublicObjectId>',
             :'properties' => :'Array<String>',
-            :'id_property' => :'String',
-            :'inputs' => :'Array<SimplePublicObjectId>'
+            :'id_property' => :'String'
           }
         end
 
@@ -61,6 +61,12 @@ module Hubspot
             h[k.to_sym] = v
           }
 
+          if attributes.key?(:'inputs')
+            if (value = attributes[:'inputs']).is_a?(Array)
+              self.inputs = value
+            end
+          end
+
           if attributes.key?(:'properties')
             if (value = attributes[:'properties']).is_a?(Array)
               self.properties = value
@@ -70,34 +76,28 @@ module Hubspot
           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
-            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 @inputs.nil?
             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 @inputs.nil?
+          return false if @properties.nil?
           true
         end
 
@@ -106,9 +106,9 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
+              inputs == o.inputs &&
               properties == o.properties &&
-              id_property == o.id_property &&
-              inputs == o.inputs
+              id_property == o.id_property
         end
 
         # @see the `==` method
@@ -120,7 +120,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [properties, id_property, inputs].hash
+          [inputs, properties, id_property].hash
         end
 
         # Builds the object from hash

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

@@ -16,20 +16,18 @@ module Hubspot
   module Crm
     module Contacts
       class BatchResponseSimplePublicObject
-        attr_accessor :results
-
-        attr_accessor :num_errors
-
-        attr_accessor :errors
-
         attr_accessor :status
 
+        attr_accessor :results
+
         attr_accessor :requested_at
 
         attr_accessor :started_at
 
         attr_accessor :completed_at
 
+        attr_accessor :links
+
         class EnumAttributeValidator
           attr_reader :datatype
           attr_reader :allowable_values
@@ -55,26 +53,24 @@ module Hubspot
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'results' => :'results',
-            :'num_errors' => :'numErrors',
-            :'errors' => :'errors',
             :'status' => :'status',
+            :'results' => :'results',
             :'requested_at' => :'requestedAt',
             :'started_at' => :'startedAt',
-            :'completed_at' => :'completedAt'
+            :'completed_at' => :'completedAt',
+            :'links' => :'links'
           }
         end
 
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'results' => :'Array<SimplePublicObject>',
-            :'num_errors' => :'Integer',
-            :'errors' => :'Array<Error>',
             :'status' => :'String',
+            :'results' => :'Array<SimplePublicObject>',
             :'requested_at' => :'DateTime',
             :'started_at' => :'DateTime',
-            :'completed_at' => :'DateTime'
+            :'completed_at' => :'DateTime',
+            :'links' => :'Hash<String, String>'
           }
         end
 
@@ -99,26 +95,16 @@ 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
           end
 
-          if attributes.key?(:'num_errors')
-            self.num_errors = attributes[:'num_errors']
-          end
-
-          if attributes.key?(:'errors')
-            if (value = attributes[:'errors']).is_a?(Array)
-              self.errors = value
-            end
-          end
-
-          if attributes.key?(:'status')
-            self.status = attributes[:'status']
-          end
-
           if attributes.key?(:'requested_at')
             self.requested_at = attributes[:'requested_at']
           end
@@ -130,20 +116,26 @@ module Hubspot
           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
         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 @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
 
+          if @results.nil?
+            invalid_properties.push('invalid value for "results", results cannot be nil.')
+          end
+
           if @started_at.nil?
             invalid_properties.push('invalid value for "started_at", started_at cannot be nil.')
           end
@@ -158,10 +150,10 @@ 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 @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
@@ -182,13 +174,12 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              results == o.results &&
-              num_errors == o.num_errors &&
-              errors == o.errors &&
               status == o.status &&
+              results == o.results &&
               requested_at == o.requested_at &&
               started_at == o.started_at &&
-              completed_at == o.completed_at
+              completed_at == o.completed_at &&
+              links == o.links
         end
 
         # @see the `==` method
@@ -200,7 +191,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [results, num_errors, errors, status, requested_at, started_at, completed_at].hash
+          [status, results, requested_at, started_at, completed_at, links].hash
         end
 
         # Builds the object from hash

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

@@ -0,0 +1,333 @@
+=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 BatchResponseSimplePublicObjectWithErrors
+        attr_accessor :status
+
+        attr_accessor :results
+
+        attr_accessor :num_errors
+
+        attr_accessor :errors
+
+        attr_accessor :requested_at
+
+        attr_accessor :started_at
+
+        attr_accessor :completed_at
+
+        attr_accessor :links
+
+        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
+          {
+            :'status' => :'status',
+            :'results' => :'results',
+            :'num_errors' => :'numErrors',
+            :'errors' => :'errors',
+            :'requested_at' => :'requestedAt',
+            :'started_at' => :'startedAt',
+            :'completed_at' => :'completedAt',
+            :'links' => :'links'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'status' => :'String',
+            :'results' => :'Array<SimplePublicObject>',
+            :'num_errors' => :'Integer',
+            :'errors' => :'Array<Error>',
+            :'requested_at' => :'DateTime',
+            :'started_at' => :'DateTime',
+            :'completed_at' => :'DateTime',
+            :'links' => :'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::Contacts::BatchResponseSimplePublicObjectWithErrors` 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::BatchResponseSimplePublicObjectWithErrors`. 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?(:'status')
+            self.status = attributes[:'status']
+          end
+
+          if attributes.key?(:'results')
+            if (value = attributes[:'results']).is_a?(Array)
+              self.results = value
+            end
+          end
+
+          if attributes.key?(:'num_errors')
+            self.num_errors = attributes[:'num_errors']
+          end
+
+          if attributes.key?(:'errors')
+            if (value = attributes[:'errors']).is_a?(Array)
+              self.errors = value
+            end
+          end
+
+          if attributes.key?(:'requested_at')
+            self.requested_at = attributes[:'requested_at']
+          end
+
+          if attributes.key?(:'started_at')
+            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
+        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.')
+          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.')
+          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 @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
+
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] status Object to be assigned
+        def status=(status)
+          validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
+          unless validator.valid?(status)
+            fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+          end
+          @status = status
+        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 &&
+              status == o.status &&
+              results == o.results &&
+              num_errors == o.num_errors &&
+              errors == o.errors &&
+              requested_at == o.requested_at &&
+              started_at == o.started_at &&
+              completed_at == o.completed_at &&
+              links == o.links
+        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
+          [status, results, num_errors, errors, requested_at, started_at, completed_at, links].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