ultracart_api 4.1.163 → 4.1.166

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +201 -201
  3. data/README.md +611 -602
  4. data/docs/AffiliateApi.md +455 -455
  5. data/docs/AutoOrderApi.md +1694 -1694
  6. data/docs/BulkApi.md +335 -335
  7. data/docs/ChannelPartnerApi.md +1678 -1678
  8. data/docs/CheckoutApi.md +1622 -1622
  9. data/docs/ConversationApi.md +7867 -7867
  10. data/docs/ConversationEmbedApi.md +226 -226
  11. data/docs/CouponApi.md +1522 -1522
  12. data/docs/CustomerApi.md +2849 -2849
  13. data/docs/DatawarehouseApi.md +1637 -1637
  14. data/docs/EmailCommseqEmailReviewStatus.md +32 -0
  15. data/docs/EmailCommseqEmailReviewStatusResponse.md +26 -0
  16. data/docs/EmailCommseqEmailReviewStatusesRequest.md +18 -0
  17. data/docs/EmailCommseqEmailReviewStatusesResponse.md +26 -0
  18. data/docs/FraudApi.md +332 -332
  19. data/docs/FulfillmentApi.md +567 -567
  20. data/docs/GiftCertificateApi.md +617 -617
  21. data/docs/IntegrationLogApi.md +290 -290
  22. data/docs/ItemApi.md +2502 -2502
  23. data/docs/OauthApi.md +311 -311
  24. data/docs/OrderApi.md +3396 -3396
  25. data/docs/SfvbApi.md +3883 -3883
  26. data/docs/SsoApi.md +223 -223
  27. data/docs/StorefrontApi.md +10143 -10035
  28. data/docs/TaxApi.md +1699 -1699
  29. data/docs/UserApi.md +606 -606
  30. data/docs/WebhookApi.md +840 -840
  31. data/docs/WorkflowApi.md +666 -666
  32. data/lib/ultracart_api/api/storefront_api.rb +143 -0
  33. data/lib/ultracart_api/models/email_commseq_email_review_status.rb +324 -0
  34. data/lib/ultracart_api/models/email_commseq_email_review_status_response.rb +256 -0
  35. data/lib/ultracart_api/models/email_commseq_email_review_statuses_request.rb +222 -0
  36. data/lib/ultracart_api/models/email_commseq_email_review_statuses_response.rb +258 -0
  37. data/lib/ultracart_api/version.rb +1 -1
  38. data/lib/ultracart_api.rb +4 -0
  39. metadata +11 -3
