hubspot-api-client 16.2.0 → 16.2.1

data/lib/hubspot/codegen/cms/blogs/tags/models/tag.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Cms
     module Blogs
       module Tags
+        # Model definition for a Tag.
         class Tag
           # The unique ID of the Blog Tag.
           attr_accessor :id

data/lib/hubspot/codegen/cms/blogs/tags/models/tag_clone_request_v_next.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Cms
     module Blogs
       module Tags
+        # Request body object for cloning blog tags.
         class TagCloneRequestVNext
           # ID of the object to be cloned.
           attr_accessor :id

data/lib/hubspot/codegen/cms/blogs/tags/models/update_languages_request_v_next.rb

@@ -17,6 +17,7 @@ module Hubspot
   module Cms
     module Blogs
       module Tags
+        # Request object for updating languages within a multi-language group.
         class UpdateLanguagesRequestVNext
           # ID of the primary object in the multi-language group.
           attr_accessor :primary_id

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

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Conversations
     module VisitorIdentification
+      # Information used to generate a token
       class IdentificationTokenGenerationRequest
         # The email of the visitor that you wish to identify
         attr_accessor :email

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

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Conversations
     module VisitorIdentification
+      # The identification token to be passed to the Conversations JS API to identify the visitor
       class IdentificationTokenResponse
         attr_accessor :token
 

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

@@ -25,11 +25,11 @@ module Hubspot
         # Remove the associations between all pairs of objects identified in the request body.
         # @param from_object_type [String] 
         # @param to_object_type [String] 
+        # @param batch_input_public_association [BatchInputPublicAssociation] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputPublicAssociation] :batch_input_public_association 
         # @return [nil]
-        def archive(from_object_type, to_object_type, opts = {})
-          archive_with_http_info(from_object_type, to_object_type, opts)
+        def archive(from_object_type, to_object_type, batch_input_public_association, opts = {})
+          archive_with_http_info(from_object_type, to_object_type, batch_input_public_association, opts)
           nil
         end
 
@@ -37,10 +37,10 @@ module Hubspot
         # Remove the associations between all pairs of objects identified in the request body.
         # @param from_object_type [String] 
         # @param to_object_type [String] 
+        # @param batch_input_public_association [BatchInputPublicAssociation] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputPublicAssociation] :batch_input_public_association 
         # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-        def archive_with_http_info(from_object_type, to_object_type, opts = {})
+        def archive_with_http_info(from_object_type, to_object_type, batch_input_public_association, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BatchApi.archive ...'
           end
@@ -52,6 +52,10 @@ module Hubspot
           if @api_client.config.client_side_validation && to_object_type.nil?
             fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.archive"
           end
+          # verify the required parameter 'batch_input_public_association' is set
+          if @api_client.config.client_side_validation && batch_input_public_association.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_public_association' when calling BatchApi.archive"
+          end
           # resource path
           local_var_path = '/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archive'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
 
@@ -72,7 +76,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'batch_input_public_association'])
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_public_association)
 
           # return_type
           return_type = opts[:debug_return_type]
@@ -101,11 +105,11 @@ module Hubspot
         # Associate all pairs of objects identified in the request body.
         # @param from_object_type [String] 
         # @param to_object_type [String] 
+        # @param batch_input_public_association [BatchInputPublicAssociation] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputPublicAssociation] :batch_input_public_association 
         # @return [BatchResponsePublicAssociation]
-        def create(from_object_type, to_object_type, opts = {})
-          data, _status_code, _headers = create_with_http_info(from_object_type, to_object_type, opts)
+        def create(from_object_type, to_object_type, batch_input_public_association, opts = {})
+          data, _status_code, _headers = create_with_http_info(from_object_type, to_object_type, batch_input_public_association, opts)
           data
         end
 
@@ -113,10 +117,10 @@ module Hubspot
         # Associate all pairs of objects identified in the request body.
         # @param from_object_type [String] 
         # @param to_object_type [String] 
+        # @param batch_input_public_association [BatchInputPublicAssociation] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputPublicAssociation] :batch_input_public_association 
         # @return [Array<(BatchResponsePublicAssociation, Integer, Hash)>] BatchResponsePublicAssociation data, response status code and response headers
-        def create_with_http_info(from_object_type, to_object_type, opts = {})
+        def create_with_http_info(from_object_type, to_object_type, batch_input_public_association, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BatchApi.create ...'
           end
@@ -128,6 +132,10 @@ module Hubspot
           if @api_client.config.client_side_validation && to_object_type.nil?
             fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.create"
           end
+          # verify the required parameter 'batch_input_public_association' is set
+          if @api_client.config.client_side_validation && batch_input_public_association.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_public_association' when calling BatchApi.create"
+          end
           # resource path
           local_var_path = '/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
 
@@ -148,7 +156,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'batch_input_public_association'])
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_public_association)
 
           # return_type
           return_type = opts[:debug_return_type] || 'BatchResponsePublicAssociation'
@@ -177,11 +185,11 @@ module Hubspot
         # Get the IDs of all `{toObjectType}` objects associated with those specified in the request body.
         # @param from_object_type [String] 
         # @param to_object_type [String] 
+        # @param batch_input_public_object_id [BatchInputPublicObjectId] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputPublicObjectId] :batch_input_public_object_id 
         # @return [BatchResponsePublicAssociationMulti]
-        def read(from_object_type, to_object_type, opts = {})
-          data, _status_code, _headers = read_with_http_info(from_object_type, to_object_type, opts)
+        def read(from_object_type, to_object_type, batch_input_public_object_id, opts = {})
+          data, _status_code, _headers = read_with_http_info(from_object_type, to_object_type, batch_input_public_object_id, opts)
           data
         end
 
@@ -189,10 +197,10 @@ module Hubspot
         # Get the IDs of all &#x60;{toObjectType}&#x60; objects associated with those specified in the request body.
         # @param from_object_type [String] 
         # @param to_object_type [String] 
+        # @param batch_input_public_object_id [BatchInputPublicObjectId] 
         # @param [Hash] opts the optional parameters
-        # @option opts [BatchInputPublicObjectId] :batch_input_public_object_id 
         # @return [Array<(BatchResponsePublicAssociationMulti, Integer, Hash)>] BatchResponsePublicAssociationMulti data, response status code and response headers
-        def read_with_http_info(from_object_type, to_object_type, opts = {})
+        def read_with_http_info(from_object_type, to_object_type, batch_input_public_object_id, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: BatchApi.read ...'
           end
@@ -204,6 +212,10 @@ module Hubspot
           if @api_client.config.client_side_validation && to_object_type.nil?
             fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.read"
           end
+          # verify the required parameter 'batch_input_public_object_id' is set
+          if @api_client.config.client_side_validation && batch_input_public_object_id.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_public_object_id' when calling BatchApi.read"
+          end
           # resource path
           local_var_path = '/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/read'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
 
@@ -224,7 +236,7 @@ module Hubspot
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'batch_input_public_object_id'])
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_public_object_id)
 
           # return_type
           return_type = opts[:debug_return_type] || 'BatchResponsePublicAssociationMulti'

data/lib/hubspot/codegen/crm/associations/api/types_api.rb

@@ -26,7 +26,7 @@ module Hubspot
         # @param from_object_type [String] 
         # @param to_object_type [String] 
         # @param [Hash] opts the optional parameters
-        # @return [CollectionResponsePublicAssociationDefiniton]
+        # @return [CollectionResponsePublicAssociationDefinitionNoPaging]
         def get_all(from_object_type, to_object_type, opts = {})
           data, _status_code, _headers = get_all_with_http_info(from_object_type, to_object_type, opts)
           data
@@ -37,7 +37,7 @@ module Hubspot
         # @param from_object_type [String] 
         # @param to_object_type [String] 
         # @param [Hash] opts the optional parameters
-        # @return [Array<(CollectionResponsePublicAssociationDefiniton, Integer, Hash)>] CollectionResponsePublicAssociationDefiniton data, response status code and response headers
+        # @return [Array<(CollectionResponsePublicAssociationDefinitionNoPaging, Integer, Hash)>] CollectionResponsePublicAssociationDefinitionNoPaging data, response status code and response headers
         def get_all_with_http_info(from_object_type, to_object_type, opts = {})
           if @api_client.config.debugging
             @api_client.config.logger.debug 'Calling API: TypesApi.get_all ...'
@@ -68,7 +68,7 @@ module Hubspot
           post_body = opts[:debug_body]
 
           # return_type
-          return_type = opts[:debug_return_type] || 'CollectionResponsePublicAssociationDefiniton'
+          return_type = opts[:debug_return_type] || 'CollectionResponsePublicAssociationDefinitionNoPaging'
 
           # auth_names
           auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']

