Class: Hubspot::Crm::Exports::PublicExportsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/exports/api/public_exports_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PublicExportsApi 



21
22
23
 
# File 'lib/hubspot/codegen/crm/exports/api/public_exports_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/crm/exports/api/public_exports_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#get_status(task_id, opts = {}) ⇒ ActionResponseWithSingleResultURI

Get the status of the export including the URL to download the file Returns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE



29
30
31
32
 
# File 'lib/hubspot/codegen/crm/exports/api/public_exports_api.rb', line 29

def get_status(task_id, opts = {})
  data, _status_code, _headers = get_status_with_http_info(task_id, opts)
  data
end

#get_status_with_http_info(task_id, opts = {}) ⇒ Array<(ActionResponseWithSingleResultURI, Integer, Hash)>

Get the status of the export including the URL to download the file Returns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE



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
 
# File 'lib/hubspot/codegen/crm/exports/api/public_exports_api.rb', line 39

def get_status_with_http_info(task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicExportsApi.get_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 PublicExportsApi.get_status"
  end
  # resource path
  local_var_path = '/crm/v3/exports/export/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] || 'ActionResponseWithSingleResultURI'

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

  new_options = opts.merge(
    :operation => :"PublicExportsApi.get_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: PublicExportsApi#get_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#start(public_export_request, opts = {}) ⇒ TaskLocator

Start an export Begins exporting CRM data for the portal as specified in the request body



92
93
94
95
 
# File 'lib/hubspot/codegen/crm/exports/api/public_exports_api.rb', line 92

def start(public_export_request, opts = {})
  data, _status_code, _headers = start_with_http_info(public_export_request, opts)
  data
end

#start_with_http_info(public_export_request, opts = {}) ⇒ Array<(TaskLocator, Integer, Hash)>

Start an export Begins exporting CRM data for the portal as specified in the request body



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

def start_with_http_info(public_export_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicExportsApi.start ...'
  end
  # verify the required parameter 'public_export_request' is set
  if @api_client.config.client_side_validation && public_export_request.nil?
    fail ArgumentError, "Missing the required parameter 'public_export_request' when calling PublicExportsApi.start"
  end
  # resource path
  local_var_path = '/crm/v3/exports/export/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(public_export_request)

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

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

  new_options = opts.merge(
    :operation => :"PublicExportsApi.start",
    :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: PublicExportsApi#start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end