Class: Hubspot::Crm::Imports::CoreApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CoreApi

Returns a new instance of CoreApi.



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

def api_client
  @api_client
end

Instance Method Details

#cancel(import_id, opts = {}) ⇒ ActionResponse

Cancel an active import This allows a developer to cancel an active import.

Parameters:

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

    the optional parameters

Returns:



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

def cancel(import_id, opts = {})
  data, _status_code, _headers = cancel_with_http_info(import_id, opts)
  data
end

#cancel_with_http_info(import_id, opts = {}) ⇒ Array<(ActionResponse, Integer, Hash)>

Cancel an active import This allows a developer to cancel an active import.

Parameters:

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

    the optional parameters

Returns:

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

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

def cancel_with_http_info(import_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.cancel ...'
  end
  # verify the required parameter 'import_id' is set
  if @api_client.config.client_side_validation && import_id.nil?
    fail ArgumentError, "Missing the required parameter 'import_id' when calling CoreApi.cancel"
  end
  # resource path
  local_var_path = '/crm/v3/imports/{importId}/cancel'.sub('{' + 'importId' + '}', CGI.escape(import_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'ActionResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

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

#create(opts = {}) ⇒ PublicImportResponse

Start a new import Begins importing data from the specified file resources. This uploads the corresponding file and uses the import request object to convert rows in the files to objects.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :files (File) —

    A list of files containing the data to import

  • :import_request (String) —

    JSON formatted metadata about the import. This includes a name for the import and the column mappings for each file. See the overview tab for more on the required format.

Returns:



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

def create(opts = {})
  data, _status_code, _headers = create_with_http_info(opts)
  data
end

#create_with_http_info(opts = {}) ⇒ Array<(PublicImportResponse, Integer, Hash)>

Start a new import Begins importing data from the specified file resources. This uploads the corresponding file and uses the import request object to convert rows in the files to objects.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :files (File) —

    A list of files containing the data to import

  • :import_request (String) —

    JSON formatted metadata about the import. This includes a name for the import and the column mappings for each file. See the overview tab for more on the required format.

Returns:

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

    PublicImportResponse data, response status code and response headers



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
 
# File 'lib/hubspot/codegen/crm/imports/api/core_api.rb', line 103

def create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.create ...'
  end
  # resource path
  local_var_path = '/crm/v3/imports/'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['files'] = opts[:'files'] if !opts[:'files'].nil?
  form_params['importRequest'] = opts[:'import_request'] if !opts[:'import_request'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PublicImportResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

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

#get_by_id(import_id, opts = {}) ⇒ PublicImportResponse

Get the information on any import A complete summary of an import record, including any updates.

Parameters:

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

    the optional parameters

Returns:



155
156
157
158
 
# File 'lib/hubspot/codegen/crm/imports/api/core_api.rb', line 155

def get_by_id(import_id, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(import_id, opts)
  data
end

#get_by_id_with_http_info(import_id, opts = {}) ⇒ Array<(PublicImportResponse, Integer, Hash)>

Get the information on any import A complete summary of an import record, including any updates.

Parameters:

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

    the optional parameters

Returns:

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

    PublicImportResponse data, response status code and response headers



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/hubspot/codegen/crm/imports/api/core_api.rb', line 165

def get_by_id_with_http_info(import_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_by_id ...'
  end
  # verify the required parameter 'import_id' is set
  if @api_client.config.client_side_validation && import_id.nil?
    fail ArgumentError, "Missing the required parameter 'import_id' when calling CoreApi.get_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/imports/{importId}'.sub('{' + 'importId' + '}', CGI.escape(import_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'PublicImportResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

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

#get_page(opts = {}) ⇒ CollectionResponsePublicImportResponse

Get active imports Returns a paged list of active imports for this account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :before (String)
  • :limit (Integer) —

    The maximum number of results to display per page.

Returns:



219
220
221
222
 
# File 'lib/hubspot/codegen/crm/imports/api/core_api.rb', line 219

def get_page(opts = {})
  data, _status_code, _headers = get_page_with_http_info(opts)
  data
end

#get_page_with_http_info(opts = {}) ⇒ Array<(CollectionResponsePublicImportResponse, Integer, Hash)>

Get active imports Returns a paged list of active imports for this account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :before (String)
  • :limit (Integer) —

    The maximum number of results to display per page.

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/hubspot/codegen/crm/imports/api/core_api.rb', line 231

def get_page_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_page ...'
  end
  # resource path
  local_var_path = '/crm/v3/imports/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # 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[:body] 

  # return_type
  return_type = opts[:return_type] || 'CollectionResponsePublicImportResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

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