hubspot-api-client 14.5.2 → 18.0.0

data/lib/hubspot/codegen/crm/extensions/calling/api/recording_settings_api.rb

@@ -0,0 +1,227 @@
+=begin
+#Calling Extensions
+
+#Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the *Call* action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.
+
+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 Extensions
+      module Calling
+        class RecordingSettingsApi
+          attr_accessor :api_client
+
+          def initialize(api_client = ApiClient.default)
+            @api_client = api_client
+          end
+          # @param app_id [Integer] 
+          # @param [Hash] opts the optional parameters
+          # @return [RecordingSettingsResponse]
+          def get_url_format(app_id, opts = {})
+            data, _status_code, _headers = get_url_format_with_http_info(app_id, opts)
+            data
+          end
+
+          # @param app_id [Integer] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(RecordingSettingsResponse, Integer, Hash)>] RecordingSettingsResponse data, response status code and response headers
+          def get_url_format_with_http_info(app_id, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: RecordingSettingsApi.get_url_format ...'
+            end
+            # verify the required parameter 'app_id' is set
+            if @api_client.config.client_side_validation && app_id.nil?
+              fail ArgumentError, "Missing the required parameter 'app_id' when calling RecordingSettingsApi.get_url_format"
+            end
+            # resource path
+            local_var_path = '/crm/v3/extensions/calling/{appId}/settings/recording'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
+
+            # query parameters
+            query_params = opts[:query_params] || {}
+
+            # header parameters
+            header_params = opts[:header_params] || {}
+            # HTTP header 'Accept' (if needed)
+            header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+
+            # form parameters
+            form_params = opts[:form_params] || {}
+
+            # http body (model)
+            post_body = opts[:debug_body]
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'RecordingSettingsResponse'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['developer_hapikey']
+
+            new_options = opts.merge(
+              :operation => :"RecordingSettingsApi.get_url_format",
+              :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(:GET, local_var_path, new_options)
+            if @api_client.config.debugging
+              @api_client.config.logger.debug "API called: RecordingSettingsApi#get_url_format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+
+          # @param app_id [Integer] 
+          # @param recording_settings_request [RecordingSettingsRequest] 
+          # @param [Hash] opts the optional parameters
+          # @return [RecordingSettingsResponse]
+          def register_url_format(app_id, recording_settings_request, opts = {})
+            data, _status_code, _headers = register_url_format_with_http_info(app_id, recording_settings_request, opts)
+            data
+          end
+
+          # @param app_id [Integer] 
+          # @param recording_settings_request [RecordingSettingsRequest] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(RecordingSettingsResponse, Integer, Hash)>] RecordingSettingsResponse data, response status code and response headers
+          def register_url_format_with_http_info(app_id, recording_settings_request, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: RecordingSettingsApi.register_url_format ...'
+            end
+            # verify the required parameter 'app_id' is set
+            if @api_client.config.client_side_validation && app_id.nil?
+              fail ArgumentError, "Missing the required parameter 'app_id' when calling RecordingSettingsApi.register_url_format"
+            end
+            # verify the required parameter 'recording_settings_request' is set
+            if @api_client.config.client_side_validation && recording_settings_request.nil?
+              fail ArgumentError, "Missing the required parameter 'recording_settings_request' when calling RecordingSettingsApi.register_url_format"
+            end
+            # resource path
+            local_var_path = '/crm/v3/extensions/calling/{appId}/settings/recording'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
+
+            # query parameters
+            query_params = opts[:query_params] || {}
+
+            # header parameters
+            header_params = opts[:header_params] || {}
+            # HTTP header 'Accept' (if needed)
+            header_params['Accept'] = @api_client.select_header_accept(['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(recording_settings_request)
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'RecordingSettingsResponse'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['developer_hapikey']
+
+            new_options = opts.merge(
+              :operation => :"RecordingSettingsApi.register_url_format",
+              :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: RecordingSettingsApi#register_url_format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+
+          # @param app_id [Integer] 
+          # @param recording_settings_patch_request [RecordingSettingsPatchRequest] 
+          # @param [Hash] opts the optional parameters
+          # @return [RecordingSettingsResponse]
+          def update_url_format(app_id, recording_settings_patch_request, opts = {})
+            data, _status_code, _headers = update_url_format_with_http_info(app_id, recording_settings_patch_request, opts)
+            data
+          end
+
+          # @param app_id [Integer] 
+          # @param recording_settings_patch_request [RecordingSettingsPatchRequest] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(RecordingSettingsResponse, Integer, Hash)>] RecordingSettingsResponse data, response status code and response headers
+          def update_url_format_with_http_info(app_id, recording_settings_patch_request, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: RecordingSettingsApi.update_url_format ...'
+            end
+            # verify the required parameter 'app_id' is set
+            if @api_client.config.client_side_validation && app_id.nil?
+              fail ArgumentError, "Missing the required parameter 'app_id' when calling RecordingSettingsApi.update_url_format"
+            end
+            # verify the required parameter 'recording_settings_patch_request' is set
+            if @api_client.config.client_side_validation && recording_settings_patch_request.nil?
+              fail ArgumentError, "Missing the required parameter 'recording_settings_patch_request' when calling RecordingSettingsApi.update_url_format"
+            end
+            # resource path
+            local_var_path = '/crm/v3/extensions/calling/{appId}/settings/recording'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
+
+            # query parameters
+            query_params = opts[:query_params] || {}
+
+            # header parameters
+            header_params = opts[:header_params] || {}
+            # HTTP header 'Accept' (if needed)
+            header_params['Accept'] = @api_client.select_header_accept(['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(recording_settings_patch_request)
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'RecordingSettingsResponse'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['developer_hapikey']
+
+            new_options = opts.merge(
+              :operation => :"RecordingSettingsApi.update_url_format",
+              :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(:PATCH, local_var_path, new_options)
+            if @api_client.config.debugging
+              @api_client.config.logger.debug "API called: RecordingSettingsApi#update_url_format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb

@@ -1,12 +1,12 @@
 =begin
-#Calling Extensions API
+#Calling Extensions
 
 #Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the *Call* action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.
 
 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
 
@@ -60,15 +60,16 @@ module Hubspot
             form_params = opts[:form_params] || {}
 
             # http body (model)
-            post_body = opts[:body] 
+            post_body = opts[:debug_body]
 
             # return_type
-            return_type = opts[:return_type] 
+            return_type = opts[:debug_return_type]
 
             # auth_names
-            auth_names = opts[:auth_names] || ['developer_hapikey']
+            auth_names = opts[:debug_auth_names] || ['developer_hapikey']
 
             new_options = opts.merge(
+              :operation => :"SettingsApi.archive",
               :header_params => header_params,
               :query_params => query_params,
               :form_params => form_params,
@@ -124,21 +125,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(settings_request) 
+            post_body = opts[:debug_body] || @api_client.object_to_http_body(settings_request)
 
             # return_type
-            return_type = opts[:return_type] || 'SettingsResponse' 
+            return_type = opts[:debug_return_type] || 'SettingsResponse'
 
             # auth_names
-            auth_names = opts[:auth_names] || ['developer_hapikey']
+            auth_names = opts[:debug_auth_names] || ['developer_hapikey']
 
             new_options = opts.merge(
+              :operation => :"SettingsApi.create",
               :header_params => header_params,
               :query_params => query_params,
               :form_params => form_params,
@@ -192,15 +197,16 @@ module Hubspot
             form_params = opts[:form_params] || {}
 
             # http body (model)
-            post_body = opts[:body] 
+            post_body = opts[:debug_body]
 
             # return_type
-            return_type = opts[:return_type] || 'SettingsResponse' 
+            return_type = opts[:debug_return_type] || 'SettingsResponse'
 
             # auth_names
-            auth_names = opts[:auth_names] || ['developer_hapikey']
+            auth_names = opts[:debug_auth_names] || ['developer_hapikey']
 
             new_options = opts.merge(
+              :operation => :"SettingsApi.get_by_id",
               :header_params => header_params,
               :query_params => query_params,
               :form_params => form_params,
@@ -256,21 +262,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(settings_patch_request) 
+            post_body = opts[:debug_body] || @api_client.object_to_http_body(settings_patch_request)
 
             # return_type
-            return_type = opts[:return_type] || 'SettingsResponse' 
+            return_type = opts[:debug_return_type] || 'SettingsResponse'
 
             # auth_names
-            auth_names = opts[:auth_names] || ['developer_hapikey']
+            auth_names = opts[:debug_auth_names] || ['developer_hapikey']
 
             new_options = opts.merge(
+              :operation => :"SettingsApi.update",
               :header_params => header_params,
               :query_params => query_params,
               :form_params => form_params,

data/lib/hubspot/codegen/crm/extensions/calling/api_client.rb

@@ -1,12 +1,12 @@
 =begin
-#Calling Extensions API
+#Calling Extensions
 
 #Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the *Call* action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.
 
 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
@@ -103,12 +104,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]
 
@@ -125,7 +127,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
@@ -172,6 +175,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
@@ -208,7 +249,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
@@ -233,9 +274,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
@@ -253,46 +294,9 @@ module Hubspot
                 data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
               end
             else
-              # models, e.g. Pet
-              Hubspot::Crm::Extensions::Calling.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::Extensions::Calling.const_get(return_type)
+              klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
             end
           end
 
@@ -305,13 +309,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
@@ -323,7 +327,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
@@ -350,8 +354,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/extensions/calling/api_error.rb

@@ -1,12 +1,12 @@
 =begin
-#Calling Extensions API
+#Calling Extensions
 
 #Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the *Call* action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.
 
 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