hubspot-api-client 9.5.0 → 10.1.0

data/lib/hubspot/codegen/files/files/api_client.rb

@@ -55,6 +55,20 @@ module Hubspot
             @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
           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')

data/lib/hubspot/codegen/files/files/models/file_update_input.rb

@@ -127,7 +127,7 @@ module Hubspot
         # Check to see if the all the properties in the model are valid
         # @return true if the model is valid
         def valid?
-          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           return false unless access_validator.valid?(@access)
           true
         end
@@ -135,7 +135,7 @@ module Hubspot
         # Custom attribute writer method checking allowed values (enum).
         # @param [Object] access Object to be assigned
         def access=(access)
-          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           unless validator.valid?(access)
             fail ArgumentError, "invalid value for \"access\", must be one of #{validator.allowable_values}."
           end

data/lib/hubspot/codegen/files/files/models/{file.rb → hubspot_file.rb}

@@ -15,7 +15,7 @@ require 'date'
 module Hubspot
   module Files
     module Files
-      class File
+      class HubspotFile
         # File ID.
         attr_accessor :id
 
@@ -269,7 +269,7 @@ module Hubspot
           return false if @updated_at.nil?
           return false if @archived.nil?
           return false if @access.nil?
-          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           return false unless access_validator.valid?(@access)
           true
         end
@@ -277,7 +277,7 @@ module Hubspot
         # Custom attribute writer method checking allowed values (enum).
         # @param [Object] access Object to be assigned
         def access=(access)
-          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           unless validator.valid?(access)
             fail ArgumentError, "invalid value for \"access\", must be one of #{validator.allowable_values}."
           end

data/lib/hubspot/codegen/files/files/models/import_from_url_input.rb

@@ -184,7 +184,7 @@ module Hubspot
         # @return true if the model is valid
         def valid?
           return false if @access.nil?
-          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          access_validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           return false unless access_validator.valid?(@access)
           return false if @url.nil?
           return false if @duplicate_validation_strategy.nil?
@@ -200,7 +200,7 @@ module Hubspot
         # Custom attribute writer method checking allowed values (enum).
         # @param [Object] access Object to be assigned
         def access=(access)
-          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "PRIVATE"])
+          validator = EnumAttributeValidator.new('String', ["PUBLIC_INDEXABLE", "PUBLIC_NOT_INDEXABLE", "HIDDEN_INDEXABLE", "HIDDEN_NOT_INDEXABLE", "HIDDEN_PRIVATE", "PRIVATE"])
           unless validator.valid?(access)
             fail ArgumentError, "invalid value for \"access\", must be one of #{validator.allowable_values}."
           end

data/lib/hubspot/codegen/marketing/transactional/api/default_api.rb

@@ -83,6 +83,66 @@ module Hubspot
           return data, status_code, headers
         end
 
+        # Create a SMTP API token.
+        # Create a SMTP API token.
+        # @param [Hash] opts the optional parameters
+        # @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.
+        # @return [SmtpApiTokenView]
+        def create_token(opts = {})
+          data, _status_code, _headers = create_token_with_http_info(opts)
+          data
+        end
+
+        # Create a SMTP API token.
+        # Create a SMTP API token.
+        # @param [Hash] opts the optional parameters
+        # @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.
+        # @return [Array<(SmtpApiTokenView, Integer, Hash)>] SmtpApiTokenView data, response status code and response headers
+        def create_token_with_http_info(opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: DefaultApi.create_token ...'
+          end
+          # resource path
+          local_var_path = '/marketing/v3/transactional/smtp-tokens'
+
+          # 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(['application/json', '*/*'])
+          # HTTP header 'Content-Type'
+          header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'smtp_api_token_request_egg']) 
+
+          # return_type
+          return_type = opts[:return_type] || 'SmtpApiTokenView' 
+
+          # auth_names
+          auth_names = opts[:auth_names] || ['hapikey']
+
+          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(:POST, local_var_path, new_options)
+          if @api_client.config.debugging
+            @api_client.config.logger.debug "API called: DefaultApi#create_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
         # Query a single token by ID.
         # Query a single token by ID.
         # @param token_id [String] Identifier generated when a token is created.
@@ -213,66 +273,6 @@ module Hubspot
           return data, status_code, headers
         end
 
