Class: Hubspot::Cms::SourceCode::ExtractApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/cms/source_code/api/extract_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExtractApi

Returns a new instance of ExtractApi.



21
22
23
 
# File 'lib/hubspot/codegen/cms/source_code/api/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/extract_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#do_async(file_extract_request, opts = {}) ⇒ TaskLocator

Extract a zip file Extract a zip file in the developer file system. Extraction status can be checked with the ‘/extract/async/tasks/taskId/status` endpoint below.

Parameters:

  • file_extract_request (FileExtractRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/hubspot/codegen/cms/source_code/api/extract_api.rb', line 29

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)>

Extract a zip file Extract a zip file in the developer file system. Extraction status can be checked with the &#x60;/extract/async/tasks/taskId/status&#x60; endpoint below.

Parameters:

  • file_extract_request (FileExtractRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TaskLocator, Integer, Hash)>) —

    TaskLocator data, response status code and response headers



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
82
83
84
85
86
87
88
89
90
 
# File 'lib/hubspot/codegen/cms/source_code/api/extract_api.rb', line 39

def do_async_with_http_info(file_extract_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExtractApi.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 ExtractApi.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(['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(file_extract_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TaskLocator'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ExtractApi.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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExtractApi#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

Get extraction status Get the status of an extraction by the ‘taskId` returned from the initial `extract/async` request.

Parameters:

  • task_id (Integer) —

    The extraction task ID returned by the initial &#x60;extract/async&#x60; request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/hubspot/codegen/cms/source_code/api/extract_api.rb', line 97

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)>

Get extraction status Get the status of an extraction by the &#x60;taskId&#x60; returned from the initial &#x60;extract/async&#x60; request.

Parameters:

  • task_id (Integer) —

    The extraction task ID returned by the initial &#x60;extract/async&#x60; request.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ActionResponse, Integer, Hash)>) —

    ActionResponse data, response status code and response headers



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
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/hubspot/codegen/cms/source_code/api/extract_api.rb', line 107

def get_async_status_with_http_info(task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExtractApi.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 ExtractApi.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(['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] || 'ActionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ExtractApi.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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExtractApi#get_async_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end