hubspot-api-client 9.3.0 → 10.0.0

data/lib/hubspot/codegen/conversations/visitor-identification/models/identification_token_response.rb

@@ -0,0 +1,215 @@
+=begin
+#Visitor Identification
+
+#The Visitor Identification API allows you to pass identification information to the HubSpot chat widget for otherwise unknown visitors that were verified by your own authentication system.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module Hubspot
+  module Conversations
+    module VisitorIdentification
+      class IdentificationTokenResponse
+        attr_accessor :token
+
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'token' => :'token'
+          }
+        end
+
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'token' => :'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::Conversations::VisitorIdentification::IdentificationTokenResponse` 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::Conversations::VisitorIdentification::IdentificationTokenResponse`. 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?(:'token')
+            self.token = attributes[:'token']
+          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 @token.nil?
+            invalid_properties.push('invalid value for "token", token 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 @token.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 &&
+              token == o.token
+        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
+          [token].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::Conversations::VisitorIdentification.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/associations/api_client.rb

@@ -56,6 +56,20 @@ module Hubspot
           end
 
           unless response.success?
+            if config.error_handler.any?
+              config.error_handler.each do |statuses, opts|
+                statuses = statuses.is_a?(Integer) ? [statuses] : statuses
+
+                retries = opts[:max_retries] || 5
+                while retries > 0 && statuses.include?(response.code)
+                  sleep opts[:seconds_delay] if opts[:seconds_delay]
+                  response = request.run
+                  opts[:retry_block].call if opts[:retry_block]
+                  retries -= 1
+                end
+              end
+            end
+
             if response.timed_out?
               fail ApiError.new('Connection timed out')
             elsif response.code == 0

data/lib/hubspot/codegen/crm/companies/api/associations_api.rb

@@ -105,8 +105,7 @@ module Hubspot
         # @param to_object_id [String] 
         # @param association_type [String] 
         # @param [Hash] opts the optional parameters
-        # @option opts [Boolean] :paginate_associations  (default to false)
-        # @return [SimplePublicObject]
+        # @return [SimplePublicObjectWithAssociations]
         def create(company_id, to_object_type, to_object_id, association_type, opts = {})
           data, _status_code, _headers = create_with_http_info(company_id, to_object_type, to_object_id, association_type, opts)
           data
@@ -118,8 +117,7 @@ module Hubspot
         # @param to_object_id [String] 
         # @param association_type [String] 
         # @param [Hash] opts the optional parameters
-        # @option opts [Boolean] :paginate_associations 
-        # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
+        # @return [Array<(SimplePublicObjectWithAssociations, Integer, Hash)>] SimplePublicObjectWithAssociations data, response status code and response headers
         def create_with_http_info(company_id, to_object_type, to_object_id, association_type, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: AssociationsApi.create ...'
@@ -145,7 +143,6 @@ module Hubspot
 
           # query parameters
           query_params = opts[:query_params] || {}
-          query_params[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?
 
           # header parameters
           header_params = opts[:header_params] || {}
@@ -159,7 +156,7 @@ module Hubspot
           post_body = opts[:body] 
 
           # return_type
-          return_type = opts[:return_type] || 'SimplePublicObject' 
+          return_type = opts[:return_type] || 'SimplePublicObjectWithAssociations' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
@@ -184,10 +181,9 @@ module Hubspot
         # @param company_id [String] 
         # @param to_object_type [String] 
         # @param [Hash] opts the optional parameters
-        # @option opts [Boolean] :paginate_associations  (default to false)
         # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
         # @option opts [Integer] :limit The maximum number of results to display per page. (default to 500)
-        # @return [CollectionResponseAssociatedId]
+        # @return [CollectionResponseAssociatedIdForwardPaging]
         def get_all(company_id, to_object_type, opts = {})
           data, _status_code, _headers = get_all_with_http_info(company_id, to_object_type, opts)
           data
@@ -197,10 +193,9 @@ module Hubspot
         # @param company_id [String] 
         # @param to_object_type [String] 
         # @param [Hash] opts the optional parameters
-        # @option opts [Boolean] :paginate_associations 
         # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
         # @option opts [Integer] :limit The maximum number of results to display per page.
-        # @return [Array<(CollectionResponseAssociatedId, Integer, Hash)>] CollectionResponseAssociatedId data, response status code and response headers
+        # @return [Array<(CollectionResponseAssociatedIdForwardPaging, Integer, Hash)>] CollectionResponseAssociatedIdForwardPaging data, response status code and response headers
         def get_all_with_http_info(company_id, to_object_type, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: AssociationsApi.get_all ...'
@@ -218,7 +213,6 @@ module Hubspot
 
           # query parameters
           query_params = opts[:query_params] || {}
-          query_params[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?
           query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
           query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
@@ -234,7 +228,7 @@ module Hubspot
           post_body = opts[:body] 
 
           # return_type
-          return_type = opts[:return_type] || 'CollectionResponseAssociatedId' 
+          return_type = opts[:return_type] || 'CollectionResponseAssociatedIdForwardPaging' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

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

@@ -155,10 +155,9 @@ module Hubspot
         # @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] :paginate_associations  (default to false)
         # @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]
+        # @return [SimplePublicObjectWithAssociations]
         def get_by_id(company_id, opts = {})
           data, _status_code, _headers = get_by_id_with_http_info(company_id, opts)
           data
@@ -170,10 +169,9 @@ module Hubspot
         # @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] :paginate_associations 
         # @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
+        # @return [Array<(SimplePublicObjectWithAssociations, Integer, Hash)>] SimplePublicObjectWithAssociations data, response status code and response headers
         def get_by_id_with_http_info(company_id, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BasicApi.get_by_id ...'
@@ -189,7 +187,6 @@ module Hubspot
           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[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?
           query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
           query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].nil?
 
@@ -205,7 +202,7 @@ module Hubspot
           post_body = opts[:body] 
 
           # return_type
-          return_type = opts[:return_type] || 'SimplePublicObject' 
+          return_type = opts[:return_type] || 'SimplePublicObjectWithAssociations' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
@@ -233,9 +230,8 @@ module Hubspot
         # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
         # @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] :paginate_associations  (default to false)
         # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
-        # @return [CollectionResponseSimplePublicObject]
+        # @return [CollectionResponseSimplePublicObjectWithAssociationsForwardPaging]
         def get_page(opts = {})
           data, _status_code, _headers = get_page_with_http_info(opts)
           data
@@ -248,9 +244,8 @@ module Hubspot
         # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
         # @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] :paginate_associations 
         # @option opts [Boolean] :archived Whether to return only results that have been archived.
-        # @return [Array<(CollectionResponseSimplePublicObject, Integer, Hash)>] CollectionResponseSimplePublicObject data, response status code and response headers
+        # @return [Array<(CollectionResponseSimplePublicObjectWithAssociationsForwardPaging, Integer, Hash)>] CollectionResponseSimplePublicObjectWithAssociationsForwardPaging data, response status code and response headers
         def get_page_with_http_info(opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BasicApi.get_page ...'
@@ -264,7 +259,6 @@ module Hubspot
           query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
           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[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?
           query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
 
           # header parameters
@@ -279,7 +273,7 @@ module Hubspot
           post_body = opts[:body] 
 
           # return_type
-          return_type = opts[:return_type] || 'CollectionResponseSimplePublicObject' 
+          return_type = opts[:return_type] || 'CollectionResponseSimplePublicObjectWithAssociationsForwardPaging' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
@@ -301,10 +295,11 @@ module Hubspot
         end
 
         # Update
-        # Perform a partial update of an Object identified by `{companyId}`. 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 `{companyId}`. `{companyId}` 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.
         # @param company_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
         # @return [SimplePublicObject]
         def update(company_id, simple_public_object_input, opts = {})
           data, _status_code, _headers = update_with_http_info(company_id, simple_public_object_input, opts)
@@ -312,10 +307,11 @@ module Hubspot
         end
 
         # Update
-        # Perform a partial update of an Object identified by &#x60;{companyId}&#x60;. 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;{companyId}&#x60;. &#x60;{companyId}&#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.
         # @param company_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
         # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
         def update_with_http_info(company_id, simple_public_object_input, opts = {})
           if @api_client.config.debugging
@@ -334,6 +330,7 @@ module Hubspot
 
           # query parameters
           query_params = opts[:query_params] || {}
+          query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].nil?
 
           # header parameters
           header_params = opts[:header_params] || {}

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

@@ -25,7 +25,7 @@ module Hubspot
         # Filter, Sort, and Search CRM Objects
         # @param public_object_search_request [PublicObjectSearchRequest] 
         # @param [Hash] opts the optional parameters
-        # @return [CollectionResponseWithTotalSimplePublicObject]
+        # @return [CollectionResponseWithTotalSimplePublicObjectForwardPaging]
         def do_search(public_object_search_request, opts = {})
           data, _status_code, _headers = do_search_with_http_info(public_object_search_request, opts)
           data
@@ -35,7 +35,7 @@ module Hubspot
         # Filter, Sort, and Search CRM Objects
         # @param public_object_search_request [PublicObjectSearchRequest] 
         # @param [Hash] opts the optional parameters
-        # @return [Array<(CollectionResponseWithTotalSimplePublicObject, Integer, Hash)>] CollectionResponseWithTotalSimplePublicObject data, response status code and response headers
+        # @return [Array<(CollectionResponseWithTotalSimplePublicObjectForwardPaging, Integer, Hash)>] CollectionResponseWithTotalSimplePublicObjectForwardPaging data, response status code and response headers
         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 ...'
@@ -64,7 +64,7 @@ module Hubspot
           post_body = opts[:body] || @api_client.object_to_http_body(public_object_search_request) 
 
           # return_type
-          return_type = opts[:return_type] || 'CollectionResponseWithTotalSimplePublicObject' 
+          return_type = opts[:return_type] || 'CollectionResponseWithTotalSimplePublicObjectForwardPaging' 
 
           # auth_names
           auth_names = opts[:auth_names] || ['hapikey', 'oauth2']