Class: UltracartClient::DatawarehouseApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/api/datawarehouse_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DatawarehouseApi

Returns a new instance of DatawarehouseApi.



19
20
21
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 17

def api_client
  @api_client
end

Class Method Details

.new_using_api_key(simple_key, verify_ssl = true, debugging = false) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 23

def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
  api_config = Configuration.new
  api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
  api_config.api_version = '2017-03-01'
  api_config.verify_ssl = verify_ssl

  api_client = ApiClient.new(api_config)
  api_client.config.debugging = debugging

  UltracartClient::DatawarehouseApi.new(api_client)
end

Instance Method Details

#delete_custom_report(custom_report_oid, opts = {}) ⇒ nil

Delete a custom report Delete a custom report on the UltraCart account.

Parameters:

  • custom_report_oid (Integer) —

    The report oid to delete.

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

    the optional parameters

Returns:

  • (nil) 


40
41
42
43
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 40

def delete_custom_report(custom_report_oid, opts = {})
  delete_custom_report_with_http_info(custom_report_oid, opts)
  nil
end

#delete_custom_report_with_http_info(custom_report_oid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a custom report Delete a custom report on the UltraCart account.

Parameters:

  • custom_report_oid (Integer) —

    The report oid to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
94
95
96
97
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 50

def delete_custom_report_with_http_info(custom_report_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.delete_custom_report ...'
  end
  # verify the required parameter 'custom_report_oid' is set
  if @api_client.config.client_side_validation && custom_report_oid.nil?
    fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.delete_custom_report"
  end
  # resource path
  local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}'.sub('{' + 'custom_report_oid' + '}', CGI.escape(custom_report_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#delete_report(report_oid, opts = {}) ⇒ nil

Delete a report Delete a report on the UltraCart account.

Parameters:

  • report_oid (Integer) —

    The report oid to delete.

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

    the optional parameters

Returns:

  • (nil) 


104
105
106
107
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 104

def delete_report(report_oid, opts = {})
  delete_report_with_http_info(report_oid, opts)
  nil
end

#delete_report_with_http_info(report_oid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a report Delete a report on the UltraCart account.

Parameters:

  • report_oid (Integer) —

    The report oid to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
154
155
156
157
158
159
160
161
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 114