data/docs/DatawarehouseApi.md CHANGED
@@ -1,1637 +1,1637 @@
1
- # UltracartClient::DatawarehouseApi
2
-
3
- All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**analyze_custom_report**](DatawarehouseApi.md#analyze_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/analysis | Analyze a custom report |
8
- | [**delete_custom_dashboard**](DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard |
9
- | [**delete_custom_dashboard_schedule**](DatawarehouseApi.md#delete_custom_dashboard_schedule) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Delete a custom dashboard schedule |
10
- | [**delete_custom_report**](DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report |
11
- | [**delete_report**](DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report |
12
- | [**dry_run_report_queries**](DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries |
13
- | [**execute_custom_report**](DatawarehouseApi.md#execute_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report |
14
- | [**execute_custom_reports**](DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports |
15
- | [**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries |
16
- | [**get_custom_dashboard**](DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard |
17
- | [**get_custom_dashboard_schedules**](DatawarehouseApi.md#get_custom_dashboard_schedules) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Get custom dashboards |
18
- | [**get_custom_dashboards**](DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards |
19
- | [**get_custom_report**](DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report |
20
- | [**get_custom_report_account_config**](DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration |
21
- | [**get_custom_report_chart_png_upload_url**](DatawarehouseApi.md#get_custom_report_chart_png_upload_url) | **GET** /datawarehouse/custom_reports/{custom_report_oid}/chart_png | Upload a PNG of a custom report chart |
22
- | [**get_custom_reports**](DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports |
23
- | [**get_report**](DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report |
24
- | [**get_report_data_set**](DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set |
25
- | [**get_report_data_set_page**](DatawarehouseApi.md#get_report_data_set_page) | **GET** /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} | Get a report data set page |
26
- | [**get_report_websocket_authorization**](DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization |
27
- | [**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available |
28
- | [**insert_custom_dashboard**](DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard |
29
- | [**insert_custom_dashboard_schedule**](DatawarehouseApi.md#insert_custom_dashboard_schedule) | **POST** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Create a custom dashboard schedule |
30
- | [**insert_custom_report**](DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report |
31
- | [**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report |
32
- | [**update_custom_dashboard**](DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard |
33
- | [**update_custom_dashboard_schedule**](DatawarehouseApi.md#update_custom_dashboard_schedule) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Update a custom dashboard schedule |
34
- | [**update_custom_report**](DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report |
35
- | [**update_custom_report_account_config**](DatawarehouseApi.md#update_custom_report_account_config) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config |
36
- | [**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report |
37
-
38
-
39
- ## analyze_custom_report
40
-
41
- > <CustomReportAnalysisResponse> analyze_custom_report(custom_report_oid, analyze_request)
42
-
43
- Analyze a custom report
44
-
45
- Analyze a custom report on the UltraCart account.
46
-
47
-
48
- ### Examples
49
-
50
-
51
- (No example for this operation).
52
-
53
-
54
- #### Using the analyze_custom_report_with_http_info variant
55
-
56
- This returns an Array which contains the response data, status code and headers.
57
-
58
- > <Array(<CustomReportAnalysisResponse>, Integer, Hash)> analyze_custom_report_with_http_info(custom_report_oid, analyze_request)
59
-
60
- ```ruby
61
- begin
62
- # Analyze a custom report
63
- data, status_code, headers = api_instance.analyze_custom_report_with_http_info(custom_report_oid, analyze_request)
64
- p status_code # => 2xx
65
- p headers # => { ... }
66
- p data # => <CustomReportAnalysisResponse>
67
- rescue UltracartClient::ApiError => e
68
- puts "Error when calling DatawarehouseApi->analyze_custom_report_with_http_info: #{e}"
69
- end
70
- ```
71
-
72
- ### Parameters
73
-
74
- | Name | Type | Description | Notes |
75
- | ---- | ---- | ----------- | ----- |
76
- | **custom_report_oid** | **Integer** | The report oid to analyze. | |
77
- | **analyze_request** | [**CustomReportAnalysisRequest**](CustomReportAnalysisRequest.md) | Request to analyze custom report | |
78
-
79
- ### Return type
80
-
81
- [**CustomReportAnalysisResponse**](CustomReportAnalysisResponse.md)
82
-
83
- ### Authorization
84
-
85
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
86
-
87
- ### HTTP request headers
88
-
89
- - **Content-Type**: application/json; charset=UTF-8
90
- - **Accept**: application/json
91
-
92
-
93
- ## delete_custom_dashboard
94
-
95
- > delete_custom_dashboard(custom_dashboard_oid)
96
-
97
- Delete a custom dashboard
98
-
99
- Delete a custom dashboard on the UltraCart account.
100
-
101
-
102
- ### Examples
103
-
104
-
105
- (No example for this operation).
106
-
107
-
108
- #### Using the delete_custom_dashboard_with_http_info variant
109
-
110
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
111
-
112
- > <Array(nil, Integer, Hash)> delete_custom_dashboard_with_http_info(custom_dashboard_oid)
113
-
114
- ```ruby
115
- begin
116
- # Delete a custom dashboard
117
- data, status_code, headers = api_instance.delete_custom_dashboard_with_http_info(custom_dashboard_oid)
118
- p status_code # => 2xx
119
- p headers # => { ... }
120
- p data # => nil
121
- rescue UltracartClient::ApiError => e
122
- puts "Error when calling DatawarehouseApi->delete_custom_dashboard_with_http_info: #{e}"
123
- end
124
- ```
125
-
126
- ### Parameters
127
-
128
- | Name | Type | Description | Notes |
129
- | ---- | ---- | ----------- | ----- |
130
- | **custom_dashboard_oid** | **Integer** | The dashboard oid to delete. | |
131
-
132
- ### Return type
133
-
134
- nil (empty response body)
135
-
136
- ### Authorization
137
-
138
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
139
-
140
- ### HTTP request headers
141
-
142
- - **Content-Type**: Not defined
143
- - **Accept**: application/json
144
-
145
-
146
- ## delete_custom_dashboard_schedule
147
-
148
- > delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid)
149
-
150
- Delete a custom dashboard schedule
151
-
152
- delete a custom dashboard schedule on the UltraCart account.
153
-
154
-
155
- ### Examples
156
-
157
-
158
- (No example for this operation).
159
-
160
-
161
- #### Using the delete_custom_dashboard_schedule_with_http_info variant
162
-
163
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
164
-
165
- > <Array(nil, Integer, Hash)> delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid)
166
-
167
- ```ruby
168
- begin
169
- # Delete a custom dashboard schedule
170
- data, status_code, headers = api_instance.delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid)
171
- p status_code # => 2xx
172
- p headers # => { ... }
173
- p data # => nil
174
- rescue UltracartClient::ApiError => e
175
- puts "Error when calling DatawarehouseApi->delete_custom_dashboard_schedule_with_http_info: #{e}"
176
- end
177
- ```
178
-
179
- ### Parameters
180
-
181
- | Name | Type | Description | Notes |
182
- | ---- | ---- | ----------- | ----- |
183
- | **custom_dashboard_schedule_oid** | **Integer** | The dashboard schedule oid to delete. | |
184
- | **custom_dashboard_oid** | **Integer** | The dashboard oid that owns the schedule. | |
185
-
186
- ### Return type
187
-
188
- nil (empty response body)
189
-
190
- ### Authorization
191
-
192
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
193
-
194
- ### HTTP request headers
195
-
196
- - **Content-Type**: Not defined
197
- - **Accept**: application/json
198
-
199
-
200
- ## delete_custom_report
201
-
202
- > delete_custom_report(custom_report_oid)
203
-
204
- Delete a custom report
205
-
206
- Delete a custom report on the UltraCart account.
207
-
208
-
209
- ### Examples
210
-
211
-
212
- (No example for this operation).
213
-
214
-
215
- #### Using the delete_custom_report_with_http_info variant
216
-
217
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
218
-
219
- > <Array(nil, Integer, Hash)> delete_custom_report_with_http_info(custom_report_oid)
220
-
221
- ```ruby
222
- begin
223
- # Delete a custom report
224
- data, status_code, headers = api_instance.delete_custom_report_with_http_info(custom_report_oid)
225
- p status_code # => 2xx
226
- p headers # => { ... }
227
- p data # => nil
228
- rescue UltracartClient::ApiError => e
229
- puts "Error when calling DatawarehouseApi->delete_custom_report_with_http_info: #{e}"
230
- end
231
- ```
232
-
233
- ### Parameters
234
-
235
- | Name | Type | Description | Notes |
236
- | ---- | ---- | ----------- | ----- |
237
- | **custom_report_oid** | **Integer** | The report oid to delete. | |
238
-
239
- ### Return type
240
-
241
- nil (empty response body)
242
-
243
- ### Authorization
244
-
245
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
246
-
247
- ### HTTP request headers
248
-
249
- - **Content-Type**: Not defined
250
- - **Accept**: application/json
251
-
252
-
253
- ## delete_report
254
-
255
- > delete_report(report_oid)
256
-
257
- Delete a report
258
-
259
- Delete a report on the UltraCart account.
260
-
261
-
262
- ### Examples
263
-
264
- ```ruby
265
- # Internal API. No samples are provided as merchants will never need this api method
266
- ```
267
-
268
-
269
- #### Using the delete_report_with_http_info variant
270
-
271
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
272
-
273
- > <Array(nil, Integer, Hash)> delete_report_with_http_info(report_oid)
274
-
275
- ```ruby
276
- begin
277
- # Delete a report
278
- data, status_code, headers = api_instance.delete_report_with_http_info(report_oid)
279
- p status_code # => 2xx
280
- p headers # => { ... }
281
- p data # => nil
282
- rescue UltracartClient::ApiError => e
283
- puts "Error when calling DatawarehouseApi->delete_report_with_http_info: #{e}"
284
- end
285
- ```
286
-
287
- ### Parameters
288
-
289
- | Name | Type | Description | Notes |
290
- | ---- | ---- | ----------- | ----- |
291
- | **report_oid** | **Integer** | The report oid to delete. | |
292
-
293
- ### Return type
294
-
295
- nil (empty response body)
296
-
297
- ### Authorization
298
-
299
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
300
-
301
- ### HTTP request headers
302
-
303
- - **Content-Type**: Not defined
304
- - **Accept**: application/json
305
-
306
-
307
- ## dry_run_report_queries
308
-
309
- > <ReportDryRunQueriesResponse> dry_run_report_queries(query_request)
310
-
311
- Dry run the report queries
312
-
313
- Dry run the report queries
314
-
315
-
316
- ### Examples
317
-
318
- ```ruby
319
- # Internal API. No samples are provided as merchants will never need this api method
320
- ```
321
-
322
-
323
- #### Using the dry_run_report_queries_with_http_info variant
324
-
325
- This returns an Array which contains the response data, status code and headers.
326
-
327
- > <Array(<ReportDryRunQueriesResponse>, Integer, Hash)> dry_run_report_queries_with_http_info(query_request)
328
-
329
- ```ruby
330
- begin
331
- # Dry run the report queries
332
- data, status_code, headers = api_instance.dry_run_report_queries_with_http_info(query_request)
333
- p status_code # => 2xx
334
- p headers # => { ... }
335
- p data # => <ReportDryRunQueriesResponse>
336
- rescue UltracartClient::ApiError => e
337
- puts "Error when calling DatawarehouseApi->dry_run_report_queries_with_http_info: #{e}"
338
- end
339
- ```
340
-
341
- ### Parameters
342
-
343
- | Name | Type | Description | Notes |
344
- | ---- | ---- | ----------- | ----- |
345
- | **query_request** | [**ReportDryRunQueriesRequest**](ReportDryRunQueriesRequest.md) | Dry run request | |
346
-
347
- ### Return type
348
-
349
- [**ReportDryRunQueriesResponse**](ReportDryRunQueriesResponse.md)
350
-
351
- ### Authorization
352
-
353
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
354
-
355
- ### HTTP request headers
356
-
357
- - **Content-Type**: application/json
358
- - **Accept**: application/json
359
-
360
-
361
- ## execute_custom_report
362
-
363
- > <CustomReportExecutionResponse> execute_custom_report(custom_report_oid, execution_request)
364
-
365
- Execute a custom report
366
-
367
- Execute a custom report on the UltraCart account.
368
-
369
-
370
- ### Examples
371
-
372
-
373
- (No example for this operation).
374
-
375
-
376
- #### Using the execute_custom_report_with_http_info variant
377
-
378
- This returns an Array which contains the response data, status code and headers.
379
-
380
- > <Array(<CustomReportExecutionResponse>, Integer, Hash)> execute_custom_report_with_http_info(custom_report_oid, execution_request)
381
-
382
- ```ruby
383
- begin
384
- # Execute a custom report
385
- data, status_code, headers = api_instance.execute_custom_report_with_http_info(custom_report_oid, execution_request)
386
- p status_code # => 2xx
387
- p headers # => { ... }
388
- p data # => <CustomReportExecutionResponse>
389
- rescue UltracartClient::ApiError => e
390
- puts "Error when calling DatawarehouseApi->execute_custom_report_with_http_info: #{e}"
391
- end
392
- ```
393
-
394
- ### Parameters
395
-
396
- | Name | Type | Description | Notes |
397
- | ---- | ---- | ----------- | ----- |
398
- | **custom_report_oid** | **Integer** | The report oid to execute. | |
399
- | **execution_request** | [**CustomReportExecutionRequest**](CustomReportExecutionRequest.md) | Request to execute custom report | |
400
-
401
- ### Return type
402
-
403
- [**CustomReportExecutionResponse**](CustomReportExecutionResponse.md)
404
-
405
- ### Authorization
406
-
407
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
408
-
409
- ### HTTP request headers
410
-
411
- - **Content-Type**: application/json; charset=UTF-8
412
- - **Accept**: application/json
413
-
414
-
415
- ## execute_custom_reports
416
-
417
- > <CustomReportsExecutionResponse> execute_custom_reports(execution_request)
418
-
419
- Execute a custom reports
420
-
421
- Execute a custom reports on the UltraCart account.
422
-
423
-
424
- ### Examples
425
-
426
-
427
- (No example for this operation).
428
-
429
-
430
- #### Using the execute_custom_reports_with_http_info variant
431
-
432
- This returns an Array which contains the response data, status code and headers.
433
-
434
- > <Array(<CustomReportsExecutionResponse>, Integer, Hash)> execute_custom_reports_with_http_info(execution_request)
435
-
436
- ```ruby
437
- begin
438
- # Execute a custom reports
439
- data, status_code, headers = api_instance.execute_custom_reports_with_http_info(execution_request)
440
- p status_code # => 2xx
441
- p headers # => { ... }
442
- p data # => <CustomReportsExecutionResponse>
443
- rescue UltracartClient::ApiError => e
444
- puts "Error when calling DatawarehouseApi->execute_custom_reports_with_http_info: #{e}"
445
- end
446
- ```
447
-
448
- ### Parameters
449
-
450
- | Name | Type | Description | Notes |
451
- | ---- | ---- | ----------- | ----- |
452
- | **execution_request** | [**CustomReportsExecutionRequest**](CustomReportsExecutionRequest.md) | Request to execute custom reports | |
453
-
454
- ### Return type
455
-
456
- [**CustomReportsExecutionResponse**](CustomReportsExecutionResponse.md)
457
-
458
- ### Authorization
459
-
460
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
461
-
462
- ### HTTP request headers
463
-
464
- - **Content-Type**: application/json; charset=UTF-8
465
- - **Accept**: application/json
466
-
467
-
468
- ## execute_report_queries
469
-
470
- > execute_report_queries(query_request)
471
-
472
- Execute the report queries
473
-
474
- Execute the report queries
475
-
476
-
477
- ### Examples
478
-
479
- ```ruby
480
- # Internal API. No samples are provided as merchants will never need this api method
481
- ```
482
-
483
-
484
- #### Using the execute_report_queries_with_http_info variant
485
-
486
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
487
-
488
- > <Array(nil, Integer, Hash)> execute_report_queries_with_http_info(query_request)
489
-
490
- ```ruby
491
- begin
492
- # Execute the report queries
493
- data, status_code, headers = api_instance.execute_report_queries_with_http_info(query_request)
494
- p status_code # => 2xx
495
- p headers # => { ... }
496
- p data # => nil
497
- rescue UltracartClient::ApiError => e
498
- puts "Error when calling DatawarehouseApi->execute_report_queries_with_http_info: #{e}"
499
- end
500
- ```
501
-
502
- ### Parameters
503
-
504
- | Name | Type | Description | Notes |
505
- | ---- | ---- | ----------- | ----- |
506
- | **query_request** | [**ReportExecuteQueriesRequest**](ReportExecuteQueriesRequest.md) | Query request | |
507
-
508
- ### Return type
509
-
510
- nil (empty response body)
511
-
512
- ### Authorization
513
-
514
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
515
-
516
- ### HTTP request headers
517
-
518
- - **Content-Type**: application/json
519
- - **Accept**: application/json
520
-
521
-
522
- ## get_custom_dashboard
523
-
524
- > <CustomDashboardResponse> get_custom_dashboard(custom_dashboard_oid)
525
-
526
- Get a custom dashboard
527
-
528
- Retrieve a custom dashboard
529
-
530
-
531
- ### Examples
532
-
533
-
534
- (No example for this operation).
535
-
536
-
537
- #### Using the get_custom_dashboard_with_http_info variant
538
-
539
- This returns an Array which contains the response data, status code and headers.
540
-
541
- > <Array(<CustomDashboardResponse>, Integer, Hash)> get_custom_dashboard_with_http_info(custom_dashboard_oid)
542
-
543
- ```ruby
544
- begin
545
- # Get a custom dashboard
546
- data, status_code, headers = api_instance.get_custom_dashboard_with_http_info(custom_dashboard_oid)
547
- p status_code # => 2xx
548
- p headers # => { ... }
549
- p data # => <CustomDashboardResponse>
550
- rescue UltracartClient::ApiError => e
551
- puts "Error when calling DatawarehouseApi->get_custom_dashboard_with_http_info: #{e}"
552
- end
553
- ```
554
-
555
- ### Parameters
556
-
557
- | Name | Type | Description | Notes |
558
- | ---- | ---- | ----------- | ----- |
559
- | **custom_dashboard_oid** | **Integer** | | |
560
-
561
- ### Return type
562
-
563
- [**CustomDashboardResponse**](CustomDashboardResponse.md)
564
-
565
- ### Authorization
566
-
567
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
568
-
569
- ### HTTP request headers
570
-
571
- - **Content-Type**: Not defined
572
- - **Accept**: application/json
573
-
574
-
575
- ## get_custom_dashboard_schedules
576
-
577
- > <CustomDashboardSchedulesResponse> get_custom_dashboard_schedules(custom_dashboard_oid)
578
-
579
- Get custom dashboards
580
-
581
- Retrieve a custom dashboards
582
-
583
-
584
- ### Examples
585
-
586
-
587
- (No example for this operation).
588
-
589
-
590
- #### Using the get_custom_dashboard_schedules_with_http_info variant
591
-
592
- This returns an Array which contains the response data, status code and headers.
593
-
594
- > <Array(<CustomDashboardSchedulesResponse>, Integer, Hash)> get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid)
595
-
596
- ```ruby
597
- begin
598
- # Get custom dashboards
599
- data, status_code, headers = api_instance.get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid)
600
- p status_code # => 2xx
601
- p headers # => { ... }
602
- p data # => <CustomDashboardSchedulesResponse>
603
- rescue UltracartClient::ApiError => e
604
- puts "Error when calling DatawarehouseApi->get_custom_dashboard_schedules_with_http_info: #{e}"
605
- end
606
- ```
607
-
608
- ### Parameters
609
-
610
- | Name | Type | Description | Notes |
611
- | ---- | ---- | ----------- | ----- |
612
- | **custom_dashboard_oid** | **Integer** | | |
613
-
614
- ### Return type
615
-
616
- [**CustomDashboardSchedulesResponse**](CustomDashboardSchedulesResponse.md)
617
-
618
- ### Authorization
619
-
620
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
621
-
622
- ### HTTP request headers
623
-
624
- - **Content-Type**: Not defined
625
- - **Accept**: application/json
626
-
627
-
628
- ## get_custom_dashboards
629
-
630
- > <CustomDashboardsResponse> get_custom_dashboards
631
-
632
- Get custom dashboards
633
-
634
- Retrieve a custom dashboards
635
-
636
-
637
- ### Examples
638
-
639
-
640
- (No example for this operation).
641
-
642
-
643
- #### Using the get_custom_dashboards_with_http_info variant
644
-
645
- This returns an Array which contains the response data, status code and headers.
646
-
647
- > <Array(<CustomDashboardsResponse>, Integer, Hash)> get_custom_dashboards_with_http_info
648
-
649
- ```ruby
650
- begin
651
- # Get custom dashboards
652
- data, status_code, headers = api_instance.get_custom_dashboards_with_http_info
653
- p status_code # => 2xx
654
- p headers # => { ... }
655
- p data # => <CustomDashboardsResponse>
656
- rescue UltracartClient::ApiError => e
657
- puts "Error when calling DatawarehouseApi->get_custom_dashboards_with_http_info: #{e}"
658
- end
659
- ```
660
-
661
- ### Parameters
662
-
663
- This endpoint does not need any parameter.
664
-
665
- ### Return type
666
-
667
- [**CustomDashboardsResponse**](CustomDashboardsResponse.md)
668
-
669
- ### Authorization
670
-
671
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
672
-
673
- ### HTTP request headers
674
-
675
- - **Content-Type**: Not defined
676
- - **Accept**: application/json
677
-
678
-
679
- ## get_custom_report
680
-
681
- > <CustomReportResponse> get_custom_report(custom_report_oid)
682
-
683
- Get a custom report
684
-
685
- Retrieve a custom report
686
-
687
-
688
- ### Examples
689
-
690
-
691
- (No example for this operation).
692
-
693
-
694
- #### Using the get_custom_report_with_http_info variant
695
-
696
- This returns an Array which contains the response data, status code and headers.
697
-
698
- > <Array(<CustomReportResponse>, Integer, Hash)> get_custom_report_with_http_info(custom_report_oid)
699
-
700
- ```ruby
701
- begin
702
- # Get a custom report
703
- data, status_code, headers = api_instance.get_custom_report_with_http_info(custom_report_oid)
704
- p status_code # => 2xx
705
- p headers # => { ... }
706
- p data # => <CustomReportResponse>
707
- rescue UltracartClient::ApiError => e
708
- puts "Error when calling DatawarehouseApi->get_custom_report_with_http_info: #{e}"
709
- end
710
- ```
711
-
712
- ### Parameters
713
-
714
- | Name | Type | Description | Notes |
715
- | ---- | ---- | ----------- | ----- |
716
- | **custom_report_oid** | **Integer** | | |
717
-
718
- ### Return type
719
-
720
- [**CustomReportResponse**](CustomReportResponse.md)
721
-
722
- ### Authorization
723
-
724
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
725
-
726
- ### HTTP request headers
727
-
728
- - **Content-Type**: Not defined
729
- - **Accept**: application/json
730
-
731
-
732
- ## get_custom_report_account_config
733
-
734
- > <CustomReportAccountConfigResponse> get_custom_report_account_config
735
-
736
- Get custom report account configuration
737
-
738
- Retrieve a custom report account configuration
739
-
740
-
741
- ### Examples
742
-
743
-
744
- (No example for this operation).
745
-
746
-
747
- #### Using the get_custom_report_account_config_with_http_info variant
748
-
749
- This returns an Array which contains the response data, status code and headers.
750
-
751
- > <Array(<CustomReportAccountConfigResponse>, Integer, Hash)> get_custom_report_account_config_with_http_info
752
-
753
- ```ruby
754
- begin
755
- # Get custom report account configuration
756
- data, status_code, headers = api_instance.get_custom_report_account_config_with_http_info
757
- p status_code # => 2xx
758
- p headers # => { ... }
759
- p data # => <CustomReportAccountConfigResponse>
760
- rescue UltracartClient::ApiError => e
761
- puts "Error when calling DatawarehouseApi->get_custom_report_account_config_with_http_info: #{e}"
762
- end
763
- ```
764
-
765
- ### Parameters
766
-
767
- This endpoint does not need any parameter.
768
-
769
- ### Return type
770
-
771
- [**CustomReportAccountConfigResponse**](CustomReportAccountConfigResponse.md)
772
-
773
- ### Authorization
774
-
775
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
776
-
777
- ### HTTP request headers
778
-
779
- - **Content-Type**: Not defined
780
- - **Accept**: application/json
781
-
782
-
783
- ## get_custom_report_chart_png_upload_url
784
-
785
- > <CustomReportChartPngUploadResponse> get_custom_report_chart_png_upload_url(custom_report_oid)
786
-
787
- Upload a PNG of a custom report chart
788
-
789
- Upload a PNG of a custom report chart
790
-
791
-
792
- ### Examples
793
-
794
-
795
- (No example for this operation).
796
-
797
-
798
- #### Using the get_custom_report_chart_png_upload_url_with_http_info variant
799
-
800
- This returns an Array which contains the response data, status code and headers.
801
-
802
- > <Array(<CustomReportChartPngUploadResponse>, Integer, Hash)> get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid)
803
-
804
- ```ruby
805
- begin
806
- # Upload a PNG of a custom report chart
807
- data, status_code, headers = api_instance.get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid)
808
- p status_code # => 2xx
809
- p headers # => { ... }
810
- p data # => <CustomReportChartPngUploadResponse>
811
- rescue UltracartClient::ApiError => e
812
- puts "Error when calling DatawarehouseApi->get_custom_report_chart_png_upload_url_with_http_info: #{e}"
813
- end
814
- ```
815
-
816
- ### Parameters
817
-
818
- | Name | Type | Description | Notes |
819
- | ---- | ---- | ----------- | ----- |
820
- | **custom_report_oid** | **Integer** | The report oid to upload a chart PNG for. | |
821
-
822
- ### Return type
823
-
824
- [**CustomReportChartPngUploadResponse**](CustomReportChartPngUploadResponse.md)
825
-
826
- ### Authorization
827
-
828
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
829
-
830
- ### HTTP request headers
831
-
832
- - **Content-Type**: Not defined
833
- - **Accept**: application/json
834
-
835
-
836
- ## get_custom_reports
837
-
838
- > <CustomReportsResponse> get_custom_reports
839
-
840
- Get custom reports
841
-
842
- Retrieve a custom reports
843
-
844
-
845
- ### Examples
846
-
847
-
848
- (No example for this operation).
849
-
850
-
851
- #### Using the get_custom_reports_with_http_info variant
852
-
853
- This returns an Array which contains the response data, status code and headers.
854
-
855
- > <Array(<CustomReportsResponse>, Integer, Hash)> get_custom_reports_with_http_info
856
-
857
- ```ruby
858
- begin
859
- # Get custom reports
860
- data, status_code, headers = api_instance.get_custom_reports_with_http_info
861
- p status_code # => 2xx
862
- p headers # => { ... }
863
- p data # => <CustomReportsResponse>
864
- rescue UltracartClient::ApiError => e
865
- puts "Error when calling DatawarehouseApi->get_custom_reports_with_http_info: #{e}"
866
- end
867
- ```
868
-
869
- ### Parameters
870
-
871
- This endpoint does not need any parameter.
872
-
873
- ### Return type
874
-
875
- [**CustomReportsResponse**](CustomReportsResponse.md)
876
-
877
- ### Authorization
878
-
879
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
880
-
881
- ### HTTP request headers
882
-
883
- - **Content-Type**: Not defined
884
- - **Accept**: application/json
885
-
886
-
887
- ## get_report
888
-
889
- > <ReportResponse> get_report(report_oid)
890
-
891
- Get a report
892
-
893
- Retrieve a report
894
-
895
-
896
- ### Examples
897
-
898
- ```ruby
899
- # Internal API. No samples are provided as merchants will never need this api method
900
- ```
901
-
902
-
903
- #### Using the get_report_with_http_info variant
904
-
905
- This returns an Array which contains the response data, status code and headers.
906
-
907
- > <Array(<ReportResponse>, Integer, Hash)> get_report_with_http_info(report_oid)
908
-
909
- ```ruby
910
- begin
911
- # Get a report
912
- data, status_code, headers = api_instance.get_report_with_http_info(report_oid)
913
- p status_code # => 2xx
914
- p headers # => { ... }
915
- p data # => <ReportResponse>
916
- rescue UltracartClient::ApiError => e
917
- puts "Error when calling DatawarehouseApi->get_report_with_http_info: #{e}"
918
- end
919
- ```
920
-
921
- ### Parameters
922
-
923
- | Name | Type | Description | Notes |
924
- | ---- | ---- | ----------- | ----- |
925
- | **report_oid** | **Integer** | | |
926
-
927
- ### Return type
928
-
929
- [**ReportResponse**](ReportResponse.md)
930
-
931
- ### Authorization
932
-
933
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
934
-
935
- ### HTTP request headers
936
-
937
- - **Content-Type**: Not defined
938
- - **Accept**: application/json
939
-
940
-
941
- ## get_report_data_set
942
-
943
- > <ReportDataSetResponse> get_report_data_set(dataset_uuid)
944
-
945
- Get a report data set
946
-
947
- Retrieve a report data set
948
-
949
-
950
- ### Examples
951
-
952
- ```ruby
953
- # Internal API. No samples are provided as merchants will never need this api method
954
- ```
955
-
956
-
957
- #### Using the get_report_data_set_with_http_info variant
958
-
959
- This returns an Array which contains the response data, status code and headers.
960
-
961
- > <Array(<ReportDataSetResponse>, Integer, Hash)> get_report_data_set_with_http_info(dataset_uuid)
962
-
963
- ```ruby
964
- begin
965
- # Get a report data set
966
- data, status_code, headers = api_instance.get_report_data_set_with_http_info(dataset_uuid)
967
- p status_code # => 2xx
968
- p headers # => { ... }
969
- p data # => <ReportDataSetResponse>
970
- rescue UltracartClient::ApiError => e
971
- puts "Error when calling DatawarehouseApi->get_report_data_set_with_http_info: #{e}"
972
- end
973
- ```
974
-
975
- ### Parameters
976
-
977
- | Name | Type | Description | Notes |
978
- | ---- | ---- | ----------- | ----- |
979
- | **dataset_uuid** | **String** | | |
980
-
981
- ### Return type
982
-
983
- [**ReportDataSetResponse**](ReportDataSetResponse.md)
984
-
985
- ### Authorization
986
-
987
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
988
-
989
- ### HTTP request headers
990
-
991
- - **Content-Type**: Not defined
992
- - **Accept**: application/json
993
-
994
-
995
- ## get_report_data_set_page
996
-
997
- > <ReportDataSetPageResponse> get_report_data_set_page(dataset_uuid, page_number)
998
-
999
- Get a report data set page
1000
-
1001
- Retrieve a report data set page
1002
-
1003
-
1004
- ### Examples
1005
-
1006
- ```ruby
1007
- # Internal API. No samples are provided as merchants will never need this api method
1008
- ```
1009
-
1010
-
1011
- #### Using the get_report_data_set_page_with_http_info variant
1012
-
1013
- This returns an Array which contains the response data, status code and headers.
1014
-
1015
- > <Array(<ReportDataSetPageResponse>, Integer, Hash)> get_report_data_set_page_with_http_info(dataset_uuid, page_number)
1016
-
1017
- ```ruby
1018
- begin
1019
- # Get a report data set page
1020
- data, status_code, headers = api_instance.get_report_data_set_page_with_http_info(dataset_uuid, page_number)
1021
- p status_code # => 2xx
1022
- p headers # => { ... }
1023
- p data # => <ReportDataSetPageResponse>
1024
- rescue UltracartClient::ApiError => e
1025
- puts "Error when calling DatawarehouseApi->get_report_data_set_page_with_http_info: #{e}"
1026
- end
1027
- ```
1028
-
1029
- ### Parameters
1030
-
1031
- | Name | Type | Description | Notes |
1032
- | ---- | ---- | ----------- | ----- |
1033
- | **dataset_uuid** | **String** | | |
1034
- | **page_number** | **Integer** | | |
1035
-
1036
- ### Return type
1037
-
1038
- [**ReportDataSetPageResponse**](ReportDataSetPageResponse.md)
1039
-
1040
- ### Authorization
1041
-
1042
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1043
-
1044
- ### HTTP request headers
1045
-
1046
- - **Content-Type**: Not defined
1047
- - **Accept**: application/json
1048
-
1049
-
1050
- ## get_report_websocket_authorization
1051
-
1052
- > <ReportAuthResponse> get_report_websocket_authorization
1053
-
1054
- Get report websocket authorization
1055
-
1056
- Retrieve a JWT to authorize a report to make a websocket connection.
1057
-
1058
-
1059
- ### Examples
1060
-
1061
- ```ruby
1062
- # Internal API. No samples are provided as merchants will never need this api method
1063
- ```
1064
-
1065
-
1066
- #### Using the get_report_websocket_authorization_with_http_info variant
1067
-
1068
- This returns an Array which contains the response data, status code and headers.
1069
-
1070
- > <Array(<ReportAuthResponse>, Integer, Hash)> get_report_websocket_authorization_with_http_info
1071
-
1072
- ```ruby
1073
- begin
1074
- # Get report websocket authorization
1075
- data, status_code, headers = api_instance.get_report_websocket_authorization_with_http_info
1076
- p status_code # => 2xx
1077
- p headers # => { ... }
1078
- p data # => <ReportAuthResponse>
1079
- rescue UltracartClient::ApiError => e
1080
- puts "Error when calling DatawarehouseApi->get_report_websocket_authorization_with_http_info: #{e}"
1081
- end
1082
- ```
1083
-
1084
- ### Parameters
1085
-
1086
- This endpoint does not need any parameter.
1087
-
1088
- ### Return type
1089
-
1090
- [**ReportAuthResponse**](ReportAuthResponse.md)
1091
-
1092
- ### Authorization
1093
-
1094
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1095
-
1096
- ### HTTP request headers
1097
-
1098
- - **Content-Type**: Not defined
1099
- - **Accept**: application/json
1100
-
1101
-
1102
- ## get_reports
1103
-
1104
- > <ReportsResponse> get_reports
1105
-
1106
- Get list of reports available
1107
-
1108
- Retrieve a list of reports available
1109
-
1110
-
1111
- ### Examples
1112
-
1113
- ```ruby
1114
- # Internal API. No samples are provided as merchants will never need this api method
1115
- ```
1116
-
1117
-
1118
- #### Using the get_reports_with_http_info variant
1119
-
1120
- This returns an Array which contains the response data, status code and headers.
1121
-
1122
- > <Array(<ReportsResponse>, Integer, Hash)> get_reports_with_http_info
1123
-
1124
- ```ruby
1125
- begin
1126
- # Get list of reports available
1127
- data, status_code, headers = api_instance.get_reports_with_http_info
1128
- p status_code # => 2xx
1129
- p headers # => { ... }
1130
- p data # => <ReportsResponse>
1131
- rescue UltracartClient::ApiError => e
1132
- puts "Error when calling DatawarehouseApi->get_reports_with_http_info: #{e}"
1133
- end
1134
- ```
1135
-
1136
- ### Parameters
1137
-
1138
- This endpoint does not need any parameter.
1139
-
1140
- ### Return type
1141
-
1142
- [**ReportsResponse**](ReportsResponse.md)
1143
-
1144
- ### Authorization
1145
-
1146
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1147
-
1148
- ### HTTP request headers
1149
-
1150
- - **Content-Type**: Not defined
1151
- - **Accept**: application/json
1152
-
1153
-
1154
- ## insert_custom_dashboard
1155
-
1156
- > <CustomDashboardResponse> insert_custom_dashboard(dashboard)
1157
-
1158
- Create a custom dashboard
1159
-
1160
- Create a new custom dashboard on the UltraCart account.
1161
-
1162
-
1163
- ### Examples
1164
-
1165
-
1166
- (No example for this operation).
1167
-
1168
-
1169
- #### Using the insert_custom_dashboard_with_http_info variant
1170
-
1171
- This returns an Array which contains the response data, status code and headers.
1172
-
1173
- > <Array(<CustomDashboardResponse>, Integer, Hash)> insert_custom_dashboard_with_http_info(dashboard)
1174
-
1175
- ```ruby
1176
- begin
1177
- # Create a custom dashboard
1178
- data, status_code, headers = api_instance.insert_custom_dashboard_with_http_info(dashboard)
1179
- p status_code # => 2xx
1180
- p headers # => { ... }
1181
- p data # => <CustomDashboardResponse>
1182
- rescue UltracartClient::ApiError => e
1183
- puts "Error when calling DatawarehouseApi->insert_custom_dashboard_with_http_info: #{e}"
1184
- end
1185
- ```
1186
-
1187
- ### Parameters
1188
-
1189
- | Name | Type | Description | Notes |
1190
- | ---- | ---- | ----------- | ----- |
1191
- | **dashboard** | [**CustomDashboard**](CustomDashboard.md) | Dashboard to create | |
1192
-
1193
- ### Return type
1194
-
1195
- [**CustomDashboardResponse**](CustomDashboardResponse.md)
1196
-
1197
- ### Authorization
1198
-
1199
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1200
-
1201
- ### HTTP request headers
1202
-
1203
- - **Content-Type**: application/json; charset=UTF-8
1204
- - **Accept**: application/json
1205
-
1206
-
1207
- ## insert_custom_dashboard_schedule
1208
-
1209
- > <CustomDashboardScheduleResponse> insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule)
1210
-
1211
- Create a custom dashboard schedule
1212
-
1213
- Create a new custom dashboard schedule on the UltraCart account.
1214
-
1215
-
1216
- ### Examples
1217
-
1218
-
1219
- (No example for this operation).
1220
-
1221
-
1222
- #### Using the insert_custom_dashboard_schedule_with_http_info variant
1223
-
1224
- This returns an Array which contains the response data, status code and headers.
1225
-
1226
- > <Array(<CustomDashboardScheduleResponse>, Integer, Hash)> insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule)
1227
-
1228
- ```ruby
1229
- begin
1230
- # Create a custom dashboard schedule
1231
- data, status_code, headers = api_instance.insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule)
1232
- p status_code # => 2xx
1233
- p headers # => { ... }
1234
- p data # => <CustomDashboardScheduleResponse>
1235
- rescue UltracartClient::ApiError => e
1236
- puts "Error when calling DatawarehouseApi->insert_custom_dashboard_schedule_with_http_info: #{e}"
1237
- end
1238
- ```
1239
-
1240
- ### Parameters
1241
-
1242
- | Name | Type | Description | Notes |
1243
- | ---- | ---- | ----------- | ----- |
1244
- | **custom_dashboard_oid** | **Integer** | | |
1245
- | **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md) | Dashboard schedule to create | |
1246
-
1247
- ### Return type
1248
-
1249
- [**CustomDashboardScheduleResponse**](CustomDashboardScheduleResponse.md)
1250
-
1251
- ### Authorization
1252
-
1253
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1254
-
1255
- ### HTTP request headers
1256
-
1257
- - **Content-Type**: application/json; charset=UTF-8
1258
- - **Accept**: application/json
1259
-
1260
-
1261
- ## insert_custom_report
1262
-
1263
- > <CustomReportResponse> insert_custom_report(report)
1264
-
1265
- Create a custom report
1266
-
1267
- Create a new custom report on the UltraCart account.
1268
-
1269
-
1270
- ### Examples
1271
-
1272
-
1273
- (No example for this operation).
1274
-
1275
-
1276
- #### Using the insert_custom_report_with_http_info variant
1277
-
1278
- This returns an Array which contains the response data, status code and headers.
1279
-
1280
- > <Array(<CustomReportResponse>, Integer, Hash)> insert_custom_report_with_http_info(report)
1281
-
1282
- ```ruby
1283
- begin
1284
- # Create a custom report
1285
- data, status_code, headers = api_instance.insert_custom_report_with_http_info(report)
1286
- p status_code # => 2xx
1287
- p headers # => { ... }
1288
- p data # => <CustomReportResponse>
1289
- rescue UltracartClient::ApiError => e
1290
- puts "Error when calling DatawarehouseApi->insert_custom_report_with_http_info: #{e}"
1291
- end
1292
- ```
1293
-
1294
- ### Parameters
1295
-
1296
- | Name | Type | Description | Notes |
1297
- | ---- | ---- | ----------- | ----- |
1298
- | **report** | [**CustomReport**](CustomReport.md) | Report to create | |
1299
-
1300
- ### Return type
1301
-
1302
- [**CustomReportResponse**](CustomReportResponse.md)
1303
-
1304
- ### Authorization
1305
-
1306
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1307
-
1308
- ### HTTP request headers
1309
-
1310
- - **Content-Type**: application/json; charset=UTF-8
1311
- - **Accept**: application/json
1312
-
1313
-
1314
- ## insert_report
1315
-
1316
- > <ReportResponse> insert_report(report)
1317
-
1318
- Create a report
1319
-
1320
- Create a new report on the UltraCart account.
1321
-
1322
-
1323
- ### Examples
1324
-
1325
- ```ruby
1326
- # Internal API. No samples are provided as merchants will never need this api method
1327
- ```
1328
-
1329
-
1330
- #### Using the insert_report_with_http_info variant
1331
-
1332
- This returns an Array which contains the response data, status code and headers.
1333
-
1334
- > <Array(<ReportResponse>, Integer, Hash)> insert_report_with_http_info(report)
1335
-
1336
- ```ruby
1337
- begin
1338
- # Create a report
1339
- data, status_code, headers = api_instance.insert_report_with_http_info(report)
1340
- p status_code # => 2xx
1341
- p headers # => { ... }
1342
- p data # => <ReportResponse>
1343
- rescue UltracartClient::ApiError => e
1344
- puts "Error when calling DatawarehouseApi->insert_report_with_http_info: #{e}"
1345
- end
1346
- ```
1347
-
1348
- ### Parameters
1349
-
1350
- | Name | Type | Description | Notes |
1351
- | ---- | ---- | ----------- | ----- |
1352
- | **report** | [**Report**](Report.md) | Report to create | |
1353
-
1354
- ### Return type
1355
-
1356
- [**ReportResponse**](ReportResponse.md)
1357
-
1358
- ### Authorization
1359
-
1360
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1361
-
1362
- ### HTTP request headers
1363
-
1364
- - **Content-Type**: application/json; charset=UTF-8
1365
- - **Accept**: application/json
1366
-
1367
-
1368
- ## update_custom_dashboard
1369
-
1370
- > <CustomDashboardResponse> update_custom_dashboard(custom_dashboard_oid, dashboard)
1371
-
1372
- Update a custom dashboard
1373
-
1374
- Update a custom dashboard on the UltraCart account.
1375
-
1376
-
1377
- ### Examples
1378
-
1379
-
1380
- (No example for this operation).
1381
-
1382
-
1383
- #### Using the update_custom_dashboard_with_http_info variant
1384
-
1385
- This returns an Array which contains the response data, status code and headers.
1386
-
1387
- > <Array(<CustomDashboardResponse>, Integer, Hash)> update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard)
1388
-
1389
- ```ruby
1390
- begin
1391
- # Update a custom dashboard
1392
- data, status_code, headers = api_instance.update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard)
1393
- p status_code # => 2xx
1394
- p headers # => { ... }
1395
- p data # => <CustomDashboardResponse>
1396
- rescue UltracartClient::ApiError => e
1397
- puts "Error when calling DatawarehouseApi->update_custom_dashboard_with_http_info: #{e}"
1398
- end
1399
- ```
1400
-
1401
- ### Parameters
1402
-
1403
- | Name | Type | Description | Notes |
1404
- | ---- | ---- | ----------- | ----- |
1405
- | **custom_dashboard_oid** | **Integer** | The dashboard oid to custom update. | |
1406
- | **dashboard** | [**CustomDashboard**](CustomDashboard.md) | Dashboard to custom update | |
1407
-
1408
- ### Return type
1409
-
1410
- [**CustomDashboardResponse**](CustomDashboardResponse.md)
1411
-
1412
- ### Authorization
1413
-
1414
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1415
-
1416
- ### HTTP request headers
1417
-
1418
- - **Content-Type**: application/json; charset=UTF-8
1419
- - **Accept**: application/json
1420
-
1421
-
1422
- ## update_custom_dashboard_schedule
1423
-
1424
- > <CustomDashboardResponse> update_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
1425
-
1426
- Update a custom dashboard schedule
1427
-
1428
- Update a custom dashboard schedule on the UltraCart account.
1429
-
1430
-
1431
- ### Examples
1432
-
1433
-
1434
- (No example for this operation).
1435
-
1436
-
1437
- #### Using the update_custom_dashboard_schedule_with_http_info variant
1438
-
1439
- This returns an Array which contains the response data, status code and headers.
1440
-
1441
- > <Array(<CustomDashboardResponse>, Integer, Hash)> update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
1442
-
1443
- ```ruby
1444
- begin
1445
- # Update a custom dashboard schedule
1446
- data, status_code, headers = api_instance.update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
1447
- p status_code # => 2xx
1448
- p headers # => { ... }
1449
- p data # => <CustomDashboardResponse>
1450
- rescue UltracartClient::ApiError => e
1451
- puts "Error when calling DatawarehouseApi->update_custom_dashboard_schedule_with_http_info: #{e}"
1452
- end
1453
- ```
1454
-
1455
- ### Parameters
1456
-
1457
- | Name | Type | Description | Notes |
1458
- | ---- | ---- | ----------- | ----- |
1459
- | **custom_dashboard_schedule_oid** | **Integer** | The dashboard schedule oid to update. | |
1460
- | **custom_dashboard_oid** | **Integer** | The dashboard oid to update. | |
1461
- | **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md) | Dashboard schedule to update | |
1462
-
1463
- ### Return type
1464
-
1465
- [**CustomDashboardResponse**](CustomDashboardResponse.md)
1466
-
1467
- ### Authorization
1468
-
1469
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1470
-
1471
- ### HTTP request headers
1472
-
1473
- - **Content-Type**: application/json; charset=UTF-8
1474
- - **Accept**: application/json
1475
-
1476
-
1477
- ## update_custom_report
1478
-
1479
- > <CustomReportResponse> update_custom_report(custom_report_oid, report)
1480
-
1481
- Update a custom report
1482
-
1483
- Update a custom report on the UltraCart account.
1484
-
1485
-
1486
- ### Examples
1487
-
1488
-
1489
- (No example for this operation).
1490
-
1491
-
1492
- #### Using the update_custom_report_with_http_info variant
1493
-
1494
- This returns an Array which contains the response data, status code and headers.
1495
-
1496
- > <Array(<CustomReportResponse>, Integer, Hash)> update_custom_report_with_http_info(custom_report_oid, report)
1497
-
1498
- ```ruby
1499
- begin
1500
- # Update a custom report
1501
- data, status_code, headers = api_instance.update_custom_report_with_http_info(custom_report_oid, report)
1502
- p status_code # => 2xx
1503
- p headers # => { ... }
1504
- p data # => <CustomReportResponse>
1505
- rescue UltracartClient::ApiError => e
1506
- puts "Error when calling DatawarehouseApi->update_custom_report_with_http_info: #{e}"
1507
- end
1508
- ```
1509
-
1510
- ### Parameters
1511
-
1512
- | Name | Type | Description | Notes |
1513
- | ---- | ---- | ----------- | ----- |
1514
- | **custom_report_oid** | **Integer** | The report oid to custom update. | |
1515
- | **report** | [**CustomReport**](CustomReport.md) | Report to custom update | |
1516
-
1517
- ### Return type
1518
-
1519
- [**CustomReportResponse**](CustomReportResponse.md)
1520
-
1521
- ### Authorization
1522
-
1523
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1524
-
1525
- ### HTTP request headers
1526
-
1527
- - **Content-Type**: application/json; charset=UTF-8
1528
- - **Accept**: application/json
1529
-
1530
-
1531
- ## update_custom_report_account_config
1532
-
1533
- > <CustomReportAccountConfigResponse> update_custom_report_account_config(account_config)
1534
-
1535
- Update custom report account config
1536
-
1537
- Update custom report account config.
1538
-
1539
-
1540
- ### Examples
1541
-
1542
-
1543
- (No example for this operation).
1544
-
1545
-
1546
- #### Using the update_custom_report_account_config_with_http_info variant
1547
-
1548
- This returns an Array which contains the response data, status code and headers.
1549
-
1550
- > <Array(<CustomReportAccountConfigResponse>, Integer, Hash)> update_custom_report_account_config_with_http_info(account_config)
1551
-
1552
- ```ruby
1553
- begin
1554
- # Update custom report account config
1555
- data, status_code, headers = api_instance.update_custom_report_account_config_with_http_info(account_config)
1556
- p status_code # => 2xx
1557
- p headers # => { ... }
1558
- p data # => <CustomReportAccountConfigResponse>
1559
- rescue UltracartClient::ApiError => e
1560
- puts "Error when calling DatawarehouseApi->update_custom_report_account_config_with_http_info: #{e}"
1561
- end
1562
- ```
1563
-
1564
- ### Parameters
1565
-
1566
- | Name | Type | Description | Notes |
1567
- | ---- | ---- | ----------- | ----- |
1568
- | **account_config** | [**CustomReportAccountConfig**](CustomReportAccountConfig.md) | Account config to update | |
1569
-
1570
- ### Return type
1571
-
1572
- [**CustomReportAccountConfigResponse**](CustomReportAccountConfigResponse.md)
1573
-
1574
- ### Authorization
1575
-
1576
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1577
-
1578
- ### HTTP request headers
1579
-
1580
- - **Content-Type**: application/json; charset=UTF-8
1581
- - **Accept**: application/json
1582
-
1583
-
1584
- ## update_report
1585
-
1586
- > <ReportResponse> update_report(report_oid, report)
1587
-
1588
- Update a report
1589
-
1590
- Update a report on the UltraCart account.
1591
-
1592
-
1593
- ### Examples
1594
-
1595
- ```ruby
1596
- # Internal API. No samples are provided as merchants will never need this api method
1597
- ```
1598
-
1599
-
1600
- #### Using the update_report_with_http_info variant
1601
-
1602
- This returns an Array which contains the response data, status code and headers.
1603
-
1604
- > <Array(<ReportResponse>, Integer, Hash)> update_report_with_http_info(report_oid, report)
1605
-
1606
- ```ruby
1607
- begin
1608
- # Update a report
1609
- data, status_code, headers = api_instance.update_report_with_http_info(report_oid, report)
1610
- p status_code # => 2xx
1611
- p headers # => { ... }
1612
- p data # => <ReportResponse>
1613
- rescue UltracartClient::ApiError => e
1614
- puts "Error when calling DatawarehouseApi->update_report_with_http_info: #{e}"
1615
- end
1616
- ```
1617
-
1618
- ### Parameters
1619
-
1620
- | Name | Type | Description | Notes |
1621
- | ---- | ---- | ----------- | ----- |
1622
- | **report_oid** | **Integer** | The report oid to update. | |
1623
- | **report** | [**Report**](Report.md) | Report to update | |
1624
-
1625
- ### Return type
1626
-
1627
- [**ReportResponse**](ReportResponse.md)
1628
-
1629
- ### Authorization
1630
-
1631
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1632
-
1633
- ### HTTP request headers
1634
-
1635
- - **Content-Type**: application/json; charset=UTF-8
1636
- - **Accept**: application/json
1637
-
1
+ # UltracartClient::DatawarehouseApi
2
+
3
+ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**analyze_custom_report**](DatawarehouseApi.md#analyze_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/analysis | Analyze a custom report |
8
+ | [**delete_custom_dashboard**](DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard |
9
+ | [**delete_custom_dashboard_schedule**](DatawarehouseApi.md#delete_custom_dashboard_schedule) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Delete a custom dashboard schedule |
10
+ | [**delete_custom_report**](DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report |
11
+ | [**delete_report**](DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report |
12
+ | [**dry_run_report_queries**](DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries |
13
+ | [**execute_custom_report**](DatawarehouseApi.md#execute_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report |
14
+ | [**execute_custom_reports**](DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports |
15
+ | [**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries |
16
+ | [**get_custom_dashboard**](DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard |
17
+ | [**get_custom_dashboard_schedules**](DatawarehouseApi.md#get_custom_dashboard_schedules) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Get custom dashboards |
18
+ | [**get_custom_dashboards**](DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards |
19
+ | [**get_custom_report**](DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report |
20
+ | [**get_custom_report_account_config**](DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration |
21
+ | [**get_custom_report_chart_png_upload_url**](DatawarehouseApi.md#get_custom_report_chart_png_upload_url) | **GET** /datawarehouse/custom_reports/{custom_report_oid}/chart_png | Upload a PNG of a custom report chart |
22
+ | [**get_custom_reports**](DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports |
23
+ | [**get_report**](DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report |
24
+ | [**get_report_data_set**](DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set |
25
+ | [**get_report_data_set_page**](DatawarehouseApi.md#get_report_data_set_page) | **GET** /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} | Get a report data set page |
26
+ | [**get_report_websocket_authorization**](DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization |
27
+ | [**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available |
28
+ | [**insert_custom_dashboard**](DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard |
29
+ | [**insert_custom_dashboard_schedule**](DatawarehouseApi.md#insert_custom_dashboard_schedule) | **POST** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Create a custom dashboard schedule |
30
+ | [**insert_custom_report**](DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report |
31
+ | [**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report |
32
+ | [**update_custom_dashboard**](DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard |
33
+ | [**update_custom_dashboard_schedule**](DatawarehouseApi.md#update_custom_dashboard_schedule) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Update a custom dashboard schedule |
34
+ | [**update_custom_report**](DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report |
35
+ | [**update_custom_report_account_config**](DatawarehouseApi.md#update_custom_report_account_config) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config |
36
+ | [**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report |
37
+
38
+
39
+ ## analyze_custom_report
40
+
41
+ > <CustomReportAnalysisResponse> analyze_custom_report(custom_report_oid, analyze_request)
42
+
43
+ Analyze a custom report
44
+
45
+ Analyze a custom report on the UltraCart account.
46
+
47
+
48
+ ### Examples
49
+
50
+
51
+ (No example for this operation).
52
+
53
+
54
+ #### Using the analyze_custom_report_with_http_info variant
55
+
56
+ This returns an Array which contains the response data, status code and headers.
57
+
58
+ > <Array(<CustomReportAnalysisResponse>, Integer, Hash)> analyze_custom_report_with_http_info(custom_report_oid, analyze_request)
59
+
60
+ ```ruby
61
+ begin
62
+ # Analyze a custom report
63
+ data, status_code, headers = api_instance.analyze_custom_report_with_http_info(custom_report_oid, analyze_request)
64
+ p status_code # => 2xx
65
+ p headers # => { ... }
66
+ p data # => <CustomReportAnalysisResponse>
67
+ rescue UltracartClient::ApiError => e
68
+ puts "Error when calling DatawarehouseApi->analyze_custom_report_with_http_info: #{e}"
69
+ end
70
+ ```
71
+
72
+ ### Parameters
73
+
74
+ | Name | Type | Description | Notes |
75
+ | ---- | ---- | ----------- | ----- |
76
+ | **custom_report_oid** | **Integer** | The report oid to analyze. | |
77
+ | **analyze_request** | [**CustomReportAnalysisRequest**](CustomReportAnalysisRequest.md) | Request to analyze custom report | |
78
+
79
+ ### Return type
80
+
81
+ [**CustomReportAnalysisResponse**](CustomReportAnalysisResponse.md)
82
+
83
+ ### Authorization
84
+
85
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
86
+
87
+ ### HTTP request headers
88
+
89
+ - **Content-Type**: application/json; charset=UTF-8
90
+ - **Accept**: application/json
91
+
92
+
93
+ ## delete_custom_dashboard
94
+
95
+ > delete_custom_dashboard(custom_dashboard_oid)
96
+
97
+ Delete a custom dashboard
98
+
99
+ Delete a custom dashboard on the UltraCart account.
100
+
101
+
102
+ ### Examples
103
+
104
+
105
+ (No example for this operation).
106
+
107
+
108
+ #### Using the delete_custom_dashboard_with_http_info variant
109
+
110
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
111
+
112
+ > <Array(nil, Integer, Hash)> delete_custom_dashboard_with_http_info(custom_dashboard_oid)
113
+
114
+ ```ruby
115
+ begin
116
+ # Delete a custom dashboard
117
+ data, status_code, headers = api_instance.delete_custom_dashboard_with_http_info(custom_dashboard_oid)
118
+ p status_code # => 2xx
119
+ p headers # => { ... }
120
+ p data # => nil
121
+ rescue UltracartClient::ApiError => e
122
+ puts "Error when calling DatawarehouseApi->delete_custom_dashboard_with_http_info: #{e}"
123
+ end
124
+ ```
125
+
126
+ ### Parameters
127
+
128
+ | Name | Type | Description | Notes |
129
+ | ---- | ---- | ----------- | ----- |
130
+ | **custom_dashboard_oid** | **Integer** | The dashboard oid to delete. | |
131
+
132
+ ### Return type
133
+
134
+ nil (empty response body)
135
+
136
+ ### Authorization
137
+
138
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
139
+
140
+ ### HTTP request headers
141
+
142
+ - **Content-Type**: Not defined
143
+ - **Accept**: application/json
144
+
145
+
146
+ ## delete_custom_dashboard_schedule
147
+
148
+ > delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid)
149
+
150
+ Delete a custom dashboard schedule
151
+
152
+ delete a custom dashboard schedule on the UltraCart account.
153
+
154
+
155
+ ### Examples
156
+
157
+
158
+ (No example for this operation).
159
+
160
+
161
+ #### Using the delete_custom_dashboard_schedule_with_http_info variant
162
+
163
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
164
+
165
+ > <Array(nil, Integer, Hash)> delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid)
166
+
167
+ ```ruby
168
+ begin
169
+ # Delete a custom dashboard schedule
170
+ data, status_code, headers = api_instance.delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid)
171
+ p status_code # => 2xx
172
+ p headers # => { ... }
173
+ p data # => nil
174
+ rescue UltracartClient::ApiError => e
175
+ puts "Error when calling DatawarehouseApi->delete_custom_dashboard_schedule_with_http_info: #{e}"
176
+ end
177
+ ```
178
+
179
+ ### Parameters
180
+
181
+ | Name | Type | Description | Notes |
182
+ | ---- | ---- | ----------- | ----- |
183
+ | **custom_dashboard_schedule_oid** | **Integer** | The dashboard schedule oid to delete. | |
184
+ | **custom_dashboard_oid** | **Integer** | The dashboard oid that owns the schedule. | |
185
+
186
+ ### Return type
187
+
188
+ nil (empty response body)
189
+
190
+ ### Authorization
191
+
192
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
193
+
194
+ ### HTTP request headers
195
+
196
+ - **Content-Type**: Not defined
197
+ - **Accept**: application/json
198
+
199
+
200
+ ## delete_custom_report
201
+
202
+ > delete_custom_report(custom_report_oid)
203
+
204
+ Delete a custom report
205
+
206
+ Delete a custom report on the UltraCart account.
207
+
208
+
209
+ ### Examples
210
+
211
+
212
+ (No example for this operation).
213
+
214
+
215
+ #### Using the delete_custom_report_with_http_info variant
216
+
217
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
218
+
219
+ > <Array(nil, Integer, Hash)> delete_custom_report_with_http_info(custom_report_oid)
220
+
221
+ ```ruby
222
+ begin
223
+ # Delete a custom report
224
+ data, status_code, headers = api_instance.delete_custom_report_with_http_info(custom_report_oid)
225
+ p status_code # => 2xx
226
+ p headers # => { ... }
227
+ p data # => nil
228
+ rescue UltracartClient::ApiError => e
229
+ puts "Error when calling DatawarehouseApi->delete_custom_report_with_http_info: #{e}"
230
+ end
231
+ ```
232
+
233
+ ### Parameters
234
+
235
+ | Name | Type | Description | Notes |
236
+ | ---- | ---- | ----------- | ----- |
237
+ | **custom_report_oid** | **Integer** | The report oid to delete. | |
238
+
239
+ ### Return type
240
+
241
+ nil (empty response body)
242
+
243
+ ### Authorization
244
+
245
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
246
+
247
+ ### HTTP request headers
248
+
249
+ - **Content-Type**: Not defined
250
+ - **Accept**: application/json
251
+
252
+
253
+ ## delete_report
254
+
255
+ > delete_report(report_oid)
256
+
257
+ Delete a report
258
+
259
+ Delete a report on the UltraCart account.
260
+
261
+
262
+ ### Examples
263
+
264
+ ```ruby
265
+ # Internal API. No samples are provided as merchants will never need this api method
266
+ ```
267
+
268
+
269
+ #### Using the delete_report_with_http_info variant
270
+
271
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
272
+
273
+ > <Array(nil, Integer, Hash)> delete_report_with_http_info(report_oid)
274
+
275
+ ```ruby
276
+ begin
277
+ # Delete a report
278
+ data, status_code, headers = api_instance.delete_report_with_http_info(report_oid)
279
+ p status_code # => 2xx
280
+ p headers # => { ... }
281
+ p data # => nil
282
+ rescue UltracartClient::ApiError => e
283
+ puts "Error when calling DatawarehouseApi->delete_report_with_http_info: #{e}"
284
+ end
285
+ ```
286
+
287
+ ### Parameters
288
+
289
+ | Name | Type | Description | Notes |
290
+ | ---- | ---- | ----------- | ----- |
291
+ | **report_oid** | **Integer** | The report oid to delete. | |
292
+
293
+ ### Return type
294
+
295
+ nil (empty response body)
296
+
297
+ ### Authorization
298
+
299
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
300
+
301
+ ### HTTP request headers
302
+
303
+ - **Content-Type**: Not defined
304
+ - **Accept**: application/json
305
+
306
+
307
+ ## dry_run_report_queries
308
+
309
+ > <ReportDryRunQueriesResponse> dry_run_report_queries(query_request)
310
+
311
+ Dry run the report queries
312
+
313
+ Dry run the report queries
314
+
315
+
316
+ ### Examples
317
+
318
+ ```ruby
319
+ # Internal API. No samples are provided as merchants will never need this api method
320
+ ```
321
+
322
+
323
+ #### Using the dry_run_report_queries_with_http_info variant
324
+
325
+ This returns an Array which contains the response data, status code and headers.
326
+
327
+ > <Array(<ReportDryRunQueriesResponse>, Integer, Hash)> dry_run_report_queries_with_http_info(query_request)
328
+
329
+ ```ruby
330
+ begin
331
+ # Dry run the report queries
332
+ data, status_code, headers = api_instance.dry_run_report_queries_with_http_info(query_request)
333
+ p status_code # => 2xx
334
+ p headers # => { ... }
335
+ p data # => <ReportDryRunQueriesResponse>
336
+ rescue UltracartClient::ApiError => e
337
+ puts "Error when calling DatawarehouseApi->dry_run_report_queries_with_http_info: #{e}"
338
+ end
339
+ ```
340
+
341
+ ### Parameters
342
+
343
+ | Name | Type | Description | Notes |
344
+ | ---- | ---- | ----------- | ----- |
345
+ | **query_request** | [**ReportDryRunQueriesRequest**](ReportDryRunQueriesRequest.md) | Dry run request | |
346
+
347
+ ### Return type
348
+
349
+ [**ReportDryRunQueriesResponse**](ReportDryRunQueriesResponse.md)
350
+
351
+ ### Authorization
352
+
353
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
354
+
355
+ ### HTTP request headers
356
+
357
+ - **Content-Type**: application/json
358
+ - **Accept**: application/json
359
+
360
+
361
+ ## execute_custom_report
362
+
363
+ > <CustomReportExecutionResponse> execute_custom_report(custom_report_oid, execution_request)
364
+
365
+ Execute a custom report
366
+
367
+ Execute a custom report on the UltraCart account.
368
+
369
+
370
+ ### Examples
371
+
372
+
373
+ (No example for this operation).
374
+
375
+
376
+ #### Using the execute_custom_report_with_http_info variant
377
+
378
+ This returns an Array which contains the response data, status code and headers.
379
+
380
+ > <Array(<CustomReportExecutionResponse>, Integer, Hash)> execute_custom_report_with_http_info(custom_report_oid, execution_request)
381
+
382
+ ```ruby
383
+ begin
384
+ # Execute a custom report
385
+ data, status_code, headers = api_instance.execute_custom_report_with_http_info(custom_report_oid, execution_request)
386
+ p status_code # => 2xx
387
+ p headers # => { ... }
388
+ p data # => <CustomReportExecutionResponse>
389
+ rescue UltracartClient::ApiError => e
390
+ puts "Error when calling DatawarehouseApi->execute_custom_report_with_http_info: #{e}"
391
+ end
392
+ ```
393
+
394
+ ### Parameters
395
+
396
+ | Name | Type | Description | Notes |
397
+ | ---- | ---- | ----------- | ----- |
398
+ | **custom_report_oid** | **Integer** | The report oid to execute. | |
399
+ | **execution_request** | [**CustomReportExecutionRequest**](CustomReportExecutionRequest.md) | Request to execute custom report | |
400
+
401
+ ### Return type
402
+
403
+ [**CustomReportExecutionResponse**](CustomReportExecutionResponse.md)
404
+
405
+ ### Authorization
406
+
407
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
408
+
409
+ ### HTTP request headers
410
+
411
+ - **Content-Type**: application/json; charset=UTF-8
412
+ - **Accept**: application/json
413
+
414
+
415
+ ## execute_custom_reports
416
+
417
+ > <CustomReportsExecutionResponse> execute_custom_reports(execution_request)
418
+
419
+ Execute a custom reports
420
+
421
+ Execute a custom reports on the UltraCart account.
422
+
423
+
424
+ ### Examples
425
+
426
+
427
+ (No example for this operation).
428
+
429
+
430
+ #### Using the execute_custom_reports_with_http_info variant
431
+
432
+ This returns an Array which contains the response data, status code and headers.
433
+
434
+ > <Array(<CustomReportsExecutionResponse>, Integer, Hash)> execute_custom_reports_with_http_info(execution_request)
435
+
436
+ ```ruby
437
+ begin
438
+ # Execute a custom reports
439
+ data, status_code, headers = api_instance.execute_custom_reports_with_http_info(execution_request)
440
+ p status_code # => 2xx
441
+ p headers # => { ... }
442
+ p data # => <CustomReportsExecutionResponse>
443
+ rescue UltracartClient::ApiError => e
444
+ puts "Error when calling DatawarehouseApi->execute_custom_reports_with_http_info: #{e}"
445
+ end
446
+ ```
447
+
448
+ ### Parameters
449
+
450
+ | Name | Type | Description | Notes |
451
+ | ---- | ---- | ----------- | ----- |
452
+ | **execution_request** | [**CustomReportsExecutionRequest**](CustomReportsExecutionRequest.md) | Request to execute custom reports | |
453
+
454
+ ### Return type
455
+
456
+ [**CustomReportsExecutionResponse**](CustomReportsExecutionResponse.md)
457
+
458
+ ### Authorization
459
+
460
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
461
+
462
+ ### HTTP request headers
463
+
464
+ - **Content-Type**: application/json; charset=UTF-8
465
+ - **Accept**: application/json
466
+
467
+
468
+ ## execute_report_queries
469
+
470
+ > execute_report_queries(query_request)
471
+
472
+ Execute the report queries
473
+
474
+ Execute the report queries
475
+
476
+
477
+ ### Examples
478
+
479
+ ```ruby
480
+ # Internal API. No samples are provided as merchants will never need this api method
481
+ ```
482
+
483
+
484
+ #### Using the execute_report_queries_with_http_info variant
485
+
486
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
487
+
488
+ > <Array(nil, Integer, Hash)> execute_report_queries_with_http_info(query_request)
489
+
490
+ ```ruby
491
+ begin
492
+ # Execute the report queries
493
+ data, status_code, headers = api_instance.execute_report_queries_with_http_info(query_request)
494
+ p status_code # => 2xx
495
+ p headers # => { ... }
496
+ p data # => nil
497
+ rescue UltracartClient::ApiError => e
498
+ puts "Error when calling DatawarehouseApi->execute_report_queries_with_http_info: #{e}"
499
+ end
500
+ ```
501
+
502
+ ### Parameters
503
+
504
+ | Name | Type | Description | Notes |
505
+ | ---- | ---- | ----------- | ----- |
506
+ | **query_request** | [**ReportExecuteQueriesRequest**](ReportExecuteQueriesRequest.md) | Query request | |
507
+
508
+ ### Return type
509
+
510
+ nil (empty response body)
511
+
512
+ ### Authorization
513
+
514
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
515
+
516
+ ### HTTP request headers
517
+
518
+ - **Content-Type**: application/json
519
+ - **Accept**: application/json
520
+
521
+
522
+ ## get_custom_dashboard
523
+
524
+ > <CustomDashboardResponse> get_custom_dashboard(custom_dashboard_oid)
525
+
526
+ Get a custom dashboard
527
+
528
+ Retrieve a custom dashboard
529
+
530
+
531
+ ### Examples
532
+
533
+
534
+ (No example for this operation).
535
+
536
+
537
+ #### Using the get_custom_dashboard_with_http_info variant
538
+
539
+ This returns an Array which contains the response data, status code and headers.
540
+
541
+ > <Array(<CustomDashboardResponse>, Integer, Hash)> get_custom_dashboard_with_http_info(custom_dashboard_oid)
542
+
543
+ ```ruby
544
+ begin
545
+ # Get a custom dashboard
546
+ data, status_code, headers = api_instance.get_custom_dashboard_with_http_info(custom_dashboard_oid)
547
+ p status_code # => 2xx
548
+ p headers # => { ... }
549
+ p data # => <CustomDashboardResponse>
550
+ rescue UltracartClient::ApiError => e
551
+ puts "Error when calling DatawarehouseApi->get_custom_dashboard_with_http_info: #{e}"
552
+ end
553
+ ```
554
+
555
+ ### Parameters
556
+
557
+ | Name | Type | Description | Notes |
558
+ | ---- | ---- | ----------- | ----- |
559
+ | **custom_dashboard_oid** | **Integer** | | |
560
+
561
+ ### Return type
562
+
563
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
564
+
565
+ ### Authorization
566
+
567
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
568
+
569
+ ### HTTP request headers
570
+
571
+ - **Content-Type**: Not defined
572
+ - **Accept**: application/json
573
+
574
+
575
+ ## get_custom_dashboard_schedules
576
+
577
+ > <CustomDashboardSchedulesResponse> get_custom_dashboard_schedules(custom_dashboard_oid)
578
+
579
+ Get custom dashboards
580
+
581
+ Retrieve a custom dashboards
582
+
583
+
584
+ ### Examples
585
+
586
+
587
+ (No example for this operation).
588
+
589
+
590
+ #### Using the get_custom_dashboard_schedules_with_http_info variant
591
+
592
+ This returns an Array which contains the response data, status code and headers.
593
+
594
+ > <Array(<CustomDashboardSchedulesResponse>, Integer, Hash)> get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid)
595
+
596
+ ```ruby
597
+ begin
598
+ # Get custom dashboards
599
+ data, status_code, headers = api_instance.get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid)
600
+ p status_code # => 2xx
601
+ p headers # => { ... }
602
+ p data # => <CustomDashboardSchedulesResponse>
603
+ rescue UltracartClient::ApiError => e
604
+ puts "Error when calling DatawarehouseApi->get_custom_dashboard_schedules_with_http_info: #{e}"
605
+ end
606
+ ```
607
+
608
+ ### Parameters
609
+
610
+ | Name | Type | Description | Notes |
611
+ | ---- | ---- | ----------- | ----- |
612
+ | **custom_dashboard_oid** | **Integer** | | |
613
+
614
+ ### Return type
615
+
616
+ [**CustomDashboardSchedulesResponse**](CustomDashboardSchedulesResponse.md)
617
+
618
+ ### Authorization
619
+
620
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
621
+
622
+ ### HTTP request headers
623
+
624
+ - **Content-Type**: Not defined
625
+ - **Accept**: application/json
626
+
627
+
628
+ ## get_custom_dashboards
629
+
630
+ > <CustomDashboardsResponse> get_custom_dashboards
631
+
632
+ Get custom dashboards
633
+
634
+ Retrieve a custom dashboards
635
+
636
+
637
+ ### Examples
638
+
639
+
640
+ (No example for this operation).
641
+
642
+
643
+ #### Using the get_custom_dashboards_with_http_info variant
644
+
645
+ This returns an Array which contains the response data, status code and headers.
646
+
647
+ > <Array(<CustomDashboardsResponse>, Integer, Hash)> get_custom_dashboards_with_http_info
648
+
649
+ ```ruby
650
+ begin
651
+ # Get custom dashboards
652
+ data, status_code, headers = api_instance.get_custom_dashboards_with_http_info
653
+ p status_code # => 2xx
654
+ p headers # => { ... }
655
+ p data # => <CustomDashboardsResponse>
656
+ rescue UltracartClient::ApiError => e
657
+ puts "Error when calling DatawarehouseApi->get_custom_dashboards_with_http_info: #{e}"
658
+ end
659
+ ```
660
+
661
+ ### Parameters
662
+
663
+ This endpoint does not need any parameter.
664
+
665
+ ### Return type
666
+
667
+ [**CustomDashboardsResponse**](CustomDashboardsResponse.md)
668
+
669
+ ### Authorization
670
+
671
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
672
+
673
+ ### HTTP request headers
674
+
675
+ - **Content-Type**: Not defined
676
+ - **Accept**: application/json
677
+
678
+
679
+ ## get_custom_report
680
+
681
+ > <CustomReportResponse> get_custom_report(custom_report_oid)
682
+
683
+ Get a custom report
684
+
685
+ Retrieve a custom report
686
+
687
+
688
+ ### Examples
689
+
690
+
691
+ (No example for this operation).
692
+
693
+
694
+ #### Using the get_custom_report_with_http_info variant
695
+
696
+ This returns an Array which contains the response data, status code and headers.
697
+
698
+ > <Array(<CustomReportResponse>, Integer, Hash)> get_custom_report_with_http_info(custom_report_oid)
699
+
700
+ ```ruby
701
+ begin
702
+ # Get a custom report
703
+ data, status_code, headers = api_instance.get_custom_report_with_http_info(custom_report_oid)
704
+ p status_code # => 2xx
705
+ p headers # => { ... }
706
+ p data # => <CustomReportResponse>
707
+ rescue UltracartClient::ApiError => e
708
+ puts "Error when calling DatawarehouseApi->get_custom_report_with_http_info: #{e}"
709
+ end
710
+ ```
711
+
712
+ ### Parameters
713
+
714
+ | Name | Type | Description | Notes |
715
+ | ---- | ---- | ----------- | ----- |
716
+ | **custom_report_oid** | **Integer** | | |
717
+
718
+ ### Return type
719
+
720
+ [**CustomReportResponse**](CustomReportResponse.md)
721
+
722
+ ### Authorization
723
+
724
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
725
+
726
+ ### HTTP request headers
727
+
728
+ - **Content-Type**: Not defined
729
+ - **Accept**: application/json
730
+
731
+
732
+ ## get_custom_report_account_config
733
+
734
+ > <CustomReportAccountConfigResponse> get_custom_report_account_config
735
+
736
+ Get custom report account configuration
737
+
738
+ Retrieve a custom report account configuration
739
+
740
+
741
+ ### Examples
742
+
743
+
744
+ (No example for this operation).
745
+
746
+
747
+ #### Using the get_custom_report_account_config_with_http_info variant
748
+
749
+ This returns an Array which contains the response data, status code and headers.
750
+
751
+ > <Array(<CustomReportAccountConfigResponse>, Integer, Hash)> get_custom_report_account_config_with_http_info
752
+
753
+ ```ruby
754
+ begin
755
+ # Get custom report account configuration
756
+ data, status_code, headers = api_instance.get_custom_report_account_config_with_http_info
757
+ p status_code # => 2xx
758
+ p headers # => { ... }
759
+ p data # => <CustomReportAccountConfigResponse>
760
+ rescue UltracartClient::ApiError => e
761
+ puts "Error when calling DatawarehouseApi->get_custom_report_account_config_with_http_info: #{e}"
762
+ end
763
+ ```
764
+
765
+ ### Parameters
766
+
767
+ This endpoint does not need any parameter.
768
+
769
+ ### Return type
770
+
771
+ [**CustomReportAccountConfigResponse**](CustomReportAccountConfigResponse.md)
772
+
773
+ ### Authorization
774
+
775
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
776
+
777
+ ### HTTP request headers
778
+
779
+ - **Content-Type**: Not defined
780
+ - **Accept**: application/json
781
+
782
+
783
+ ## get_custom_report_chart_png_upload_url
784
+
785
+ > <CustomReportChartPngUploadResponse> get_custom_report_chart_png_upload_url(custom_report_oid)
786
+
787
+ Upload a PNG of a custom report chart
788
+
789
+ Upload a PNG of a custom report chart
790
+
791
+
792
+ ### Examples
793
+
794
+
795
+ (No example for this operation).
796
+
797
+
798
+ #### Using the get_custom_report_chart_png_upload_url_with_http_info variant
799
+
800
+ This returns an Array which contains the response data, status code and headers.
801
+
802
+ > <Array(<CustomReportChartPngUploadResponse>, Integer, Hash)> get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid)
803
+
804
+ ```ruby
805
+ begin
806
+ # Upload a PNG of a custom report chart
807
+ data, status_code, headers = api_instance.get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid)
808
+ p status_code # => 2xx
809
+ p headers # => { ... }
810
+ p data # => <CustomReportChartPngUploadResponse>
811
+ rescue UltracartClient::ApiError => e
812
+ puts "Error when calling DatawarehouseApi->get_custom_report_chart_png_upload_url_with_http_info: #{e}"
813
+ end
814
+ ```
815
+
816
+ ### Parameters
817
+
818
+ | Name | Type | Description | Notes |
819
+ | ---- | ---- | ----------- | ----- |
820
+ | **custom_report_oid** | **Integer** | The report oid to upload a chart PNG for. | |
821
+
822
+ ### Return type
823
+
824
+ [**CustomReportChartPngUploadResponse**](CustomReportChartPngUploadResponse.md)
825
+
826
+ ### Authorization
827
+
828
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
829
+
830
+ ### HTTP request headers
831
+
832
+ - **Content-Type**: Not defined
833
+ - **Accept**: application/json
834
+
835
+
836
+ ## get_custom_reports
837
+
838
+ > <CustomReportsResponse> get_custom_reports
839
+
840
+ Get custom reports
841
+
842
+ Retrieve a custom reports
843
+
844
+
845
+ ### Examples
846
+
847
+
848
+ (No example for this operation).
849
+
850
+
851
+ #### Using the get_custom_reports_with_http_info variant
852
+
853
+ This returns an Array which contains the response data, status code and headers.
854
+
855
+ > <Array(<CustomReportsResponse>, Integer, Hash)> get_custom_reports_with_http_info
856
+
857
+ ```ruby
858
+ begin
859
+ # Get custom reports
860
+ data, status_code, headers = api_instance.get_custom_reports_with_http_info
861
+ p status_code # => 2xx
862
+ p headers # => { ... }
863
+ p data # => <CustomReportsResponse>
864
+ rescue UltracartClient::ApiError => e
865
+ puts "Error when calling DatawarehouseApi->get_custom_reports_with_http_info: #{e}"
866
+ end
867
+ ```
868
+
869
+ ### Parameters
870
+
871
+ This endpoint does not need any parameter.
872
+
873
+ ### Return type
874
+
875
+ [**CustomReportsResponse**](CustomReportsResponse.md)
876
+
877
+ ### Authorization
878
+
879
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
880
+
881
+ ### HTTP request headers
882
+
883
+ - **Content-Type**: Not defined
884
+ - **Accept**: application/json
885
+
886
+
887
+ ## get_report
888
+
889
+ > <ReportResponse> get_report(report_oid)
890
+
891
+ Get a report
892
+
893
+ Retrieve a report
894
+
895
+
896
+ ### Examples
897
+
898
+ ```ruby
899
+ # Internal API. No samples are provided as merchants will never need this api method
900
+ ```
901
+
902
+
903
+ #### Using the get_report_with_http_info variant
904
+
905
+ This returns an Array which contains the response data, status code and headers.
906
+
907
+ > <Array(<ReportResponse>, Integer, Hash)> get_report_with_http_info(report_oid)
908
+
909
+ ```ruby
910
+ begin
911
+ # Get a report
912
+ data, status_code, headers = api_instance.get_report_with_http_info(report_oid)
913
+ p status_code # => 2xx
914
+ p headers # => { ... }
915
+ p data # => <ReportResponse>
916
+ rescue UltracartClient::ApiError => e
917
+ puts "Error when calling DatawarehouseApi->get_report_with_http_info: #{e}"
918
+ end
919
+ ```
920
+
921
+ ### Parameters
922
+
923
+ | Name | Type | Description | Notes |
924
+ | ---- | ---- | ----------- | ----- |
925
+ | **report_oid** | **Integer** | | |
926
+
927
+ ### Return type
928
+
929
+ [**ReportResponse**](ReportResponse.md)
930
+
931
+ ### Authorization
932
+
933
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
934
+
935
+ ### HTTP request headers
936
+
937
+ - **Content-Type**: Not defined
938
+ - **Accept**: application/json
939
+
940
+
941
+ ## get_report_data_set
942
+
943
+ > <ReportDataSetResponse> get_report_data_set(dataset_uuid)
944
+
945
+ Get a report data set
946
+
947
+ Retrieve a report data set
948
+
949
+
950
+ ### Examples
951
+
952
+ ```ruby
953
+ # Internal API. No samples are provided as merchants will never need this api method
954
+ ```
955
+
956
+
957
+ #### Using the get_report_data_set_with_http_info variant
958
+
959
+ This returns an Array which contains the response data, status code and headers.
960
+
961
+ > <Array(<ReportDataSetResponse>, Integer, Hash)> get_report_data_set_with_http_info(dataset_uuid)
962
+
963
+ ```ruby
964
+ begin
965
+ # Get a report data set
966
+ data, status_code, headers = api_instance.get_report_data_set_with_http_info(dataset_uuid)
967
+ p status_code # => 2xx
968
+ p headers # => { ... }
969
+ p data # => <ReportDataSetResponse>
970
+ rescue UltracartClient::ApiError => e
971
+ puts "Error when calling DatawarehouseApi->get_report_data_set_with_http_info: #{e}"
972
+ end
973
+ ```
974
+
975
+ ### Parameters
976
+
977
+ | Name | Type | Description | Notes |
978
+ | ---- | ---- | ----------- | ----- |
979
+ | **dataset_uuid** | **String** | | |
980
+
981
+ ### Return type
982
+
983
+ [**ReportDataSetResponse**](ReportDataSetResponse.md)
984
+
985
+ ### Authorization
986
+
987
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
988
+
989
+ ### HTTP request headers
990
+
991
+ - **Content-Type**: Not defined
992
+ - **Accept**: application/json
993
+
994
+
995
+ ## get_report_data_set_page
996
+
997
+ > <ReportDataSetPageResponse> get_report_data_set_page(dataset_uuid, page_number)
998
+
999
+ Get a report data set page
1000
+
1001
+ Retrieve a report data set page
1002
+
1003
+
1004
+ ### Examples
1005
+
1006
+ ```ruby
1007
+ # Internal API. No samples are provided as merchants will never need this api method
1008
+ ```
1009
+
1010
+
1011
+ #### Using the get_report_data_set_page_with_http_info variant
1012
+
1013
+ This returns an Array which contains the response data, status code and headers.
1014
+
1015
+ > <Array(<ReportDataSetPageResponse>, Integer, Hash)> get_report_data_set_page_with_http_info(dataset_uuid, page_number)
1016
+
1017
+ ```ruby
1018
+ begin
1019
+ # Get a report data set page
1020
+ data, status_code, headers = api_instance.get_report_data_set_page_with_http_info(dataset_uuid, page_number)
1021
+ p status_code # => 2xx
1022
+ p headers # => { ... }
1023
+ p data # => <ReportDataSetPageResponse>
1024
+ rescue UltracartClient::ApiError => e
1025
+ puts "Error when calling DatawarehouseApi->get_report_data_set_page_with_http_info: #{e}"
1026
+ end
1027
+ ```
1028
+
1029
+ ### Parameters
1030
+
1031
+ | Name | Type | Description | Notes |
1032
+ | ---- | ---- | ----------- | ----- |
1033
+ | **dataset_uuid** | **String** | | |
1034
+ | **page_number** | **Integer** | | |
1035
+
1036
+ ### Return type
1037
+
1038
+ [**ReportDataSetPageResponse**](ReportDataSetPageResponse.md)
1039
+
1040
+ ### Authorization
1041
+
1042
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1043
+
1044
+ ### HTTP request headers
1045
+
1046
+ - **Content-Type**: Not defined
1047
+ - **Accept**: application/json
1048
+
1049
+
1050
+ ## get_report_websocket_authorization
1051
+
1052
+ > <ReportAuthResponse> get_report_websocket_authorization
1053
+
1054
+ Get report websocket authorization
1055
+
1056
+ Retrieve a JWT to authorize a report to make a websocket connection.
1057
+
1058
+
1059
+ ### Examples
1060
+
1061
+ ```ruby
1062
+ # Internal API. No samples are provided as merchants will never need this api method
1063
+ ```
1064
+
1065
+
1066
+ #### Using the get_report_websocket_authorization_with_http_info variant
1067
+
1068
+ This returns an Array which contains the response data, status code and headers.
1069
+
1070
+ > <Array(<ReportAuthResponse>, Integer, Hash)> get_report_websocket_authorization_with_http_info
1071
+
1072
+ ```ruby
1073
+ begin
1074
+ # Get report websocket authorization
1075
+ data, status_code, headers = api_instance.get_report_websocket_authorization_with_http_info
1076
+ p status_code # => 2xx
1077
+ p headers # => { ... }
1078
+ p data # => <ReportAuthResponse>
1079
+ rescue UltracartClient::ApiError => e
1080
+ puts "Error when calling DatawarehouseApi->get_report_websocket_authorization_with_http_info: #{e}"
1081
+ end
1082
+ ```
1083
+
1084
+ ### Parameters
1085
+
1086
+ This endpoint does not need any parameter.
1087
+
1088
+ ### Return type
1089
+
1090
+ [**ReportAuthResponse**](ReportAuthResponse.md)
1091
+
1092
+ ### Authorization
1093
+
1094
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1095
+
1096
+ ### HTTP request headers
1097
+
1098
+ - **Content-Type**: Not defined
1099
+ - **Accept**: application/json
1100
+
1101
+
1102
+ ## get_reports
1103
+
1104
+ > <ReportsResponse> get_reports
1105
+
1106
+ Get list of reports available
1107
+
1108
+ Retrieve a list of reports available
1109
+
1110
+
1111
+ ### Examples
1112
+
1113
+ ```ruby
1114
+ # Internal API. No samples are provided as merchants will never need this api method
1115
+ ```
1116
+
1117
+
1118
+ #### Using the get_reports_with_http_info variant
1119
+
1120
+ This returns an Array which contains the response data, status code and headers.
1121
+
1122
+ > <Array(<ReportsResponse>, Integer, Hash)> get_reports_with_http_info
1123
+
1124
+ ```ruby
1125
+ begin
1126
+ # Get list of reports available
1127
+ data, status_code, headers = api_instance.get_reports_with_http_info
1128
+ p status_code # => 2xx
1129
+ p headers # => { ... }
1130
+ p data # => <ReportsResponse>
1131
+ rescue UltracartClient::ApiError => e
1132
+ puts "Error when calling DatawarehouseApi->get_reports_with_http_info: #{e}"
1133
+ end
1134
+ ```
1135
+
1136
+ ### Parameters
1137
+
1138
+ This endpoint does not need any parameter.
1139
+
1140
+ ### Return type
1141
+
1142
+ [**ReportsResponse**](ReportsResponse.md)
1143
+
1144
+ ### Authorization
1145
+
1146
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1147
+
1148
+ ### HTTP request headers
1149
+
1150
+ - **Content-Type**: Not defined
1151
+ - **Accept**: application/json
1152
+
1153
+
1154
+ ## insert_custom_dashboard
1155
+
1156
+ > <CustomDashboardResponse> insert_custom_dashboard(dashboard)
1157
+
1158
+ Create a custom dashboard
1159
+
1160
+ Create a new custom dashboard on the UltraCart account.
1161
+
1162
+
1163
+ ### Examples
1164
+
1165
+
1166
+ (No example for this operation).
1167
+
1168
+
1169
+ #### Using the insert_custom_dashboard_with_http_info variant
1170
+
1171
+ This returns an Array which contains the response data, status code and headers.
1172
+
1173
+ > <Array(<CustomDashboardResponse>, Integer, Hash)> insert_custom_dashboard_with_http_info(dashboard)
1174
+
1175
+ ```ruby
1176
+ begin
1177
+ # Create a custom dashboard
1178
+ data, status_code, headers = api_instance.insert_custom_dashboard_with_http_info(dashboard)
1179
+ p status_code # => 2xx
1180
+ p headers # => { ... }
1181
+ p data # => <CustomDashboardResponse>
1182
+ rescue UltracartClient::ApiError => e
1183
+ puts "Error when calling DatawarehouseApi->insert_custom_dashboard_with_http_info: #{e}"
1184
+ end
1185
+ ```
1186
+
1187
+ ### Parameters
1188
+
1189
+ | Name | Type | Description | Notes |
1190
+ | ---- | ---- | ----------- | ----- |
1191
+ | **dashboard** | [**CustomDashboard**](CustomDashboard.md) | Dashboard to create | |
1192
+
1193
+ ### Return type
1194
+
1195
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
1196
+
1197
+ ### Authorization
1198
+
1199
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1200
+
1201
+ ### HTTP request headers
1202
+
1203
+ - **Content-Type**: application/json; charset=UTF-8
1204
+ - **Accept**: application/json
1205
+
1206
+
1207
+ ## insert_custom_dashboard_schedule
1208
+
1209
+ > <CustomDashboardScheduleResponse> insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule)
1210
+
1211
+ Create a custom dashboard schedule
1212
+
1213
+ Create a new custom dashboard schedule on the UltraCart account.
1214
+
1215
+
1216
+ ### Examples
1217
+
1218
+
1219
+ (No example for this operation).
1220
+
1221
+
1222
+ #### Using the insert_custom_dashboard_schedule_with_http_info variant
1223
+
1224
+ This returns an Array which contains the response data, status code and headers.
1225
+
1226
+ > <Array(<CustomDashboardScheduleResponse>, Integer, Hash)> insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule)
1227
+
1228
+ ```ruby
1229
+ begin
1230
+ # Create a custom dashboard schedule
1231
+ data, status_code, headers = api_instance.insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule)
1232
+ p status_code # => 2xx
1233
+ p headers # => { ... }
1234
+ p data # => <CustomDashboardScheduleResponse>
1235
+ rescue UltracartClient::ApiError => e
1236
+ puts "Error when calling DatawarehouseApi->insert_custom_dashboard_schedule_with_http_info: #{e}"
1237
+ end
1238
+ ```
1239
+
1240
+ ### Parameters
1241
+
1242
+ | Name | Type | Description | Notes |
1243
+ | ---- | ---- | ----------- | ----- |
1244
+ | **custom_dashboard_oid** | **Integer** | | |
1245
+ | **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md) | Dashboard schedule to create | |
1246
+
1247
+ ### Return type
1248
+
1249
+ [**CustomDashboardScheduleResponse**](CustomDashboardScheduleResponse.md)
1250
+
1251
+ ### Authorization
1252
+
1253
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1254
+
1255
+ ### HTTP request headers
1256
+
1257
+ - **Content-Type**: application/json; charset=UTF-8
1258
+ - **Accept**: application/json
1259
+
1260
+
1261
+ ## insert_custom_report
1262
+
1263
+ > <CustomReportResponse> insert_custom_report(report)
1264
+
1265
+ Create a custom report
1266
+
1267
+ Create a new custom report on the UltraCart account.
1268
+
1269
+
1270
+ ### Examples
1271
+
1272
+
1273
+ (No example for this operation).
1274
+
1275
+
1276
+ #### Using the insert_custom_report_with_http_info variant
1277
+
1278
+ This returns an Array which contains the response data, status code and headers.
1279
+
1280
+ > <Array(<CustomReportResponse>, Integer, Hash)> insert_custom_report_with_http_info(report)
1281
+
1282
+ ```ruby
1283
+ begin
1284
+ # Create a custom report
1285
+ data, status_code, headers = api_instance.insert_custom_report_with_http_info(report)
1286
+ p status_code # => 2xx
1287
+ p headers # => { ... }
1288
+ p data # => <CustomReportResponse>
1289
+ rescue UltracartClient::ApiError => e
1290
+ puts "Error when calling DatawarehouseApi->insert_custom_report_with_http_info: #{e}"
1291
+ end
1292
+ ```
1293
+
1294
+ ### Parameters
1295
+
1296
+ | Name | Type | Description | Notes |
1297
+ | ---- | ---- | ----------- | ----- |
1298
+ | **report** | [**CustomReport**](CustomReport.md) | Report to create | |
1299
+
1300
+ ### Return type
1301
+
1302
+ [**CustomReportResponse**](CustomReportResponse.md)
1303
+
1304
+ ### Authorization
1305
+
1306
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1307
+
1308
+ ### HTTP request headers
1309
+
1310
+ - **Content-Type**: application/json; charset=UTF-8
1311
+ - **Accept**: application/json
1312
+
1313
+
1314
+ ## insert_report
1315
+
1316
+ > <ReportResponse> insert_report(report)
1317
+
1318
+ Create a report
1319
+
1320
+ Create a new report on the UltraCart account.
1321
+
1322
+
1323
+ ### Examples
1324
+
1325
+ ```ruby
1326
+ # Internal API. No samples are provided as merchants will never need this api method
1327
+ ```
1328
+
1329
+
1330
+ #### Using the insert_report_with_http_info variant
1331
+
1332
+ This returns an Array which contains the response data, status code and headers.
1333
+
1334
+ > <Array(<ReportResponse>, Integer, Hash)> insert_report_with_http_info(report)
1335
+
1336
+ ```ruby
1337
+ begin
1338
+ # Create a report
1339
+ data, status_code, headers = api_instance.insert_report_with_http_info(report)
1340
+ p status_code # => 2xx
1341
+ p headers # => { ... }
1342
+ p data # => <ReportResponse>
1343
+ rescue UltracartClient::ApiError => e
1344
+ puts "Error when calling DatawarehouseApi->insert_report_with_http_info: #{e}"
1345
+ end
1346
+ ```
1347
+
1348
+ ### Parameters
1349
+
1350
+ | Name | Type | Description | Notes |
1351
+ | ---- | ---- | ----------- | ----- |
1352
+ | **report** | [**Report**](Report.md) | Report to create | |
1353
+
1354
+ ### Return type
1355
+
1356
+ [**ReportResponse**](ReportResponse.md)
1357
+
1358
+ ### Authorization
1359
+
1360
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1361
+
1362
+ ### HTTP request headers
1363
+
1364
+ - **Content-Type**: application/json; charset=UTF-8
1365
+ - **Accept**: application/json
1366
+
1367
+
1368
+ ## update_custom_dashboard
1369
+
1370
+ > <CustomDashboardResponse> update_custom_dashboard(custom_dashboard_oid, dashboard)
1371
+
1372
+ Update a custom dashboard
1373
+
1374
+ Update a custom dashboard on the UltraCart account.
1375
+
1376
+
1377
+ ### Examples
1378
+
1379
+
1380
+ (No example for this operation).
1381
+
1382
+
1383
+ #### Using the update_custom_dashboard_with_http_info variant
1384
+
1385
+ This returns an Array which contains the response data, status code and headers.
1386
+
1387
+ > <Array(<CustomDashboardResponse>, Integer, Hash)> update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard)
1388
+
1389
+ ```ruby
1390
+ begin
1391
+ # Update a custom dashboard
1392
+ data, status_code, headers = api_instance.update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard)
1393
+ p status_code # => 2xx
1394
+ p headers # => { ... }
1395
+ p data # => <CustomDashboardResponse>
1396
+ rescue UltracartClient::ApiError => e
1397
+ puts "Error when calling DatawarehouseApi->update_custom_dashboard_with_http_info: #{e}"
1398
+ end
1399
+ ```
1400
+
1401
+ ### Parameters
1402
+
1403
+ | Name | Type | Description | Notes |
1404
+ | ---- | ---- | ----------- | ----- |
1405
+ | **custom_dashboard_oid** | **Integer** | The dashboard oid to custom update. | |
1406
+ | **dashboard** | [**CustomDashboard**](CustomDashboard.md) | Dashboard to custom update | |
1407
+
1408
+ ### Return type
1409
+
1410
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
1411
+
1412
+ ### Authorization
1413
+
1414
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1415
+
1416
+ ### HTTP request headers
1417
+
1418
+ - **Content-Type**: application/json; charset=UTF-8
1419
+ - **Accept**: application/json
1420
+
1421
+
1422
+ ## update_custom_dashboard_schedule
1423
+
1424
+ > <CustomDashboardResponse> update_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
1425
+
1426
+ Update a custom dashboard schedule
1427
+
1428
+ Update a custom dashboard schedule on the UltraCart account.
1429
+
1430
+
1431
+ ### Examples
1432
+
1433
+
1434
+ (No example for this operation).
1435
+
1436
+
1437
+ #### Using the update_custom_dashboard_schedule_with_http_info variant
1438
+
1439
+ This returns an Array which contains the response data, status code and headers.
1440
+
1441
+ > <Array(<CustomDashboardResponse>, Integer, Hash)> update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
1442
+
1443
+ ```ruby
1444
+ begin
1445
+ # Update a custom dashboard schedule
1446
+ data, status_code, headers = api_instance.update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
1447
+ p status_code # => 2xx
1448
+ p headers # => { ... }
1449
+ p data # => <CustomDashboardResponse>
1450
+ rescue UltracartClient::ApiError => e
1451
+ puts "Error when calling DatawarehouseApi->update_custom_dashboard_schedule_with_http_info: #{e}"
1452
+ end
1453
+ ```
1454
+
1455
+ ### Parameters
1456
+
1457
+ | Name | Type | Description | Notes |
1458
+ | ---- | ---- | ----------- | ----- |
1459
+ | **custom_dashboard_schedule_oid** | **Integer** | The dashboard schedule oid to update. | |
1460
+ | **custom_dashboard_oid** | **Integer** | The dashboard oid to update. | |
1461
+ | **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md) | Dashboard schedule to update | |
1462
+
1463
+ ### Return type
1464
+
1465
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
1466
+
1467
+ ### Authorization
1468
+
1469
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1470
+
1471
+ ### HTTP request headers
1472
+
1473
+ - **Content-Type**: application/json; charset=UTF-8
1474
+ - **Accept**: application/json
1475
+
1476
+
1477
+ ## update_custom_report
1478
+
1479
+ > <CustomReportResponse> update_custom_report(custom_report_oid, report)
1480
+
1481
+ Update a custom report
1482
+
1483
+ Update a custom report on the UltraCart account.
1484
+
1485
+
1486
+ ### Examples
1487
+
1488
+
1489
+ (No example for this operation).
1490
+
1491
+
1492
+ #### Using the update_custom_report_with_http_info variant
1493
+
1494
+ This returns an Array which contains the response data, status code and headers.
1495
+
1496
+ > <Array(<CustomReportResponse>, Integer, Hash)> update_custom_report_with_http_info(custom_report_oid, report)
1497
+
1498
+ ```ruby
1499
+ begin
1500
+ # Update a custom report
1501
+ data, status_code, headers = api_instance.update_custom_report_with_http_info(custom_report_oid, report)
1502
+ p status_code # => 2xx
1503
+ p headers # => { ... }
1504
+ p data # => <CustomReportResponse>
1505
+ rescue UltracartClient::ApiError => e
1506
+ puts "Error when calling DatawarehouseApi->update_custom_report_with_http_info: #{e}"
1507
+ end
1508
+ ```
1509
+
1510
+ ### Parameters
1511
+
1512
+ | Name | Type | Description | Notes |
1513
+ | ---- | ---- | ----------- | ----- |
1514
+ | **custom_report_oid** | **Integer** | The report oid to custom update. | |
1515
+ | **report** | [**CustomReport**](CustomReport.md) | Report to custom update | |
1516
+
1517
+ ### Return type
1518
+
1519
+ [**CustomReportResponse**](CustomReportResponse.md)
1520
+
1521
+ ### Authorization
1522
+
1523
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1524
+
1525
+ ### HTTP request headers
1526
+
1527
+ - **Content-Type**: application/json; charset=UTF-8
1528
+ - **Accept**: application/json
1529
+
1530
+
1531
+ ## update_custom_report_account_config
1532
+
1533
+ > <CustomReportAccountConfigResponse> update_custom_report_account_config(account_config)
1534
+
1535
+ Update custom report account config
1536
+
1537
+ Update custom report account config.
1538
+
1539
+
1540
+ ### Examples
1541
+
1542
+
1543
+ (No example for this operation).
1544
+
1545
+
1546
+ #### Using the update_custom_report_account_config_with_http_info variant
1547
+
1548
+ This returns an Array which contains the response data, status code and headers.
1549
+
1550
+ > <Array(<CustomReportAccountConfigResponse>, Integer, Hash)> update_custom_report_account_config_with_http_info(account_config)
1551
+
1552
+ ```ruby
1553
+ begin
1554
+ # Update custom report account config
1555
+ data, status_code, headers = api_instance.update_custom_report_account_config_with_http_info(account_config)
1556
+ p status_code # => 2xx
1557
+ p headers # => { ... }
1558
+ p data # => <CustomReportAccountConfigResponse>
1559
+ rescue UltracartClient::ApiError => e
1560
+ puts "Error when calling DatawarehouseApi->update_custom_report_account_config_with_http_info: #{e}"
1561
+ end
1562
+ ```
1563
+
1564
+ ### Parameters
1565
+
1566
+ | Name | Type | Description | Notes |
1567
+ | ---- | ---- | ----------- | ----- |
1568
+ | **account_config** | [**CustomReportAccountConfig**](CustomReportAccountConfig.md) | Account config to update | |
1569
+
1570
+ ### Return type
1571
+
1572
+ [**CustomReportAccountConfigResponse**](CustomReportAccountConfigResponse.md)
1573
+
1574
+ ### Authorization
1575
+
1576
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1577
+
1578
+ ### HTTP request headers
1579
+
1580
+ - **Content-Type**: application/json; charset=UTF-8
1581
+ - **Accept**: application/json
1582
+
1583
+
1584
+ ## update_report
1585
+
1586
+ > <ReportResponse> update_report(report_oid, report)
1587
+
1588
+ Update a report
1589
+
1590
+ Update a report on the UltraCart account.
1591
+
1592
+
1593
+ ### Examples
1594
+
1595
+ ```ruby
1596
+ # Internal API. No samples are provided as merchants will never need this api method
1597
+ ```
1598
+
1599
+
1600
+ #### Using the update_report_with_http_info variant
1601
+
1602
+ This returns an Array which contains the response data, status code and headers.
1603
+
1604
+ > <Array(<ReportResponse>, Integer, Hash)> update_report_with_http_info(report_oid, report)
1605
+
1606
+ ```ruby
1607
+ begin
1608
+ # Update a report
1609
+ data, status_code, headers = api_instance.update_report_with_http_info(report_oid, report)
1610
+ p status_code # => 2xx
1611
+ p headers # => { ... }
1612
+ p data # => <ReportResponse>
1613
+ rescue UltracartClient::ApiError => e
1614
+ puts "Error when calling DatawarehouseApi->update_report_with_http_info: #{e}"
1615
+ end
1616
+ ```
1617
+
1618
+ ### Parameters
1619
+
1620
+ | Name | Type | Description | Notes |
1621
+ | ---- | ---- | ----------- | ----- |
1622
+ | **report_oid** | **Integer** | The report oid to update. | |
1623
+ | **report** | [**Report**](Report.md) | Report to update | |
1624
+
1625
+ ### Return type
1626
+
1627
+ [**ReportResponse**](ReportResponse.md)
1628
+
1629
+ ### Authorization
1630
+
1631
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1632
+
1633
+ ### HTTP request headers
1634
+
1635
+ - **Content-Type**: application/json; charset=UTF-8
1636
+ - **Accept**: application/json
1637
+