hubspot-api-client 10.0.0 → 11.1.0

data/lib/hubspot/codegen/conversations/visitor-identification/api_client.rb

@@ -55,21 +55,21 @@ module Hubspot
             @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
           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
+          if !response.success? && 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
 
+          unless response.success?
             if response.timed_out?
               fail ApiError.new('Connection timed out')
             elsif response.code == 0

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

@@ -55,21 +55,21 @@ module Hubspot
             @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
           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
+          if !response.success? && 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
 
+          unless response.success?
             if response.timed_out?
               fail ApiError.new('Connection timed out')
             elsif response.code == 0

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

@@ -22,7 +22,6 @@ module Hubspot
           @api_client = api_client
         end
         # Archive a batch of companies by ID
-        # Archive a list of companies given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
         # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
         # @return [nil]
@@ -32,7 +31,6 @@ module Hubspot
         end
 
         # Archive a batch of companies by ID
-        # Archive a list of companies given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
         # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -86,7 +84,6 @@ module Hubspot
         end
 
         # Create a batch of companies
-        # Create a batch of companies. This follows the same rules as creating an individual object.
         # @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput] 
         # @param [Hash] opts the optional parameters
         # @return [BatchResponseSimplePublicObject]
@@ -96,7 +93,6 @@ module Hubspot
         end
 
         # Create a batch of companies
-        # Create a batch of companies. This follows the same rules as creating an individual object.
         # @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
@@ -150,7 +146,6 @@ module Hubspot
         end
 
         # Read a batch of companies by internal ID, or unique property values
-        # Read a list of companies given a collection of IDs. Use the `properties` request body property to control which properties are returned.
         # @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)
@@ -161,7 +156,6 @@ module Hubspot
         end
 
         # Read a batch of companies by internal ID, or unique property values
-        # Read a list of companies given a collection of IDs. Use the &#x60;properties&#x60; request body property to control which properties are returned.
         # @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.
@@ -217,7 +211,6 @@ module Hubspot
         end
 
         # Update a batch of companies
-        # Perform a partial upate on a batch of companies. This follows the same rules as performing partial updates on an individual object.
         # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
         # @param [Hash] opts the optional parameters
         # @return [BatchResponseSimplePublicObject]
@@ -227,7 +220,6 @@ module Hubspot
         end
 
         # Update a batch of companies
-        # Perform a partial upate on a batch of companies. This follows the same rules as performing partial updates on an individual object.
         # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers

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

@@ -21,8 +21,6 @@ module Hubspot
         def initialize(api_client = ApiClient.default)
           @api_client = api_client
         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
         # @return [CollectionResponseWithTotalSimplePublicObjectForwardPaging]
@@ -31,8 +29,6 @@ module Hubspot
           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
         # @return [Array<(CollectionResponseWithTotalSimplePublicObjectForwardPaging, Integer, Hash)>] CollectionResponseWithTotalSimplePublicObjectForwardPaging data, response status code and response headers

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

@@ -55,21 +55,21 @@ module Hubspot
             @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
           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
+          if !response.success? && 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
 
+          unless response.success?
             if response.timed_out?
               fail ApiError.new('Connection timed out')
             elsif response.code == 0

data/lib/hubspot/codegen/crm/companies/models/filter.rb

@@ -20,6 +20,7 @@ module Hubspot
 
         attr_accessor :property_name
 
+        # null
         attr_accessor :operator
 
         class EnumAttributeValidator
@@ -116,7 +117,7 @@ module Hubspot
         def valid?
           return false if @property_name.nil?
           return false if @operator.nil?