def delete_report_with_http_info(report_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.delete_report ...'
  end
  # verify the required parameter 'report_oid' is set
  if @api_client.config.client_side_validation && report_oid.nil?
    fail ArgumentError, "Missing the required parameter 'report_oid' when calling DatawarehouseApi.delete_report"
  end
  # resource path
  local_var_path = '/datawarehouse/reports/{report_oid}'.sub('{' + 'report_oid' + '}', CGI.escape(report_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#dry_run_report_queries(query_request, opts = {}) ⇒ ReportDryRunQueriesResponse

Dry run the report queries Dry run the report queries

Parameters:

Returns:



168
169
170
171
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 168

def dry_run_report_queries(query_request, opts = {})
  data, _status_code, _headers = dry_run_report_queries_with_http_info(query_request, opts)
  data
end

#dry_run_report_queries_with_http_info(query_request, opts = {}) ⇒ Array<(ReportDryRunQueriesResponse, Integer, Hash)>

Dry run the report queries Dry run the report queries

Parameters:

Returns:

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

    ReportDryRunQueriesResponse data, response status code and response headers



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 178

def dry_run_report_queries_with_http_info(query_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.dry_run_report_queries ...'
  end
  # verify the required parameter 'query_request' is set
  if @api_client.config.client_side_validation && query_request.nil?
    fail ArgumentError, "Missing the required parameter 'query_request' when calling DatawarehouseApi.dry_run_report_queries"
  end
  # resource path
  local_var_path = '/datawarehouse/reports/dryrun'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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(query_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#execute_custom_report(custom_report_oid, execution_request, opts = {}) ⇒ CustomReportResponse

Execute a custom report Execute a custom report on the UltraCart account.

Parameters:

  • custom_report_oid (Integer) —

    The report oid to execute.

  • execution_request (CustomReportExecutionRequest) —

    Request to execute custom report

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

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 238

def execute_custom_report(custom_report_oid, execution_request, opts = {})
  data, _status_code, _headers = execute_custom_report_with_http_info(custom_report_oid, execution_request, opts)
  data
end

#execute_custom_report_with_http_info(custom_report_oid, execution_request, opts = {}) ⇒ Array<(CustomReportResponse, Integer, Hash)>

Execute a custom report Execute a custom report on the UltraCart account.

Parameters:

  • custom_report_oid (Integer) —

    The report oid to execute.

  • execution_request (CustomReportExecutionRequest) —

    Request to execute custom report

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

    the optional parameters

Returns:

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

    CustomReportResponse data, response status code and response headers



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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 249

def execute_custom_report_with_http_info(custom_report_oid, execution_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.execute_custom_report ...'
  end
  # verify the required parameter 'custom_report_oid' is set
  if @api_client.config.client_side_validation && custom_report_oid.nil?
    fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.execute_custom_report"
  end
  # verify the required parameter 'execution_request' is set
  if @api_client.config.client_side_validation && execution_request.nil?
    fail ArgumentError, "Missing the required parameter 'execution_request' when calling DatawarehouseApi.execute_custom_report"
  end
  # resource path
  local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}/execute'.sub('{' + 'custom_report_oid' + '}', CGI.escape(custom_report_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])
  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(execution_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#execute_report_queries(query_request, opts = {}) ⇒ nil

Execute the report queries Execute the report queries

Parameters:

Returns:

  • (nil) 


312
313
314
315
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 312

def execute_report_queries(query_request, opts = {})
  execute_report_queries_with_http_info(query_request, opts)
  nil
end

#execute_report_queries_with_http_info(query_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Execute the report queries Execute the report queries

Parameters:

Returns:

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

    nil, response status code and response headers



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 322

def execute_report_queries_with_http_info(query_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.execute_report_queries ...'
  end
  # verify the required parameter 'query_request' is set
  if @api_client.config.client_side_validation && query_request.nil?
    fail ArgumentError, "Missing the required parameter 'query_request' when calling DatawarehouseApi.execute_report_queries"
  end
  # resource path
  local_var_path = '/datawarehouse/reports/execute'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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(query_request)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#get_custom_report(custom_report_oid, opts = {}) ⇒ CustomReportResponse

Get a custom report Retrieve a custom report

Parameters:

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

    the optional parameters

Returns:



381
382
383
384
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 381

def get_custom_report(custom_report_oid, opts = {})
  data, _status_code, _headers = get_custom_report_with_http_info(custom_report_oid, opts)
  data
end

#get_custom_report_account_config(opts = {}) ⇒ CustomReportAccountConfigResponse

Get custom report account configuration Retrieve a custom report account configuration

Parameters:

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

    the optional parameters

Returns:



444
445
446
447
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 444

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

#get_custom_report_account_config_with_http_info(opts = {}) ⇒ Array<(CustomReportAccountConfigResponse, Integer, Hash)>

Get custom report account configuration Retrieve a custom report account configuration

Parameters:

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

    the optional parameters

Returns:



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 453

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_report_account_config ...'
  end
  # resource path
  local_var_path = '/datawarehouse/custom_reports/account_config'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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] || 'CustomReportAccountConfigResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#get_custom_report_with_http_info(custom_report_oid, opts = {}) ⇒ Array<(CustomReportResponse, Integer, Hash)>

Get a custom report Retrieve a custom report

Parameters:

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

    the optional parameters

Returns:

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

    CustomReportResponse data, response status code and response headers



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 391

def get_custom_report_with_http_info(custom_report_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_report ...'
  end
  # verify the required parameter 'custom_report_oid' is set
  if @api_client.config.client_side_validation && custom_report_oid.nil?
    fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.get_custom_report"
  end
  # resource path
  local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}'.sub('{' + 'custom_report_oid' + '}', CGI.escape(custom_report_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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] || 'CustomReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#get_report(report_oid, opts = {}) ⇒ ReportResponse

Get a report Retrieve a report

Parameters:

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

    the optional parameters

Returns:



503
504
505
506
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 503

def get_report(report_oid, opts = {})
  data, _status_code, _headers = get_report_with_http_info(report_oid, opts)
  data
end

#get_report_data_set(dataset_uuid, opts = {}) ⇒ ReportDataSetResponse

Get a report data set Retrieve a report data set

Parameters:

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

    the optional parameters

Returns:



567
568
569
570
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 567

def get_report_data_set(dataset_uuid, opts = {})
  data, _status_code, _headers = get_report_data_set_with_http_info(dataset_uuid, opts)
  data
end

#get_report_data_set_page(dataset_uuid, page_number, opts = {}) ⇒ ReportDataSetPageResponse

Get a report data set page Retrieve a report data set page

Parameters:

  • dataset_uuid (String)
  • page_number (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



632
633
634
635
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 632

def get_report_data_set_page(dataset_uuid, page_number, opts = {})
  data, _status_code, _headers = get_report_data_set_page_with_http_info(dataset_uuid, page_number, opts)
  data
end

#get_report_data_set_page_with_http_info(dataset_uuid, page_number, opts = {}) ⇒ Array<(ReportDataSetPageResponse, Integer, Hash)>

Get a report data set page Retrieve a report data set page

Parameters:

  • dataset_uuid (String)
  • page_number (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    ReportDataSetPageResponse data, response status code and response headers



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 643

def get_report_data_set_page_with_http_info(dataset_uuid, page_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_report_data_set_page ...'
  end
  # verify the required parameter 'dataset_uuid' is set
  if @api_client.config.client_side_validation && dataset_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_uuid' when calling DatawarehouseApi.get_report_data_set_page"
  end
  # verify the required parameter 'page_number' is set
  if @api_client.config.client_side_validation && page_number.nil?
    fail ArgumentError, "Missing the required parameter 'page_number' when calling DatawarehouseApi.get_report_data_set_page"
  end
  # resource path
  local_var_path = '/datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number}'.sub('{' + 'dataset_uuid' + '}', CGI.escape(dataset_uuid.to_s)).sub('{' + 'page_number' + '}', CGI.escape(page_number.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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] || 'ReportDataSetPageResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#get_report_data_set_with_http_info(dataset_uuid, opts = {}) ⇒ Array<(ReportDataSetResponse, Integer, Hash)>

Get a report data set Retrieve a report data set

Parameters:

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

    the optional parameters

Returns:

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

    ReportDataSetResponse data, response status code and response headers



577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 577

def get_report_data_set_with_http_info(dataset_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_report_data_set ...'
  end
  # verify the required parameter 'dataset_uuid' is set
  if @api_client.config.client_side_validation && dataset_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_uuid' when calling DatawarehouseApi.get_report_data_set"
  end
  # resource path
  local_var_path = '/datawarehouse/reports/dataset/{dataset_uuid}'.sub('{' + 'dataset_uuid' + '}', CGI.escape(dataset_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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] || 'ReportDataSetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#get_report_websocket_authorization(opts = {}) ⇒ ReportAuthResponse

Get report websocket authorization Retrieve a JWT to authorize a report to make a websocket connection.

Parameters:

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

    the optional parameters

Returns:



700
701
702
703
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 700

def get_report_websocket_authorization(opts = {})
  data, _status_code, _headers = get_report_websocket_authorization_with_http_info(opts)
  data
end

#get_report_websocket_authorization_with_http_info(opts = {}) ⇒ Array<(ReportAuthResponse, Integer, Hash)>

Get report websocket authorization Retrieve a JWT to authorize a report to make a websocket connection.

Parameters:

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

    the optional parameters

Returns:

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

    ReportAuthResponse data, response status code and response headers



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 709

def get_report_websocket_authorization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_report_websocket_authorization ...'
  end
  # resource path
  local_var_path = '/datawarehouse/reports/auth'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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] || 'ReportAuthResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#get_report_with_http_info(report_oid, opts = {}) ⇒ Array<(ReportResponse, Integer, Hash)>

Get a report Retrieve a report

Parameters:

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

    the optional parameters

Returns:

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

    ReportResponse data, response status code and response headers



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 513

def get_report_with_http_info(report_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_report ...'
  end
  # verify the required parameter 'report_oid' is set
  if @api_client.config.client_side_validation && report_oid.nil?
    fail ArgumentError, "Missing the required parameter 'report_oid' when calling DatawarehouseApi.get_report"
  end
  # resource path
  local_var_path = '/datawarehouse/reports/{report_oid}'.sub('{' + 'report_oid' + '}', CGI.escape(report_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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] || 'ReportResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#get_reports(opts = {}) ⇒ ReportsResponse

Get list of reports available Retrieve a list of reports available

Parameters:

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

    the optional parameters

Returns:



758
759
760
761
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 758

def get_reports(opts = {})
  data, _status_code, _headers = get_reports_with_http_info(opts)
  data
end

#get_reports_with_http_info(opts = {}) ⇒ Array<(ReportsResponse, Integer, Hash)>

Get list of reports available Retrieve a list of reports available

Parameters:

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

    the optional parameters

Returns:

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

    ReportsResponse data, response status code and response headers



767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 767

def get_reports_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_reports ...'
  end
  # resource path
  local_var_path = '/datawarehouse/reports'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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] || 'ReportsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#insert_custom_report(report, opts = {}) ⇒ CustomReportResponse

Create a custom report Create a new custom report on the UltraCart account.

Parameters:

  • report (CustomReport) —

    Report to create

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

    the optional parameters

Returns:



817
818
819
820
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 817

def insert_custom_report(report, opts = {})
  data, _status_code, _headers = insert_custom_report_with_http_info(report, opts)
  data
end

#insert_custom_report_with_http_info(report, opts = {}) ⇒ Array<(CustomReportResponse, Integer, Hash)>

Create a custom report Create a new custom report on the UltraCart account.

Parameters:

  • report (CustomReport) —

    Report to create

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

    the optional parameters

Returns:

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

    CustomReportResponse data, response status code and response headers



827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 827

def insert_custom_report_with_http_info(report, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.insert_custom_report ...'
  end
  # verify the required parameter 'report' is set
  if @api_client.config.client_side_validation && report.nil?
    fail ArgumentError, "Missing the required parameter 'report' when calling DatawarehouseApi.insert_custom_report"
  end
  # resource path
  local_var_path = '/datawarehouse/custom_reports'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])
  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(report)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#insert_report(report, opts = {}) ⇒ ReportResponse

Create a report Create a new report on the UltraCart account.

Parameters:

  • report (Report) —

    Report to create

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

    the optional parameters

Returns:



886
887
888
889
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 886

def insert_report(report, opts = {})
  data, _status_code, _headers = insert_report_with_http_info(report, opts)
  data
end

#insert_report_with_http_info(report, opts = {}) ⇒ Array<(ReportResponse, Integer, Hash)>

Create a report Create a new report on the UltraCart account.

Parameters:

  • report (Report) —

    Report to create

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

    the optional parameters

Returns:

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

    ReportResponse data, response status code and response headers



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 896

def insert_report_with_http_info(report, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.insert_report ...'
  end
  # verify the required parameter 'report' is set
  if @api_client.config.client_side_validation && report.nil?
    fail ArgumentError, "Missing the required parameter 'report' when calling DatawarehouseApi.insert_report"
  end
  # resource path
  local_var_path = '/datawarehouse/reports'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])
  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(report)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#update_custom_report(custom_report_oid, report, opts = {}) ⇒ CustomReportResponse

Update a custom report Update a custom report on the UltraCart account.

Parameters:

  • custom_report_oid (Integer) —

    The report oid to custom update.

  • report (CustomReport) —

    Report to custom update

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

    the optional parameters

Returns:



956
957
958
959
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 956

def update_custom_report(custom_report_oid, report, opts = {})
  data, _status_code, _headers = update_custom_report_with_http_info(custom_report_oid, report, opts)
  data
end

#update_custom_report_account_config(account_config, opts = {}) ⇒ CustomReportAccountConfigResponse

Update custom report account config Update custom report account config.

Parameters:

  • account_config (CustomReportAccountConfig) —

    Account config to update

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

    the optional parameters

Returns:



1030
1031
1032
1033
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 1030

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

#update_custom_report_account_config_with_http_info(account_config, opts = {}) ⇒ Array<(CustomReportAccountConfigResponse, Integer, Hash)>

Update custom report account config Update custom report account config.

Parameters:

  • account_config (CustomReportAccountConfig) —

    Account config to update

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

    the optional parameters

Returns:



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 1040

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_report_account_config ...'
  end
  # verify the required parameter 'account_config' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_config' when calling DatawarehouseApi.update_custom_report_account_config"
  end
  # resource path
  local_var_path = '/datawarehouse/custom_reports/account_config'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])
  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()

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#update_custom_report_with_http_info(custom_report_oid, report, opts = {}) ⇒ Array<(CustomReportResponse, Integer, Hash)>

Update a custom report Update a custom report on the UltraCart account.

Parameters:

  • custom_report_oid (Integer) —

    The report oid to custom update.

  • report (CustomReport) —

    Report to custom update

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

    the optional parameters

Returns:

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

    CustomReportResponse data, response status code and response headers



967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 967

def update_custom_report_with_http_info(custom_report_oid, report, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_report ...'
  end
  # verify the required parameter 'custom_report_oid' is set
  if @api_client.config.client_side_validation && custom_report_oid.nil?
    fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.update_custom_report"
  end
  # verify the required parameter 'report' is set
  if @api_client.config.client_side_validation && report.nil?
    fail ArgumentError, "Missing the required parameter 'report' when calling DatawarehouseApi.update_custom_report"
  end
  # resource path
  local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}'.sub('{' + 'custom_report_oid' + '}', CGI.escape(custom_report_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])
  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(report)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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

#update_report(report_oid, report, opts = {}) ⇒ ReportResponse

Update a report Update a report on the UltraCart account.

Parameters:

  • report_oid (Integer) —

    The report oid to update.

  • report (Report) —

    Report to update

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

    the optional parameters

Returns:



1100
1101
1102
1103
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 1100

def update_report(report_oid, report, opts = {})
  data, _status_code, _headers = update_report_with_http_info(report_oid, report, opts)
  data
end

#update_report_with_http_info(report_oid, report, opts = {}) ⇒ Array<(ReportResponse, Integer, Hash)>

Update a report Update a report on the UltraCart account.

Parameters:

  • report_oid (Integer) —

    The report oid to update.

  • report (Report) —

    Report to update

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

    the optional parameters

Returns:

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

    ReportResponse data, response status code and response headers



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/ultracart_api/api/datawarehouse_api.rb', line 1111

def update_report_with_http_info(report_oid, report, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_report ...'
  end
  # verify the required parameter 'report_oid' is set
  if @api_client.config.client_side_validation && report_oid.nil?
    fail ArgumentError, "Missing the required parameter 'report_oid' when calling DatawarehouseApi.update_report"
  end
  # verify the required parameter 'report' is set
  if @api_client.config.client_side_validation && report.nil?
    fail ArgumentError, "Missing the required parameter 'report' when calling DatawarehouseApi.update_report"
  end
  # resource path
  local_var_path = '/datawarehouse/reports/{report_oid}'.sub('{' + 'report_oid' + '}', CGI.escape(report_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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; charset=UTF-8'])
  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(report)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

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