data/lib/hubspot/codegen/crm/associations/models/batch_response_public_association.rb

@@ -17,20 +17,18 @@ module Hubspot
   module Crm
     module Associations
       class BatchResponsePublicAssociation
-        attr_accessor :results
-
-        attr_accessor :num_errors
-
-        attr_accessor :errors
-
         attr_accessor :status
 
+        attr_accessor :results
+
         attr_accessor :requested_at
 
         attr_accessor :started_at
 
         attr_accessor :completed_at
 
+        attr_accessor :links
+
         class EnumAttributeValidator
           attr_reader :datatype
           attr_reader :allowable_values
@@ -56,13 +54,12 @@ module Hubspot
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'results' => :'results',
-            :'num_errors' => :'numErrors',
-            :'errors' => :'errors',
             :'status' => :'status',
+            :'results' => :'results',
             :'requested_at' => :'requestedAt',
             :'started_at' => :'startedAt',
-            :'completed_at' => :'completedAt'
+            :'completed_at' => :'completedAt',
+            :'links' => :'links'
           }
         end
 
@@ -74,13 +71,12 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'results' => :'Array<PublicAssociation>',
-            :'num_errors' => :'Integer',
-            :'errors' => :'Array<StandardError>',
             :'status' => :'String',
+            :'results' => :'Array<PublicAssociation>',
             :'requested_at' => :'Time',
             :'started_at' => :'Time',
-            :'completed_at' => :'Time'
+            :'completed_at' => :'Time',
+            :'links' => :'Hash<String, String>'
           }
         end
 
@@ -105,26 +101,16 @@ module Hubspot
             h[k.to_sym] = v
           }
 
+          if attributes.key?(:'status')
+            self.status = attributes[:'status']
+          end
+
           if attributes.key?(:'results')
             if (value = attributes[:'results']).is_a?(Array)
               self.results = value
             end
           end
 
-          if attributes.key?(:'num_errors')
-            self.num_errors = attributes[:'num_errors']
-          end
-
-          if attributes.key?(:'errors')
-            if (value = attributes[:'errors']).is_a?(Array)
-              self.errors = value
-            end
-          end
-
-          if attributes.key?(:'status')
-            self.status = attributes[:'status']
-          end
-
           if attributes.key?(:'requested_at')
             self.requested_at = attributes[:'requested_at']
           end
@@ -136,20 +122,26 @@ module Hubspot
           if attributes.key?(:'completed_at')
             self.completed_at = attributes[:'completed_at']
           end
+
+          if attributes.key?(:'links')
+            if (value = attributes[:'links']).is_a?(Hash)
+              self.links = value
+            end
+          end
         end
 
         # Show invalid properties with the reasons. Usually used together with valid?
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
-          if @results.nil?
-            invalid_properties.push('invalid value for "results", results cannot be nil.')
-          end
-
           if @status.nil?
             invalid_properties.push('invalid value for "status", status cannot be nil.')
           end
 
+          if @results.nil?
+            invalid_properties.push('invalid value for "results", results cannot be nil.')
+          end
+
           if @started_at.nil?
             invalid_properties.push('invalid value for "started_at", started_at cannot be nil.')
           end
@@ -164,10 +156,10 @@ module Hubspot
         # Check to see if the all the properties in the model are valid
         # @return true if the model is valid
         def valid?
-          return false if @results.nil?
           return false if @status.nil?
           status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
           return false unless status_validator.valid?(@status)
+          return false if @results.nil?
           return false if @started_at.nil?
           return false if @completed_at.nil?
           true
@@ -188,13 +180,12 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              results == o.results &&
-              num_errors == o.num_errors &&
-              errors == o.errors &&
               status == o.status &&
+              results == o.results &&
               requested_at == o.requested_at &&
               started_at == o.started_at &&
-              completed_at == o.completed_at
+              completed_at == o.completed_at &&
+              links == o.links
         end
 
         # @see the `==` method
@@ -206,7 +197,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [results, num_errors, errors, status, requested_at, started_at, completed_at].hash
+          [status, results, requested_at, started_at, completed_at, links].hash
         end
 
         # Builds the object from hash

data/lib/hubspot/codegen/crm/associations/models/batch_response_public_association_multi.rb

@@ -17,20 +17,18 @@ module Hubspot
   module Crm
     module Associations
       class BatchResponsePublicAssociationMulti