-          operator_validator = EnumAttributeValidator.new('String', ["EQ", "NEQ", "LT", "LTE", "GT", "GTE", "HAS_PROPERTY", "NOT_HAS_PROPERTY", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"])
+          operator_validator = EnumAttributeValidator.new('String', ["EQ", "NEQ", "LT", "LTE", "GT", "GTE", "BETWEEN", "IN", "NOT_IN", "HAS_PROPERTY", "NOT_HAS_PROPERTY", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"])
           return false unless operator_validator.valid?(@operator)
           true
         end
@@ -124,7 +125,7 @@ module Hubspot
         # Custom attribute writer method checking allowed values (enum).
         # @param [Object] operator Object to be assigned
         def operator=(operator)
-          validator = EnumAttributeValidator.new('String', ["EQ", "NEQ", "LT", "LTE", "GT", "GTE", "HAS_PROPERTY", "NOT_HAS_PROPERTY", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"])
+          validator = EnumAttributeValidator.new('String', ["EQ", "NEQ", "LT", "LTE", "GT", "GTE", "BETWEEN", "IN", "NOT_IN", "HAS_PROPERTY", "NOT_HAS_PROPERTY", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"])
           unless validator.valid?(operator)
             fail ArgumentError, "invalid value for \"operator\", must be one of #{validator.allowable_values}."
           end

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

@@ -22,7 +22,6 @@ module Hubspot
           @api_client = api_client
         end
         # Archive a batch of contacts by ID
-        # Archive a list of contacts given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
         # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
         # @return [nil]
@@ -32,7 +31,6 @@ module Hubspot
         end
 
         # Archive a batch of contacts by ID
-        # Archive a list of contacts given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
         # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -86,7 +84,6 @@ module Hubspot
         end
 
         # Create a batch of contacts
-        # Create a batch of contacts. This follows the same rules as creating an individual object.
         # @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput] 
         # @param [Hash] opts the optional parameters
         # @return [BatchResponseSimplePublicObject]
@@ -96,7 +93,6 @@ module Hubspot
         end
 
         # Create a batch of contacts
-        # Create a batch of contacts. This follows the same rules as creating an individual object.
         # @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
@@ -150,7 +146,6 @@ module Hubspot
         end
 
         # 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 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)
@@ -161,7 +156,6 @@ module Hubspot
         end
 
         # Read a batch of contacts by internal ID, or unique property values
-        # Read a list of contacts given a collection of IDs. Use the &#x60;properties&#x60; request body property to control which properties are returned.
         # @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.
@@ -217,7 +211,6 @@ module Hubspot
         end
 
         # Update a batch of contacts
-        # Perform a partial upate on a batch of contacts. This follows the same rules as performing partial updates on an individual object.
         # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
         # @param [Hash] opts the optional parameters
         # @return [BatchResponseSimplePublicObject]
@@ -227,7 +220,6 @@ module Hubspot
         end
 
         # Update a batch of contacts
-        # Perform a partial upate on a batch of contacts. This follows the same rules as performing partial updates on an individual object.
         # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
         # @param [Hash] opts the optional parameters
         # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers

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

@@ -0,0 +1,150 @@
+=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.3.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Contacts
+      class GDPRApi
+        attr_accessor :api_client
+
+        def initialize(api_client = ApiClient.default)
+          @api_client = api_client
+        end
+        # DELETE
+        # Permanently delete a contact by email address and all associated content to follow GDPR. If contact isn't found, blacklists an email address from being used in the future.
+        # @param email [String] 
+        # @param [Hash] opts the optional parameters
+        # @return [nil]
+        def purge_by_email(email, opts = {})
+          purge_by_email_with_http_info(email, opts)
+          nil
+        end
+
+        # DELETE
+        # Permanently delete a contact by email address and all associated content to follow GDPR. If contact isn't found, blacklists an email address from being used in the future.
+        # @param email [String] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+        def purge_by_email_with_http_info(email, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: GDPRApi.purge_by_email ...'
+          end
+          # verify the required parameter 'email' is set
+          if @api_client.config.client_side_validation && email.nil?
+            fail ArgumentError, "Missing the required parameter 'email' when calling GDPRApi.purge_by_email"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/gdpr/contacts/email/{email}'.sub('{' + 'email' + '}', CGI.escape(email.to_s))
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+
+          # header parameters
+          header_params = opts[:header_params] || {}
+          # HTTP header 'Accept' (if needed)
+          header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:body] 
+
+          # return_type
+          return_type = opts[:return_type] 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          new_options = opts.merge(
+            :header_params => header_params,
+            :query_params => query_params,
+            :form_params => form_params,
+            :body => post_body,
+            :auth_names => auth_names,
+            :return_type => return_type
+          )
+
+          data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: GDPRApi#purge_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # DELETE
+        # Permanently delete a contact by id and all associated content to follow GDPR
+        # @param contact_id [Integer] 
+        # @param [Hash] opts the optional parameters
+        # @return [nil]
+        def purge_by_id(contact_id, opts = {})
+          purge_by_id_with_http_info(contact_id, opts)
+          nil
+        end
+
+        # DELETE
+        # Permanently delete a contact by id and all associated content to follow GDPR
+        # @param contact_id [Integer] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+        def purge_by_id_with_http_info(contact_id, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: GDPRApi.purge_by_id ...'
+          end
+          # verify the required parameter 'contact_id' is set
+          if @api_client.config.client_side_validation && contact_id.nil?
+            fail ArgumentError, "Missing the required parameter 'contact_id' when calling GDPRApi.purge_by_id"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/gdpr/contacts/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_id.to_s))
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+
+          # header parameters
+          header_params = opts[:header_params] || {}
+          # HTTP header 'Accept' (if needed)
+          header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:body] 
+
+          # return_type
+          return_type = opts[:return_type] 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
+
+          new_options = opts.merge(
+            :header_params => header_params,
+            :query_params => query_params,
+            :form_params => form_params,
+            :body => post_body,
+            :auth_names => auth_names,
+            :return_type => return_type
+          )
+
+          data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: GDPRApi#purge_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+      end
+    end
+  end
+end

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

@@ -21,8 +21,6 @@ module Hubspot
         def initialize(api_client = ApiClient.default)
           @api_client = api_client
         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
         # @return [CollectionResponseWithTotalSimplePublicObjectForwardPaging]
@@ -31,8 +29,6 @@ module Hubspot
           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
         # @return [Array<(CollectionResponseWithTotalSimplePublicObjectForwardPaging, Integer, Hash)>] CollectionResponseWithTotalSimplePublicObjectForwardPaging data, response status code and response headers

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

@@ -55,21 +55,21 @@ module Hubspot
             @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
           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
+          if !response.success? && 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
 
+          unless response.success?
             if response.timed_out?
               fail ApiError.new('Connection timed out')
             elsif response.code == 0