Class: Hubspot::Cms::SourceCode::SourceCodeExtractApi
- Inherits:
-
Object
- Object
- Hubspot::Cms::SourceCode::SourceCodeExtractApi
- Defined in:
- lib/hubspot/codegen/cms/source-code/api/source_code_extract_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
- #do_async(file_extract_request, opts = {}) ⇒ TaskLocator
-
#do_async_with_http_info(file_extract_request, opts = {}) ⇒ Array<(TaskLocator, Integer, Hash)>
TaskLocator data, response status code and response headers.
- #get_async_status(task_id, opts = {}) ⇒ ActionResponse
-
#get_async_status_with_http_info(task_id, opts = {}) ⇒ Array<(ActionResponse, Integer, Hash)>
ActionResponse data, response status code and response headers.
-
#initialize(api_client = ApiClient.default) ⇒ SourceCodeExtractApi
constructor
A new instance of SourceCodeExtractApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ SourceCodeExtractApi
Returns a new instance of SourceCodeExtractApi.
21 22 23 |
# File 'lib/hubspot/codegen/cms/source-code/api/source_code_extract_api.rb', line 21 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
19 20 21 |
# File 'lib/hubspot/codegen/cms/source-code/api/source_code_extract_api.rb', line 19 def api_client @api_client end |
Instance Method Details
#do_async(file_extract_request, opts = {}) ⇒ TaskLocator
27 28 29 30 |
# File 'lib/hubspot/codegen/cms/source-code/api/source_code_extract_api.rb', line 27 def do_async(file_extract_request, opts = {}) data, _status_code, _headers = do_async_with_http_info(file_extract_request, opts) data end |
#do_async_with_http_info(file_extract_request, opts = {}) ⇒ Array<(TaskLocator, Integer, Hash)>
Returns TaskLocator data, response status code and response headers.
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/hubspot/codegen/cms/source-code/api/source_code_extract_api.rb', line 35 def do_async_with_http_info(file_extract_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SourceCodeExtractApi.do_async ...' end # verify the required parameter 'file_extract_request' is set if @api_client.config.client_side_validation && file_extract_request.nil? fail ArgumentError, "Missing the required parameter 'file_extract_request' when calling SourceCodeExtractApi.do_async" end # resource path local_var_path = '/cms/v3/source-code/extract/async' # 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(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(file_extract_request) # return_type return_type = opts[:debug_return_type] || 'TaskLocator' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"SourceCodeExtractApi.do_async", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SourceCodeExtractApi#do_async\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_async_status(task_id, opts = {}) ⇒ ActionResponse
86 87 88 89 |
# File 'lib/hubspot/codegen/cms/source-code/api/source_code_extract_api.rb', line 86 def get_async_status(task_id, opts = {}) data, _status_code, _headers = get_async_status_with_http_info(task_id, opts) data end |
#get_async_status_with_http_info(task_id, opts = {}) ⇒ Array<(ActionResponse, Integer, Hash)>
Returns ActionResponse data, response status code and response headers.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/hubspot/codegen/cms/source-code/api/source_code_extract_api.rb', line 94 def get_async_status_with_http_info(task_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SourceCodeExtractApi.get_async_status ...' end # verify the required parameter 'task_id' is set if @api_client.config.client_side_validation && task_id.nil? fail ArgumentError, "Missing the required parameter 'task_id' when calling SourceCodeExtractApi.get_async_status" end # resource path local_var_path = '/cms/v3/source-code/extract/async/tasks/{taskId}/status'.sub('{' + 'taskId' + '}', CGI.escape(task_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(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ActionResponse' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"SourceCodeExtractApi.get_async_status", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SourceCodeExtractApi#get_async_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |