Class: Hubspot::Crm::Imports::PublicImportsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PublicImportsApi 



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

def api_client
  @api_client
end

Instance Method Details

#get_errors(import_id, opts = {}) ⇒ CollectionResponsePublicImportErrorForwardPaging

Options Hash (opts):

  • :after (String) —

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

  • :limit (Integer) —

    The maximum number of results to display per page.

  • :include_error_message (Boolean) —

    Set to True to receive a message explaining the error.

  • :include_row_data (Boolean) —

    Set to True to receive the data values for the errored row.



31
32
33
34
 
# File 'lib/hubspot/codegen/crm/imports/api/public_imports_api.rb', line 31

def get_errors(import_id, opts = {})
  data, _status_code, _headers = get_errors_with_http_info(import_id, opts)
  data
end

#get_errors_with_http_info(import_id, opts = {}) ⇒ Array<(CollectionResponsePublicImportErrorForwardPaging, Integer, Hash)>

Returns CollectionResponsePublicImportErrorForwardPaging data, response status code and response headers.

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.

  • :limit (Integer) —

    The maximum number of results to display per page.

  • :include_error_message (Boolean) —

    Set to True to receive a message explaining the error.

  • :include_row_data (Boolean) —

    Set to True to receive the data values for the errored row.



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
91
92
93
 
# File 'lib/hubspot/codegen/crm/imports/api/public_imports_api.rb', line 43

def get_errors_with_http_info(import_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicImportsApi.get_errors ...'
  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 PublicImportsApi.get_errors"
  end
  # resource path
  local_var_path = '/crm/v3/imports/{importId}/errors'.sub('{' + 'importId' + '}', CGI.escape(import_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'includeErrorMessage'] = opts[:'include_error_message'] if !opts[:'include_error_message'].nil?
  query_params[:'includeRowData'] = opts[:'include_row_data'] if !opts[:'include_row_data'].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[:debug_body]

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

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

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