-        attr_accessor :results
-
-        attr_accessor :num_errors
-
-        attr_accessor :errors
-
         attr_accessor :status
 
+        attr_accessor :results
+
         attr_accessor :requested_at
 
         attr_accessor :started_at
 
         attr_accessor :completed_at
 
+        attr_accessor :links
+
         class EnumAttributeValidator
           attr_reader :datatype
           attr_reader :allowable_values
@@ -56,13 +54,12 @@ module Hubspot
         # Attribute mapping from ruby-style variable name to JSON key.
         def self.attribute_map
           {
-            :'results' => :'results',
-            :'num_errors' => :'numErrors',
-            :'errors' => :'errors',
             :'status' => :'status',
+            :'results' => :'results',
             :'requested_at' => :'requestedAt',
             :'started_at' => :'startedAt',
-            :'completed_at' => :'completedAt'
+            :'completed_at' => :'completedAt',
+            :'links' => :'links'
           }
         end
 
@@ -74,13 +71,12 @@ module Hubspot
         # Attribute type mapping.
         def self.openapi_types
           {
-            :'results' => :'Array<PublicAssociationMulti>',
-            :'num_errors' => :'Integer',
-            :'errors' => :'Array<StandardError>',
             :'status' => :'String',
+            :'results' => :'Array<PublicAssociationMulti>',
             :'requested_at' => :'Time',
             :'started_at' => :'Time',
-            :'completed_at' => :'Time'
+            :'completed_at' => :'Time',
+            :'links' => :'Hash<String, String>'
           }
         end
 
@@ -105,26 +101,16 @@ module Hubspot
             h[k.to_sym] = v
           }
 
+          if attributes.key?(:'status')
+            self.status = attributes[:'status']
+          end
+
           if attributes.key?(:'results')
             if (value = attributes[:'results']).is_a?(Array)
               self.results = value
             end
           end
 
-          if attributes.key?(:'num_errors')
-            self.num_errors = attributes[:'num_errors']
-          end
-
-          if attributes.key?(:'errors')
-            if (value = attributes[:'errors']).is_a?(Array)
-              self.errors = value
-            end
-          end
-
-          if attributes.key?(:'status')
-            self.status = attributes[:'status']
-          end
-
           if attributes.key?(:'requested_at')
             self.requested_at = attributes[:'requested_at']
           end
@@ -136,20 +122,26 @@ module Hubspot
           if attributes.key?(:'completed_at')
             self.completed_at = attributes[:'completed_at']
           end
+
+          if attributes.key?(:'links')
+            if (value = attributes[:'links']).is_a?(Hash)
+              self.links = value
+            end
+          end
         end
 
         # Show invalid properties with the reasons. Usually used together with valid?
         # @return Array for valid properties with the reasons
         def list_invalid_properties
           invalid_properties = Array.new
-          if @results.nil?
-            invalid_properties.push('invalid value for "results", results cannot be nil.')
-          end
-
           if @status.nil?
             invalid_properties.push('invalid value for "status", status cannot be nil.')
           end
 
+          if @results.nil?
+            invalid_properties.push('invalid value for "results", results cannot be nil.')
+          end
+
           if @started_at.nil?
             invalid_properties.push('invalid value for "started_at", started_at cannot be nil.')
           end
@@ -164,10 +156,10 @@ module Hubspot
         # Check to see if the all the properties in the model are valid
         # @return true if the model is valid
         def valid?
-          return false if @results.nil?
           return false if @status.nil?
           status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
           return false unless status_validator.valid?(@status)
+          return false if @results.nil?
           return false if @started_at.nil?
           return false if @completed_at.nil?
           true
@@ -188,13 +180,12 @@ module Hubspot
         def ==(o)
           return true if self.equal?(o)
           self.class == o.class &&
-              results == o.results &&
-              num_errors == o.num_errors &&
-              errors == o.errors &&
               status == o.status &&
+              results == o.results &&
               requested_at == o.requested_at &&
               started_at == o.started_at &&
-              completed_at == o.completed_at
+              completed_at == o.completed_at &&
+              links == o.links
         end
 
         # @see the `==` method
@@ -206,7 +197,7 @@ module Hubspot
         # Calculates hash code according to all attributes.
         # @return [Integer] Hash code
         def hash
-          [results, num_errors, errors, status, requested_at, started_at, completed_at].hash
+          [status, results, requested_at, started_at, completed_at, links].hash
         end
 
         # Builds the object from hash