hubspot-api-client 10.0.1 → 17.1.0

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 6.2.1
 
 =end
 
@@ -21,8 +21,139 @@ module Hubspot
         def initialize(api_client = ApiClient.default)
           @api_client = api_client
         end
+        # Archive a batch of quotes by ID
+        # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
+        # @param [Hash] opts the optional parameters
+        # @return [nil]
+        def archive(batch_input_simple_public_object_id, opts = {})
+          archive_with_http_info(batch_input_simple_public_object_id, opts)
+          nil
+        end
+
+        # Archive a batch of quotes by ID
+        # @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
+        def archive_with_http_info(batch_input_simple_public_object_id, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: BatchApi.archive ...'
+          end
+          # verify the required parameter 'batch_input_simple_public_object_id' is set
+          if @api_client.config.client_side_validation && batch_input_simple_public_object_id.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_id' when calling BatchApi.archive"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/quotes/batch/archive'
+
+          # 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(['*/*'])
+          # HTTP header 'Content-Type'
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_simple_public_object_id)
+
+          # return_type
+          return_type = opts[:debug_return_type]
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || ['oauth2']
+
+          new_options = opts.merge(
+            :operation => :"BatchApi.archive",
+            :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: BatchApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
+        # Create a batch of quotes
+        # @param batch_input_simple_public_object_input_for_create [BatchInputSimplePublicObjectInputForCreate] 
+        # @param [Hash] opts the optional parameters
+        # @return [BatchResponseSimplePublicObject]
+        def create(batch_input_simple_public_object_input_for_create, opts = {})
+          data, _status_code, _headers = create_with_http_info(batch_input_simple_public_object_input_for_create, opts)
+          data
+        end
+
+        # Create a batch of quotes
+        # @param batch_input_simple_public_object_input_for_create [BatchInputSimplePublicObjectInputForCreate] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
+        def create_with_http_info(batch_input_simple_public_object_input_for_create, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: BatchApi.create ...'
+          end
+          # verify the required parameter 'batch_input_simple_public_object_input_for_create' is set
+          if @api_client.config.client_side_validation && batch_input_simple_public_object_input_for_create.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_input_for_create' when calling BatchApi.create"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/quotes/batch/create'
+
+          # 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'
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_simple_public_object_input_for_create)
+
+          # return_type
+          return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject'
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || ['oauth2']
+
+          new_options = opts.merge(
+            :operation => :"BatchApi.create",
+            :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: BatchApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+
         # Read a batch of quotes by internal ID, or unique property values
-        # Read a list of quotes 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)
@@ -33,10 +164,9 @@ module Hubspot
         end
 
         # Read a batch of quotes by internal ID, or unique property values
-        # Read a list of quotes 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.
+        # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
         # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
         def read_with_http_info(batch_read_input_simple_public_object_id, opts = {})
           if @api_client.config.debugging
@@ -58,21 +188,25 @@ module Hubspot
           # 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'])
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
 
           # form parameters
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(batch_read_input_simple_public_object_id) 
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_read_input_simple_public_object_id)
 
           # return_type
-          return_type = opts[:return_type] || 'BatchResponseSimplePublicObject' 
+          return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject'
 
           # auth_names
-          auth_names = opts[:auth_names] || ['hapikey']
+          auth_names = opts[:debug_auth_names] || ['oauth2']
 
           new_options = opts.merge(
+            :operation => :"BatchApi.read",
             :header_params => header_params,
             :query_params => query_params,
             :form_params => form_params,
@@ -87,6 +221,72 @@ module Hubspot
           end
           return data, status_code, headers
         end
+
+        # Update a batch of quotes
+        # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
+        # @param [Hash] opts the optional parameters
+        # @return [BatchResponseSimplePublicObject]
+        def update(batch_input_simple_public_object_batch_input, opts = {})
+          data, _status_code, _headers = update_with_http_info(batch_input_simple_public_object_batch_input, opts)
+          data
+        end
+
+        # Update a batch of quotes
+        # @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
+        def update_with_http_info(batch_input_simple_public_object_batch_input, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: BatchApi.update ...'
+          end
+          # verify the required parameter 'batch_input_simple_public_object_batch_input' is set
+          if @api_client.config.client_side_validation && batch_input_simple_public_object_batch_input.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_batch_input' when calling BatchApi.update"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/quotes/batch/update'
+
+          # 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'
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_simple_public_object_batch_input)
+
+          # return_type
+          return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject'
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || ['oauth2']
+
+          new_options = opts.merge(
+            :operation => :"BatchApi.update",
+            :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: BatchApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
       end
     end
   end

data/lib/hubspot/codegen/crm/quotes/api/public_object_api.rb

@@ -0,0 +1,92 @@
+=begin
+#Quotes
+
+#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: 6.2.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Quotes
+      class PublicObjectApi
+        attr_accessor :api_client
+
+        def initialize(api_client = ApiClient.default)
+          @api_client = api_client
+        end
+        # Merge two quotes with same type
+        # @param public_merge_input [PublicMergeInput] 
+        # @param [Hash] opts the optional parameters
+        # @return [SimplePublicObject]
+        def merge(public_merge_input, opts = {})
+          data, _status_code, _headers = merge_with_http_info(public_merge_input, opts)
+          data
+        end
+
+        # Merge two quotes with same type
+        # @param public_merge_input [PublicMergeInput] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
+        def merge_with_http_info(public_merge_input, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: PublicObjectApi.merge ...'
+          end
+          # verify the required parameter 'public_merge_input' is set
+          if @api_client.config.client_side_validation && public_merge_input.nil?
+            fail ArgumentError, "Missing the required parameter 'public_merge_input' when calling PublicObjectApi.merge"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/quotes/merge'
+
+          # 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'
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
+
+          # form parameters
+          form_params = opts[:form_params] || {}
+
+          # http body (model)
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(public_merge_input)
+
+          # return_type
+          return_type = opts[:debug_return_type] || 'SimplePublicObject'
+
+          # auth_names
+          auth_names = opts[:debug_auth_names] || ['oauth2']
+
+          new_options = opts.merge(
+            :operation => :"PublicObjectApi.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: PublicObjectApi#merge\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/quotes/api/search_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 6.2.1
 
 =end
 
@@ -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
@@ -55,21 +51,25 @@ module Hubspot
           # 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'])
+          content_type = @api_client.select_header_content_type(['application/json'])
+          if !content_type.nil?
+              header_params['Content-Type'] = content_type
+          end
 
           # form parameters
           form_params = opts[:form_params] || {}
 
           # http body (model)
-          post_body = opts[:body] || @api_client.object_to_http_body(public_object_search_request) 
+          post_body = opts[:debug_body] || @api_client.object_to_http_body(public_object_search_request)
 
           # return_type
-          return_type = opts[:return_type] || 'CollectionResponseWithTotalSimplePublicObjectForwardPaging' 
+          return_type = opts[:debug_return_type] || 'CollectionResponseWithTotalSimplePublicObjectForwardPaging'
 
           # auth_names
-          auth_names = opts[:auth_names] || ['hapikey']
+          auth_names = opts[:debug_auth_names] || ['oauth2']
 
           new_options = opts.merge(
+            :operation => :"SearchApi.do_search",
             :header_params => header_params,
             :query_params => query_params,
             :form_params => form_params,

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 6.2.1
 
 =end
 
@@ -14,6 +14,7 @@ require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
+require 'time'
 require 'typhoeus'
 
 module Hubspot
@@ -102,12 +103,13 @@ module Hubspot
         # @option opts [Object] :body HTTP body (JSON/XML)
         # @return [Typhoeus::Request] A Typhoeus Request
         def build_request(http_method, path, opts = {})
-          url = build_request_url(path)
+          url = build_request_url(path, opts)
           http_method = http_method.to_sym.downcase
 
           header_params = @default_headers.merge(opts[:header_params] || {})
           query_params = opts[:query_params] || {}
           form_params = opts[:form_params] || {}
+          follow_location = opts[:follow_location] || true
 
           update_params_for_auth! header_params, query_params, opts[:auth_names]
 
@@ -124,7 +126,8 @@ module Hubspot
             :ssl_verifyhost => _verify_ssl_host,
             :sslcert => @config.cert_file,
             :sslkey => @config.key_file,
-            :verbose => @config.debugging
+            :verbose => @config.debugging,
+            :followlocation => follow_location
           }
 
           # set custom cert, if provided
@@ -171,6 +174,44 @@ module Hubspot
           data
         end
 
+        # Save response body into a file in (the defined) temporary folder, using the filename
+        # from the "Content-Disposition" header if provided, otherwise a random filename.
+        # The response body is written to the file in chunks in order to handle files which
+        # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+        # process can use.
+        #
+        # @see Configuration#temp_folder_path
+        def download_file(request)
+          tempfile = nil
+          encoding = nil
+          request.on_headers do |response|
+            content_disposition = response.headers['Content-Disposition']
+            if content_disposition && content_disposition =~ /filename=/i
+              filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+              prefix = sanitize_filename(filename)
+            else
+              prefix = 'download-'
+            end
+            prefix = prefix + '-' unless prefix.end_with?('-')
+            encoding = response.body.encoding
+            tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+            @tempfile = tempfile
+          end
+          request.on_body do |chunk|
+            chunk.force_encoding(encoding)
+            tempfile.write(chunk)
+          end
+          request.on_complete do |response|
+            if tempfile
+              tempfile.close
+              @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                                  "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                                  "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                                  "explicitly with `tempfile.delete`"
+            end
+          end
+        end
+
         # Check if the given MIME is a JSON MIME.
         # JSON MIME examples:
         #   application/json
@@ -207,7 +248,7 @@ module Hubspot
           begin
             data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
           rescue JSON::ParserError => e
-            if %w(String Date DateTime).include?(return_type)
+            if %w(String Date Time).include?(return_type)
               data = body
             else
               raise e
@@ -232,9 +273,9 @@ module Hubspot
             data.to_f
           when 'Boolean'
             data == true
-          when 'DateTime'
+          when 'Time'
             # parse date time (expecting ISO 8601 format)
-            DateTime.parse data
+            Time.parse data
           when 'Date'
             # parse date time (expecting ISO 8601 format)
             Date.parse data
@@ -252,46 +293,9 @@ module Hubspot
               data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
             end
           else
-            # models, e.g. Pet
-            Hubspot::Crm::Quotes.const_get(return_type).build_from_hash(data)
-          end
-        end
-
-        # Save response body into a file in (the defined) temporary folder, using the filename
-        # from the "Content-Disposition" header if provided, otherwise a random filename.
-        # The response body is written to the file in chunks in order to handle files which
-        # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
-        # process can use.
-        #
-        # @see Configuration#temp_folder_path
-        def download_file(request)
-          tempfile = nil
-          encoding = nil
-          request.on_headers do |response|
-            content_disposition = response.headers['Content-Disposition']
-            if content_disposition && content_disposition =~ /filename=/i
-              filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-              prefix = sanitize_filename(filename)
-            else
-              prefix = 'download-'
-            end
-            prefix = prefix + '-' unless prefix.end_with?('-')
-            encoding = response.body.encoding
-            tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-            @tempfile = tempfile
-          end
-          request.on_body do |chunk|
-            chunk.force_encoding(encoding)
-            tempfile.write(chunk)
-          end
-          request.on_complete do |response|
-            if tempfile
-              tempfile.close
-              @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                                  "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                                  "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                                  "explicitly with `tempfile.delete`"
-            end
+            # models (e.g. Pet) or oneOf
+            klass = Hubspot::Crm::Quotes.const_get(return_type)
+            klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
           end
         end
 
@@ -304,13 +308,13 @@ module Hubspot
           filename.gsub(/.*[\/\\]/, '')
         end
 
-        def build_request_url(path)
+        def build_request_url(path, opts = {})
           # Add leading and trailing slashes to path
           path = "/#{path}".gsub(/\/+/, '/')
-          @config.base_url + path
+          @config.base_url(opts[:operation]) + path
         end
 
-        # Update hearder and query params based on authentication settings.
+        # Update header and query params based on authentication settings.
         #
         # @param [Hash] header_params Header parameters
         # @param [Hash] query_params Query parameters
@@ -322,7 +326,7 @@ module Hubspot
             case auth_setting[:in]
             when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
             when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
-            else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+            else fail ArgumentError, 'Authentication token must be in `query` or `header`'
             end
           end
         end
@@ -349,8 +353,8 @@ module Hubspot
         # @param [Array] content_types array for Content-Type
         # @return [String] the Content-Type header  (e.g. application/json)
         def select_header_content_type(content_types)
-          # use application/json by default
-          return 'application/json' if content_types.nil? || content_types.empty?
+          # return nil by default
+          return if content_types.nil? || content_types.empty?
           # use JSON when present, otherwise use the first one
           json_content_type = content_types.find { |s| json_mime?(s) }
           json_content_type || content_types.first

data/lib/hubspot/codegen/crm/quotes/api_error.rb

@@ -6,14 +6,14 @@
 The version of the OpenAPI document: v3
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.1
+OpenAPI Generator version: 6.2.1
 
 =end
 
 module Hubspot
   module Crm
     module Quotes
-      class ApiError < StandardError
+      class ApiError < ::StandardError
         attr_reader :code, :response_headers, :response_body
 
         # Usage examples: