hubspot-api-client 9.6.0 → 10.0.0

data/lib/hubspot/codegen/cms/site-search/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/cms/site-search/models/content_search_result.rb

@@ -16,38 +16,55 @@ module Hubspot
   module Cms
     module SiteSearch
       class ContentSearchResult
+        # The ID of the content.
         attr_accessor :id
 
+        # The matching score of the document.
         attr_accessor :score
 
+        # The type of document. Can be `SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`, `LISTING_PAGE`, or `KNOWLEDGE_ARTICLE`.
         attr_accessor :type
 
+        # The domain the document is hosted on.
         attr_accessor :domain
 
+        # The url of the document.
         attr_accessor :url
 
+        # URL of the featured image.
         attr_accessor :featured_image_url
 
+        # The document's language.
         attr_accessor :language
 
+        # The title of the returned document.
         attr_accessor :title
 
+        # The result's description. The content will be determined by the value of `length` in the request.
         attr_accessor :description
 
+        # For knowledge articles, the category of the article.
         attr_accessor :category
 
+        # For knowledge articles, the subcategory of the article.
         attr_accessor :subcategory
 
+        # Name of the author.
         attr_accessor :author_full_name
 
+        # If a blog post, the tags associated with it.
         attr_accessor :tags
 
+        # If a dynamic page, the ID of the HubDB table.
         attr_accessor :table_id
 
+        # If a dynamic page, the row ID in the HubDB table.
         attr_accessor :row_id
 
+        # The date the content was published.
         attr_accessor :published_date
 
+        # The ID of the document in HubSpot.
         attr_accessor :combined_id
 
         class EnumAttributeValidator
@@ -243,7 +260,7 @@ module Hubspot
           return false if @id.nil?
           return false if @score.nil?
           return false if @type.nil?
-          type_validator = EnumAttributeValidator.new('String', ["LANDING_PAGE", "BLOG_POST", "SITE_PAGE", "DOCUMENT", "KNOWLEDGE_ARTICLE", "LISTING_PAGE"])
+          type_validator = EnumAttributeValidator.new('String', ["LANDING_PAGE", "BLOG_POST", "SITE_PAGE", "KNOWLEDGE_ARTICLE", "LISTING_PAGE"])
           return false unless type_validator.valid?(@type)
           return false if @domain.nil?
           return false if @url.nil?
@@ -255,7 +272,7 @@ module Hubspot
         # Custom attribute writer method checking allowed values (enum).
         # @param [Object] type Object to be assigned
         def type=(type)
-          validator = EnumAttributeValidator.new('String', ["LANDING_PAGE", "BLOG_POST", "SITE_PAGE", "DOCUMENT", "KNOWLEDGE_ARTICLE", "LISTING_PAGE"])
+          validator = EnumAttributeValidator.new('String', ["LANDING_PAGE", "BLOG_POST", "SITE_PAGE", "KNOWLEDGE_ARTICLE", "LISTING_PAGE"])
           unless validator.valid?(type)
             fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
           end

data/lib/hubspot/codegen/cms/site-search/models/indexed_data.rb

@@ -16,10 +16,13 @@ module Hubspot
   module Cms
     module SiteSearch
       class IndexedData
+        # The ID of the document in HubSpot.
         attr_accessor :id
 
+        # The type of document. Can be `SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`, `LISTING_PAGE`, or `KNOWLEDGE_ARTICLE`.
         attr_accessor :type
 
+        # The indexed fields in HubSpot.
         attr_accessor :fields
 
         class EnumAttributeValidator
@@ -122,7 +125,7 @@ module Hubspot
         def valid?
           return false if @id.nil?
           return false if @type.nil?
-          type_validator = EnumAttributeValidator.new('String', ["LANDING_PAGE", "BLOG_POST", "SITE_PAGE", "DOCUMENT", "KNOWLEDGE_ARTICLE", "LISTING_PAGE"])
+          type_validator = EnumAttributeValidator.new('String', ["LANDING_PAGE", "BLOG_POST", "SITE_PAGE", "KNOWLEDGE_ARTICLE", "LISTING_PAGE"])
           return false unless type_validator.valid?(@type)
           return false if @fields.nil?
           true
@@ -131,7 +134,7 @@ module Hubspot
         # Custom attribute writer method checking allowed values (enum).
         # @param [Object] type Object to be assigned
         def type=(type)
-          validator = EnumAttributeValidator.new('String', ["LANDING_PAGE", "BLOG_POST", "SITE_PAGE", "DOCUMENT", "KNOWLEDGE_ARTICLE", "LISTING_PAGE"])
+          validator = EnumAttributeValidator.new('String', ["LANDING_PAGE", "BLOG_POST", "SITE_PAGE", "KNOWLEDGE_ARTICLE", "LISTING_PAGE"])
           unless validator.valid?(type)
             fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
           end

data/lib/hubspot/codegen/cms/site-search/models/search_hit_field.rb

@@ -16,10 +16,10 @@ module Hubspot
   module Cms
     module SiteSearch
       class SearchHitField
-        attr_accessor :metadata_field
-
         attr_accessor :values
 
+        attr_accessor :metadata_field
+
         attr_accessor :name
 
         attr_accessor :value
@@ -27,8 +27,8 @@ module Hubspot
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'metadata_field' => :'metadataField',
             :'values' => :'values',
+            :'metadata_field' => :'metadataField',
             :'name' => :'name',
             :'value' => :'value'
           }
@@ -37,8 +37,8 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
+            :'values' => :'Array<Object>',
             :'metadata_field' => :'Boolean',
-            :'values' => :'Array',
             :'name' => :'String',
             :'value' => :'Object'
           }
@@ -65,12 +65,14 @@ module Hubspot
             h[k.to_sym] = v
           }
 
-          if attributes.key?(:'metadata_field')
-            self.metadata_field = attributes[:'metadata_field']
+          if attributes.key?(:'values')
+            if (value = attributes[:'values']).is_a?(Array)
+              self.values = value
+            end
           end
 
-          if attributes.key?(:'values')
-            self.values = attributes[:'values']
+          if attributes.key?(:'metadata_field')
+            self.metadata_field = attributes[:'metadata_field']
           end
 
           if attributes.key?(:'name')
@@ -86,14 +88,14 @@ module Hubspot
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
-          if @metadata_field.nil?
-            invalid_properties.push('invalid value for "metadata_field", metadata_field cannot be nil.')
-          end
-
           if @values.nil?
             invalid_properties.push('invalid value for "values", values cannot be nil.')
           end
 
+          if @metadata_field.nil?
+            invalid_properties.push('invalid value for "metadata_field", metadata_field cannot be nil.')
+          end
+
           if @name.nil?
             invalid_properties.push('invalid value for "name", name cannot be nil.')
           end
@@ -108,8 +110,8 @@ 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 @metadata_field.nil?
           return false if @values.nil?
+          return false if @metadata_field.nil?
           return false if @name.nil?
           return false if @value.nil?
           true
@@ -120,8 +122,8 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              metadata_field == o.metadata_field &&
               values == o.values &&
+              metadata_field == o.metadata_field &&
               name == o.name &&
               value == o.value
         end
@@ -135,7 +137,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [metadata_field, values, name, value].hash
+          [values, metadata_field, name, value].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/cms/url-redirects/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/conversations/visitor-identification/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/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] || {}