-        # Create a SMTP API token.
-        # Create a SMTP API token.
-        # @param [Hash] opts the optional parameters
-        # @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.
-        # @return [SmtpApiTokenView]
-        def create_token(opts = {})
-          data, _status_code, _headers = create_token_with_http_info(opts)
-          data
-        end
-
-        # Create a SMTP API token.
-        # Create a SMTP API token.
-        # @param [Hash] opts the optional parameters
-        # @option opts [SmtpApiTokenRequestEgg] :smtp_api_token_request_egg A request object that includes the campaign name tied to the token and whether contacts should be created for recipients of emails.
-        # @return [Array<(SmtpApiTokenView, Integer, Hash)>] SmtpApiTokenView data, response status code and response headers
-        def create_token_with_http_info(opts = {})
-          if @api_client.config.debugging
-            @api_client.config.logger.debug 'Calling API: DefaultApi.create_token ...'
-          end
-          # resource path
-          local_var_path = '/marketing/v3/transactional/smtp-tokens'
-
-          # 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(['application/json', '*/*'])
-          # HTTP header 'Content-Type'
-          header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-
-          # form parameters
-          form_params = opts[:form_params] || {}
-
-          # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(opts[:'smtp_api_token_request_egg']) 
-
-          # return_type
-          return_type = opts[:return_type] || 'SmtpApiTokenView' 
-
-          # auth_names
-          auth_names = opts[:auth_names] || ['hapikey']
-
-          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(:POST, local_var_path, new_options)
-          if @api_client.config.debugging
-            @api_client.config.logger.debug "API called: DefaultApi#create_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-          end
-          return data, status_code, headers
-        end
-
         # Reset the password of an existing token.
         # Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.
         # @param token_id [String] Identifier generated when a token is created.

data/lib/hubspot/codegen/marketing/transactional/api_client.rb

@@ -55,6 +55,20 @@ module Hubspot
             @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
           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')

data/lib/hubspot/codegen/oauth/api_client.rb

@@ -54,6 +54,20 @@ module Hubspot
           @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
         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')

data/lib/hubspot/codegen/webhooks/api_client.rb

@@ -54,6 +54,20 @@ module Hubspot
           @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
         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')

data/lib/hubspot/version.rb

@@ -1,3 +1,3 @@
  module Hubspot
-  VERSION = '9.5.0'
+  VERSION = '10.1.0'
  end

data/spec/codegen/cms/blogs/authors/api/default_api_spec.rb

@@ -33,10 +33,11 @@ describe 'DefaultApi' do
   end
 
   # unit tests for archive
-  # Archive a batch of Blog Authors
-  # Archive the Blog Author objects identified in the request body.
-  # @param batch_input_string The JSON array of Blog Author ids.
+  # Delete a Blog Author
+  # Delete the Blog Author object identified by the id in the path.
+  # @param object_id The Blog Author id.
   # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :archived Whether to return only results that have been archived.
   # @return [nil]
   describe 'archive test' do
     it 'should work' do
@@ -44,14 +45,13 @@ describe 'DefaultApi' do
     end
   end
 
-  # unit tests for archive_0
-  # Delete a Blog Author
-  # Delete the Blog Author object identified by the id in the path.
-  # @param object_id The Blog Author id.
+  # unit tests for archive_batch
+  # Archive a batch of Blog Authors
+  # Delete the Blog Author objects identified in the request body. Note: This is not the same as the in-app `archive` function.
+  # @param batch_input_string The JSON array of Blog Author ids.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :archived Whether to return only results that have been archived.
   # @return [nil]
-  describe 'archive_0 test' do
+  describe 'archive_batch test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -69,13 +69,13 @@ describe 'DefaultApi' do
     end
   end
 
-  # unit tests for create_0
+  # unit tests for create_batch
   # Create a batch of Blog Authors
   # Create the Blog Author objects detailed in the request body.
   # @param batch_input_blog_author The JSON array of new Blog Authors to create.
   # @param [Hash] opts the optional parameters
   # @return [Object]
-  describe 'create_0 test' do
+  describe 'create_batch test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -115,41 +115,41 @@ describe 'DefaultApi' do
     end
   end
 
-  # unit tests for read
+  # unit tests for read_batch
   # Retrieve a batch of Blog Authors
   # Retrieve the Blog Author objects identified in the request body.
   # @param batch_input_string The JSON array of Blog Author ids.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :archived Specifies whether to return archived Blog Authors. Defaults to `false`.
   # @return [Object]
-  describe 'read test' do
+  describe 'read_batch test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for update
-  # Update a batch of Blog Authors
-  # Update the Blog Author objects identified in the request body.
-  # @param batch_input_json_node A JSON array of the JSON representations of the updated Blog Authors.
+  # Update a Blog Author
+  # Sparse updates a single Blog Author object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified. 
+  # @param object_id The Blog Author id.
+  # @param blog_author The JSON representation of the updated Blog Author.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :archived Specifies whether to update archived Blog Authors. Defaults to `false`.
-  # @return [Object]
+  # @return [BlogAuthor]
   describe 'update test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  # unit tests for update_0
-  # Update a Blog Author
-  # Sparse updates a single Blog Author object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified. 
-  # @param object_id The Blog Author id.
-  # @param blog_author The JSON representation of the updated Blog Author.
+  # unit tests for update_batch
+  # Update a batch of Blog Authors
+  # Update the Blog Author objects identified in the request body.
+  # @param batch_input_json_node A JSON array of the JSON representations of the updated Blog Authors.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :archived Specifies whether to update archived Blog Authors. Defaults to `false`.
-  # @return [BlogAuthor]
-  describe 'update_0 test' do
+  # @return [Object]
+  describe 'update_batch test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/codegen/cms/blogs/blog-posts/api/default_api_spec.rb

@@ -33,10 +33,11 @@ describe 'DefaultApi' do
   end
 
   # unit tests for archive
-  # Archive a batch of Blog Posts
-  # Archive the Blog Post objects identified in the request body.
-  # @param batch_input_string The JSON array of Blog Post ids.
+  # Delete a Blog Post
+  # Delete the Blog Post object identified by the id in the path.
+  # @param object_id The Blog Post id.
   # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :archived Whether to return only results that have been archived.
   # @return [nil]
   describe 'archive test' do
     it 'should work' do
@@ -44,14 +45,13 @@ describe 'DefaultApi' do
     end
   end
 
-  # unit tests for archive_0
-  # Delete a Blog Post
-  # Delete the Blog Post object identified by the id in the path.
-  # @param object_id The Blog Post id.
+  # unit tests for archive_batch
+  # Archive a batch of Blog Posts
+  # Delete the Blog Post objects identified in the request body. Note: This is not the same as the in-app `archive` function. To perform an in-app `archive` send an normal update with the `archived` field set to true.
+  # @param batch_input_string The JSON array of Blog Post ids.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :archived Whether to return only results that have been archived.
   # @return [nil]
-  describe 'archive_0 test' do
+  describe 'archive_batch test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -81,13 +81,13 @@ describe 'DefaultApi' do
     end
   end
 
-  # unit tests for create_0
+  # unit tests for create_batch
   # Create a batch of Blog Posts
   # Create the Blog Post objects detailed in the request body.
   # @param batch_input_blog_post The JSON array of new Blog Posts to create.
   # @param [Hash] opts the optional parameters
   # @return [Object]
-  describe 'create_0 test' do
+  describe 'create_batch test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -179,14 +179,14 @@ describe 'DefaultApi' do
     end
   end
 
-  # unit tests for read
+  # unit tests for read_batch
   # Retrieve a batch of Blog Posts
   # Retrieve the Blog Post objects identified in the request body.
   # @param batch_input_string The JSON array of Blog Post ids.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :archived Specifies whether to return archived Blog Posts. Defaults to `false`.
   # @return [Object]
-  describe 'read test' do
+  describe 'read_batch test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -243,27 +243,27 @@ describe 'DefaultApi' do
   end
 
   # unit tests for update
-  # Update a batch of Blog Posts
-  # Update the Blog Post objects identified in the request body.
-  # @param batch_input_json_node 
+  # Update a Blog Post
+  # Sparse updates a single Blog Post object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified. 
+  # @param object_id The Blog Post id.
+  # @param blog_post The JSON representation of the updated Blog Post.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :archived Whether to return only results that have been archived.
-  # @return [Object]
+  # @option opts [Boolean] :archived Specifies whether to update archived Blog Posts. Defaults to `false`.
+  # @return [BlogPost]
   describe 'update test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  # unit tests for update_0
-  # Update a Blog Post
-  # Sparse updates a single Blog Post object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified. 
-  # @param object_id The Blog Post id.
-  # @param blog_post The JSON representation of the updated Blog Post.
+  # unit tests for update_batch
+  # Update a batch of Blog Posts
+  # Update the Blog Post objects identified in the request body.
+  # @param batch_input_json_node 
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :archived Specifies whether to update archived Blog Posts. Defaults to `false`.
-  # @return [BlogPost]
-  describe 'update_0 test' do
+  # @option opts [Boolean] :archived Whether to return only results that have been archived.
+  # @return [Object]
+  describe 'update_batch test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end