ultracart_api 4.1.13 → 4.1.15

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 (54) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +23 -2
  3. data/docs/AffiliateApi.md +123 -167
  4. data/docs/AutoOrderApi.md +1250 -903
  5. data/docs/CartUpsellAfter.md +6 -2
  6. data/docs/ChannelPartnerApi.md +1678 -1121
  7. data/docs/ChargebackApi.md +297 -405
  8. data/docs/CheckoutApi.md +1622 -1424
  9. data/docs/ConversationApi.md +4820 -6315
  10. data/docs/ConversationVirtualAgentCapabilities.md +4 -0
  11. data/docs/CouponApi.md +1522 -1443
  12. data/docs/CustomReport.md +36 -0
  13. data/docs/CustomReportAccountConfig.md +34 -0
  14. data/docs/CustomReportAccountConfigResponse.md +26 -0
  15. data/docs/CustomReportExecutionParameter.md +22 -0
  16. data/docs/CustomReportExecutionRequest.md +18 -0
  17. data/docs/CustomReportParameter.md +28 -0
  18. data/docs/CustomReportParameterOption.md +20 -0
  19. data/docs/CustomReportQuery.md +28 -0
  20. data/docs/CustomReportResponse.md +26 -0
  21. data/docs/CustomReportTooltip.md +20 -0
  22. data/docs/CustomerApi.md +2570 -1845
  23. data/docs/DatawarehouseApi.md +933 -723
  24. data/docs/FulfillmentApi.md +567 -441
  25. data/docs/GiftCertificateApi.md +617 -598
  26. data/docs/IntegrationLogApi.md +290 -385
  27. data/docs/Item.md +1 -1
  28. data/docs/ItemApi.md +2174 -1746
  29. data/docs/OauthApi.md +203 -163
  30. data/docs/OrderApi.md +2883 -2177
  31. data/docs/SsoApi.md +223 -288
  32. data/docs/StorefrontApi.md +9692 -12967
  33. data/docs/TaxApi.md +1541 -2017
  34. data/docs/UserApi.md +606 -790
  35. data/docs/WebhookApi.md +787 -628
  36. data/docs/WorkflowApi.md +666 -879
  37. data/lib/ultracart_api/api/datawarehouse_api.rb +474 -0
  38. data/lib/ultracart_api/api/order_api.rb +131 -0
  39. data/lib/ultracart_api/models/cart_upsell_after.rb +25 -5
  40. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +55 -1
  41. data/lib/ultracart_api/models/custom_report.rb +306 -0
  42. data/lib/ultracart_api/models/custom_report_account_config.rb +296 -0
  43. data/lib/ultracart_api/models/custom_report_account_config_response.rb +256 -0
  44. data/lib/ultracart_api/models/custom_report_execution_parameter.rb +237 -0
  45. data/lib/ultracart_api/models/custom_report_execution_request.rb +221 -0
  46. data/lib/ultracart_api/models/custom_report_parameter.rb +266 -0
  47. data/lib/ultracart_api/models/custom_report_parameter_option.rb +228 -0
  48. data/lib/ultracart_api/models/custom_report_query.rb +266 -0
  49. data/lib/ultracart_api/models/custom_report_response.rb +256 -0
  50. data/lib/ultracart_api/models/custom_report_tooltip.rb +228 -0
  51. data/lib/ultracart_api/models/item.rb +1 -1
  52. data/lib/ultracart_api/version.rb +1 -1
  53. data/lib/ultracart_api.rb +10 -0
  54. metadata +22 -2
@@ -1,723 +1,933 @@
1
- # UltracartClient::DatawarehouseApi
2
-
3
- All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**delete_report**](DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report |
8
- | [**dry_run_report_queries**](DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries |
9
- | [**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries |
10
- | [**get_report**](DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report |
11
- | [**get_report_data_set**](DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set |
12
- | [**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 |
13
- | [**get_report_websocket_authorization**](DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization |
14
- | [**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available |
15
- | [**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report |
16
- | [**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report |
17
-
18
-
19
- ## delete_report
20
-
21
- > delete_report(report_oid)
22
-
23
- Delete a report
24
-
25
- Delete a report on the UltraCart account.
26
-
27
- ### Examples
28
-
29
- ```ruby
30
- require 'time'
31
- require 'ultracart_api'
32
- require 'json'
33
- require 'yaml'
34
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
35
-
36
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
37
- # As such, this might not be the best way to use this object.
38
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
39
-
40
- api = UltracartClient::DatawarehouseApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
41
- report_oid = 56 # Integer | The report oid to delete.
42
-
43
- begin
44
- # Delete a report
45
- api_instance.delete_report(report_oid)
46
- rescue UltracartClient::ApiError => e
47
- puts "Error when calling DatawarehouseApi->delete_report: #{e}"
48
- end
49
- ```
50
-
51
- #### Using the delete_report_with_http_info variant
52
-
53
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
54
-
55
- > <Array(nil, Integer, Hash)> delete_report_with_http_info(report_oid)
56
-
57
- ```ruby
58
- begin
59
- # Delete a report
60
- data, status_code, headers = api_instance.delete_report_with_http_info(report_oid)
61
- p status_code # => 2xx
62
- p headers # => { ... }
63
- p data # => nil
64
- rescue UltracartClient::ApiError => e
65
- puts "Error when calling DatawarehouseApi->delete_report_with_http_info: #{e}"
66
- end
67
- ```
68
-
69
- ### Parameters
70
-
71
- | Name | Type | Description | Notes |
72
- | ---- | ---- | ----------- | ----- |
73
- | **report_oid** | **Integer** | The report oid to delete. | |
74
-
75
- ### Return type
76
-
77
- nil (empty response body)
78
-
79
- ### Authorization
80
-
81
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
82
-
83
- ### HTTP request headers
84
-
85
- - **Content-Type**: Not defined
86
- - **Accept**: application/json
87
-
88
-
89
- ## dry_run_report_queries
90
-
91
- > <ReportDryRunQueriesResponse> dry_run_report_queries(query_request)
92
-
93
- Dry run the report queries
94
-
95
- Dry run the report queries
96
-
97
- ### Examples
98
-
99
- ```ruby
100
- require 'time'
101
- require 'ultracart_api'
102
- require 'json'
103
- require 'yaml'
104
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
105
-
106
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
107
- # As such, this might not be the best way to use this object.
108
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
109
-
110
- api = UltracartClient::DatawarehouseApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
111
- query_request = UltracartClient::ReportDryRunQueriesRequest.new # ReportDryRunQueriesRequest | Dry run request
112
-
113
- begin
114
- # Dry run the report queries
115
- result = api_instance.dry_run_report_queries(query_request)
116
- p result
117
- rescue UltracartClient::ApiError => e
118
- puts "Error when calling DatawarehouseApi->dry_run_report_queries: #{e}"
119
- end
120
- ```
121
-
122
- #### Using the dry_run_report_queries_with_http_info variant
123
-
124
- This returns an Array which contains the response data, status code and headers.
125
-
126
- > <Array(<ReportDryRunQueriesResponse>, Integer, Hash)> dry_run_report_queries_with_http_info(query_request)
127
-
128
- ```ruby
129
- begin
130
- # Dry run the report queries
131
- data, status_code, headers = api_instance.dry_run_report_queries_with_http_info(query_request)
132
- p status_code # => 2xx
133
- p headers # => { ... }
134
- p data # => <ReportDryRunQueriesResponse>
135
- rescue UltracartClient::ApiError => e
136
- puts "Error when calling DatawarehouseApi->dry_run_report_queries_with_http_info: #{e}"
137
- end
138
- ```
139
-
140
- ### Parameters
141
-
142
- | Name | Type | Description | Notes |
143
- | ---- | ---- | ----------- | ----- |
144
- | **query_request** | [**ReportDryRunQueriesRequest**](ReportDryRunQueriesRequest.md) | Dry run request | |
145
-
146
- ### Return type
147
-
148
- [**ReportDryRunQueriesResponse**](ReportDryRunQueriesResponse.md)
149
-
150
- ### Authorization
151
-
152
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
153
-
154
- ### HTTP request headers
155
-
156
- - **Content-Type**: application/json
157
- - **Accept**: application/json
158
-
159
-
160
- ## execute_report_queries
161
-
162
- > execute_report_queries(query_request)
163
-
164
- Execute the report queries
165
-
166
- Execute the report queries
167
-
168
- ### Examples
169
-
170
- ```ruby
171
- require 'time'
172
- require 'ultracart_api'
173
- require 'json'
174
- require 'yaml'
175
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
176
-
177
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
178
- # As such, this might not be the best way to use this object.
179
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
180
-
181
- api = UltracartClient::DatawarehouseApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
182
- query_request = UltracartClient::ReportExecuteQueriesRequest.new # ReportExecuteQueriesRequest | Query request
183
-
184
- begin
185
- # Execute the report queries
186
- api_instance.execute_report_queries(query_request)
187
- rescue UltracartClient::ApiError => e
188
- puts "Error when calling DatawarehouseApi->execute_report_queries: #{e}"
189
- end
190
- ```
191
-
192
- #### Using the execute_report_queries_with_http_info variant
193
-
194
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
195
-
196
- > <Array(nil, Integer, Hash)> execute_report_queries_with_http_info(query_request)
197
-
198
- ```ruby
199
- begin
200
- # Execute the report queries
201
- data, status_code, headers = api_instance.execute_report_queries_with_http_info(query_request)
202
- p status_code # => 2xx
203
- p headers # => { ... }
204
- p data # => nil
205
- rescue UltracartClient::ApiError => e
206
- puts "Error when calling DatawarehouseApi->execute_report_queries_with_http_info: #{e}"
207
- end
208
- ```
209
-
210
- ### Parameters
211
-
212
- | Name | Type | Description | Notes |
213
- | ---- | ---- | ----------- | ----- |
214
- | **query_request** | [**ReportExecuteQueriesRequest**](ReportExecuteQueriesRequest.md) | Query request | |
215
-
216
- ### Return type
217
-
218
- nil (empty response body)
219
-
220
- ### Authorization
221
-
222
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
223
-
224
- ### HTTP request headers
225
-
226
- - **Content-Type**: application/json
227
- - **Accept**: application/json
228
-
229
-
230
- ## get_report
231
-
232
- > <ReportResponse> get_report(report_oid)
233
-
234
- Get a report
235
-
236
- Retrieve a report
237
-
238
- ### Examples
239
-
240
- ```ruby
241
- require 'time'
242
- require 'ultracart_api'
243
- require 'json'
244
- require 'yaml'
245
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
246
-
247
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
248
- # As such, this might not be the best way to use this object.
249
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
250
-
251
- api = UltracartClient::DatawarehouseApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
252
- report_oid = 56 # Integer |
253
-
254
- begin
255
- # Get a report
256
- result = api_instance.get_report(report_oid)
257
- p result
258
- rescue UltracartClient::ApiError => e
259
- puts "Error when calling DatawarehouseApi->get_report: #{e}"
260
- end
261
- ```
262
-
263
- #### Using the get_report_with_http_info variant
264
-
265
- This returns an Array which contains the response data, status code and headers.
266
-
267
- > <Array(<ReportResponse>, Integer, Hash)> get_report_with_http_info(report_oid)
268
-
269
- ```ruby
270
- begin
271
- # Get a report
272
- data, status_code, headers = api_instance.get_report_with_http_info(report_oid)
273
- p status_code # => 2xx
274
- p headers # => { ... }
275
- p data # => <ReportResponse>
276
- rescue UltracartClient::ApiError => e
277
- puts "Error when calling DatawarehouseApi->get_report_with_http_info: #{e}"
278
- end
279
- ```
280
-
281
- ### Parameters
282
-
283
- | Name | Type | Description | Notes |
284
- | ---- | ---- | ----------- | ----- |
285
- | **report_oid** | **Integer** | | |
286
-
287
- ### Return type
288
-
289
- [**ReportResponse**](ReportResponse.md)
290
-
291
- ### Authorization
292
-
293
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
294
-
295
- ### HTTP request headers
296
-
297
- - **Content-Type**: Not defined
298
- - **Accept**: application/json
299
-
300
-
301
- ## get_report_data_set
302
-
303
- > <ReportDataSetResponse> get_report_data_set(dataset_uuid)
304
-
305
- Get a report data set
306
-
307
- Retrieve a report data set
308
-
309
- ### Examples
310
-
311
- ```ruby
312
- require 'time'
313
- require 'ultracart_api'
314
- require 'json'
315
- require 'yaml'
316
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
317
-
318
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
319
- # As such, this might not be the best way to use this object.
320
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
321
-
322
- api = UltracartClient::DatawarehouseApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
323
- dataset_uuid = 'dataset_uuid_example' # String |
324
-
325
- begin
326
- # Get a report data set
327
- result = api_instance.get_report_data_set(dataset_uuid)
328
- p result
329
- rescue UltracartClient::ApiError => e
330
- puts "Error when calling DatawarehouseApi->get_report_data_set: #{e}"
331
- end
332
- ```
333
-
334
- #### Using the get_report_data_set_with_http_info variant
335
-
336
- This returns an Array which contains the response data, status code and headers.
337
-
338
- > <Array(<ReportDataSetResponse>, Integer, Hash)> get_report_data_set_with_http_info(dataset_uuid)
339
-
340
- ```ruby
341
- begin
342
- # Get a report data set
343
- data, status_code, headers = api_instance.get_report_data_set_with_http_info(dataset_uuid)
344
- p status_code # => 2xx
345
- p headers # => { ... }
346
- p data # => <ReportDataSetResponse>
347
- rescue UltracartClient::ApiError => e
348
- puts "Error when calling DatawarehouseApi->get_report_data_set_with_http_info: #{e}"
349
- end
350
- ```
351
-
352
- ### Parameters
353
-
354
- | Name | Type | Description | Notes |
355
- | ---- | ---- | ----------- | ----- |
356
- | **dataset_uuid** | **String** | | |
357
-
358
- ### Return type
359
-
360
- [**ReportDataSetResponse**](ReportDataSetResponse.md)
361
-
362
- ### Authorization
363
-
364
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
365
-
366
- ### HTTP request headers
367
-
368
- - **Content-Type**: Not defined
369
- - **Accept**: application/json
370
-
371
-
372
- ## get_report_data_set_page
373
-
374
- > <ReportDataSetPageResponse> get_report_data_set_page(dataset_uuid, page_number)
375
-
376
- Get a report data set page
377
-
378
- Retrieve a report data set page
379
-
380
- ### Examples
381
-
382
- ```ruby
383
- require 'time'
384
- require 'ultracart_api'
385
- require 'json'
386
- require 'yaml'
387
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
388
-
389
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
390
- # As such, this might not be the best way to use this object.
391
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
392
-
393
- api = UltracartClient::DatawarehouseApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
394
- dataset_uuid = 'dataset_uuid_example' # String |
395
- page_number = 56 # Integer |
396
-
397
- begin
398
- # Get a report data set page
399
- result = api_instance.get_report_data_set_page(dataset_uuid, page_number)
400
- p result
401
- rescue UltracartClient::ApiError => e
402
- puts "Error when calling DatawarehouseApi->get_report_data_set_page: #{e}"
403
- end
404
- ```
405
-
406
- #### Using the get_report_data_set_page_with_http_info variant
407
-
408
- This returns an Array which contains the response data, status code and headers.
409
-
410
- > <Array(<ReportDataSetPageResponse>, Integer, Hash)> get_report_data_set_page_with_http_info(dataset_uuid, page_number)
411
-
412
- ```ruby
413
- begin
414
- # Get a report data set page
415
- data, status_code, headers = api_instance.get_report_data_set_page_with_http_info(dataset_uuid, page_number)
416
- p status_code # => 2xx
417
- p headers # => { ... }
418
- p data # => <ReportDataSetPageResponse>
419
- rescue UltracartClient::ApiError => e
420
- puts "Error when calling DatawarehouseApi->get_report_data_set_page_with_http_info: #{e}"
421
- end
422
- ```
423
-
424
- ### Parameters
425
-
426
- | Name | Type | Description | Notes |
427
- | ---- | ---- | ----------- | ----- |
428
- | **dataset_uuid** | **String** | | |
429
- | **page_number** | **Integer** | | |
430
-
431
- ### Return type
432
-
433
- [**ReportDataSetPageResponse**](ReportDataSetPageResponse.md)
434
-
435
- ### Authorization
436
-
437
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
438
-
439
- ### HTTP request headers
440
-
441
- - **Content-Type**: Not defined
442
- - **Accept**: application/json
443
-
444
-
445
- ## get_report_websocket_authorization
446
-
447
- > <ReportAuthResponse> get_report_websocket_authorization
448
-
449
- Get report websocket authorization
450
-
451
- Retrieve a JWT to authorize a report to make a websocket connection.
452
-
453
- ### Examples
454
-
455
- ```ruby
456
- require 'time'
457
- require 'ultracart_api'
458
- require 'json'
459
- require 'yaml'
460
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
461
-
462
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
463
- # As such, this might not be the best way to use this object.
464
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
465
-
466
- api = UltracartClient::DatawarehouseApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
467
-
468
- begin
469
- # Get report websocket authorization
470
- result = api_instance.get_report_websocket_authorization
471
- p result
472
- rescue UltracartClient::ApiError => e
473
- puts "Error when calling DatawarehouseApi->get_report_websocket_authorization: #{e}"
474
- end
475
- ```
476
-
477
- #### Using the get_report_websocket_authorization_with_http_info variant
478
-
479
- This returns an Array which contains the response data, status code and headers.
480
-
481
- > <Array(<ReportAuthResponse>, Integer, Hash)> get_report_websocket_authorization_with_http_info
482
-
483
- ```ruby
484
- begin
485
- # Get report websocket authorization
486
- data, status_code, headers = api_instance.get_report_websocket_authorization_with_http_info
487
- p status_code # => 2xx
488
- p headers # => { ... }
489
- p data # => <ReportAuthResponse>
490
- rescue UltracartClient::ApiError => e
491
- puts "Error when calling DatawarehouseApi->get_report_websocket_authorization_with_http_info: #{e}"
492
- end
493
- ```
494
-
495
- ### Parameters
496
-
497
- This endpoint does not need any parameter.
498
-
499
- ### Return type
500
-
501
- [**ReportAuthResponse**](ReportAuthResponse.md)
502
-
503
- ### Authorization
504
-
505
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
506
-
507
- ### HTTP request headers
508
-
509
- - **Content-Type**: Not defined
510
- - **Accept**: application/json
511
-
512
-
513
- ## get_reports
514
-
515
- > <ReportsResponse> get_reports
516
-
517
- Get list of reports available
518
-
519
- Retrieve a list of reports available
520
-
521
- ### Examples
522
-
523
- ```ruby
524
- require 'time'
525
- require 'ultracart_api'
526
- require 'json'
527
- require 'yaml'
528
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
529
-
530
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
531
- # As such, this might not be the best way to use this object.
532
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
533
-
534
- api = UltracartClient::DatawarehouseApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
535
-
536
- begin
537
- # Get list of reports available
538
- result = api_instance.get_reports
539
- p result
540
- rescue UltracartClient::ApiError => e
541
- puts "Error when calling DatawarehouseApi->get_reports: #{e}"
542
- end
543
- ```
544
-
545
- #### Using the get_reports_with_http_info variant
546
-
547
- This returns an Array which contains the response data, status code and headers.
548
-
549
- > <Array(<ReportsResponse>, Integer, Hash)> get_reports_with_http_info
550
-
551
- ```ruby
552
- begin
553
- # Get list of reports available
554
- data, status_code, headers = api_instance.get_reports_with_http_info
555
- p status_code # => 2xx
556
- p headers # => { ... }
557
- p data # => <ReportsResponse>
558
- rescue UltracartClient::ApiError => e
559
- puts "Error when calling DatawarehouseApi->get_reports_with_http_info: #{e}"
560
- end
561
- ```
562
-
563
- ### Parameters
564
-
565
- This endpoint does not need any parameter.
566
-
567
- ### Return type
568
-
569
- [**ReportsResponse**](ReportsResponse.md)
570
-
571
- ### Authorization
572
-
573
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
574
-
575
- ### HTTP request headers
576
-
577
- - **Content-Type**: Not defined
578
- - **Accept**: application/json
579
-
580
-
581
- ## insert_report
582
-
583
- > <ReportResponse> insert_report(report)
584
-
585
- Create a report
586
-
587
- Create a new report on the UltraCart account.
588
-
589
- ### Examples
590
-
591
- ```ruby
592
- require 'time'
593
- require 'ultracart_api'
594
- require 'json'
595
- require 'yaml'
596
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
597
-
598
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
599
- # As such, this might not be the best way to use this object.
600
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
601
-
602
- api = UltracartClient::DatawarehouseApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
603
- report = UltracartClient::Report.new # Report | Report to create
604
-
605
- begin
606
- # Create a report
607
- result = api_instance.insert_report(report)
608
- p result
609
- rescue UltracartClient::ApiError => e
610
- puts "Error when calling DatawarehouseApi->insert_report: #{e}"
611
- end
612
- ```
613
-
614
- #### Using the insert_report_with_http_info variant
615
-
616
- This returns an Array which contains the response data, status code and headers.
617
-
618
- > <Array(<ReportResponse>, Integer, Hash)> insert_report_with_http_info(report)
619
-
620
- ```ruby
621
- begin
622
- # Create a report
623
- data, status_code, headers = api_instance.insert_report_with_http_info(report)
624
- p status_code # => 2xx
625
- p headers # => { ... }
626
- p data # => <ReportResponse>
627
- rescue UltracartClient::ApiError => e
628
- puts "Error when calling DatawarehouseApi->insert_report_with_http_info: #{e}"
629
- end
630
- ```
631
-
632
- ### Parameters
633
-
634
- | Name | Type | Description | Notes |
635
- | ---- | ---- | ----------- | ----- |
636
- | **report** | [**Report**](Report.md) | Report to create | |
637
-
638
- ### Return type
639
-
640
- [**ReportResponse**](ReportResponse.md)
641
-
642
- ### Authorization
643
-
644
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
645
-
646
- ### HTTP request headers
647
-
648
- - **Content-Type**: application/json; charset=UTF-8
649
- - **Accept**: application/json
650
-
651
-
652
- ## update_report
653
-
654
- > <ReportResponse> update_report(report_oid, report)
655
-
656
- Update a report
657
-
658
- Update a report on the UltraCart account.
659
-
660
- ### Examples
661
-
662
- ```ruby
663
- require 'time'
664
- require 'ultracart_api'
665
- require 'json'
666
- require 'yaml'
667
- require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
668
-
669
- # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
670
- # As such, this might not be the best way to use this object.
671
- # Please see https://github.com/UltraCart/sdk_samples for working examples.
672
-
673
- api = UltracartClient::DatawarehouseApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
674
- report_oid = 56 # Integer | The report oid to update.
675
- report = UltracartClient::Report.new # Report | Report to update
676
-
677
- begin
678
- # Update a report
679
- result = api_instance.update_report(report_oid, report)
680
- p result
681
- rescue UltracartClient::ApiError => e
682
- puts "Error when calling DatawarehouseApi->update_report: #{e}"
683
- end
684
- ```
685
-
686
- #### Using the update_report_with_http_info variant
687
-
688
- This returns an Array which contains the response data, status code and headers.
689
-
690
- > <Array(<ReportResponse>, Integer, Hash)> update_report_with_http_info(report_oid, report)
691
-
692
- ```ruby
693
- begin
694
- # Update a report
695
- data, status_code, headers = api_instance.update_report_with_http_info(report_oid, report)
696
- p status_code # => 2xx
697
- p headers # => { ... }
698
- p data # => <ReportResponse>
699
- rescue UltracartClient::ApiError => e
700
- puts "Error when calling DatawarehouseApi->update_report_with_http_info: #{e}"
701
- end
702
- ```
703
-
704
- ### Parameters
705
-
706
- | Name | Type | Description | Notes |
707
- | ---- | ---- | ----------- | ----- |
708
- | **report_oid** | **Integer** | The report oid to update. | |
709
- | **report** | [**Report**](Report.md) | Report to update | |
710
-
711
- ### Return type
712
-
713
- [**ReportResponse**](ReportResponse.md)
714
-
715
- ### Authorization
716
-
717
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
718
-
719
- ### HTTP request headers
720
-
721
- - **Content-Type**: application/json; charset=UTF-8
722
- - **Accept**: application/json
723
-
1
+ # UltracartClient::DatawarehouseApi
2
+
3
+ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**delete_custom_report**](DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report |
8
+ | [**delete_report**](DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report |
9
+ | [**dry_run_report_queries**](DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries |
10
+ | [**execute_custom_report**](DatawarehouseApi.md#execute_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report |
11
+ | [**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries |
12
+ | [**get_custom_report**](DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report |
13
+ | [**get_custom_report_account_config**](DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration |
14
+ | [**get_report**](DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report |
15
+ | [**get_report_data_set**](DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set |
16
+ | [**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 |
17
+ | [**get_report_websocket_authorization**](DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization |
18
+ | [**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available |
19
+ | [**insert_custom_report**](DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report |
20
+ | [**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report |
21
+ | [**update_custom_report**](DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report |
22
+ | [**update_custom_report_account_config**](DatawarehouseApi.md#update_custom_report_account_config) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config |
23
+ | [**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report |
24
+
25
+
26
+ ## delete_custom_report
27
+
28
+ > delete_custom_report(custom_report_oid)
29
+
30
+ Delete a custom report
31
+
32
+ Delete a custom report on the UltraCart account.
33
+
34
+
35
+ ### Examples
36
+
37
+
38
+ (No example for this operation).
39
+
40
+
41
+ #### Using the delete_custom_report_with_http_info variant
42
+
43
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
44
+
45
+ > <Array(nil, Integer, Hash)> delete_custom_report_with_http_info(custom_report_oid)
46
+
47
+ ```ruby
48
+ begin
49
+ # Delete a custom report
50
+ data, status_code, headers = api_instance.delete_custom_report_with_http_info(custom_report_oid)
51
+ p status_code # => 2xx
52
+ p headers # => { ... }
53
+ p data # => nil
54
+ rescue UltracartClient::ApiError => e
55
+ puts "Error when calling DatawarehouseApi->delete_custom_report_with_http_info: #{e}"
56
+ end
57
+ ```
58
+
59
+ ### Parameters
60
+
61
+ | Name | Type | Description | Notes |
62
+ | ---- | ---- | ----------- | ----- |
63
+ | **custom_report_oid** | **Integer** | The report oid to delete. | |
64
+
65
+ ### Return type
66
+
67
+ nil (empty response body)
68
+
69
+ ### Authorization
70
+
71
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
72
+
73
+ ### HTTP request headers
74
+
75
+ - **Content-Type**: Not defined
76
+ - **Accept**: application/json
77
+
78
+
79
+ ## delete_report
80
+
81
+ > delete_report(report_oid)
82
+
83
+ Delete a report
84
+
85
+ Delete a report on the UltraCart account.
86
+
87
+
88
+ ### Examples
89
+
90
+ ```ruby
91
+ # Internal API. No samples are provided as merchants will never need this api method
92
+ ```
93
+
94
+
95
+ #### Using the delete_report_with_http_info variant
96
+
97
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
98
+
99
+ > <Array(nil, Integer, Hash)> delete_report_with_http_info(report_oid)
100
+
101
+ ```ruby
102
+ begin
103
+ # Delete a report
104
+ data, status_code, headers = api_instance.delete_report_with_http_info(report_oid)
105
+ p status_code # => 2xx
106
+ p headers # => { ... }
107
+ p data # => nil
108
+ rescue UltracartClient::ApiError => e
109
+ puts "Error when calling DatawarehouseApi->delete_report_with_http_info: #{e}"
110
+ end
111
+ ```
112
+
113
+ ### Parameters
114
+
115
+ | Name | Type | Description | Notes |
116
+ | ---- | ---- | ----------- | ----- |
117
+ | **report_oid** | **Integer** | The report oid to delete. | |
118
+
119
+ ### Return type
120
+
121
+ nil (empty response body)
122
+
123
+ ### Authorization
124
+
125
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
126
+
127
+ ### HTTP request headers
128
+
129
+ - **Content-Type**: Not defined
130
+ - **Accept**: application/json
131
+
132
+
133
+ ## dry_run_report_queries
134
+
135
+ > <ReportDryRunQueriesResponse> dry_run_report_queries(query_request)
136
+
137
+ Dry run the report queries
138
+
139
+ Dry run the report queries
140
+
141
+
142
+ ### Examples
143
+
144
+ ```ruby
145
+ # Internal API. No samples are provided as merchants will never need this api method
146
+ ```
147
+
148
+
149
+ #### Using the dry_run_report_queries_with_http_info variant
150
+
151
+ This returns an Array which contains the response data, status code and headers.
152
+
153
+ > <Array(<ReportDryRunQueriesResponse>, Integer, Hash)> dry_run_report_queries_with_http_info(query_request)
154
+
155
+ ```ruby
156
+ begin
157
+ # Dry run the report queries
158
+ data, status_code, headers = api_instance.dry_run_report_queries_with_http_info(query_request)
159
+ p status_code # => 2xx
160
+ p headers # => { ... }
161
+ p data # => <ReportDryRunQueriesResponse>
162
+ rescue UltracartClient::ApiError => e
163
+ puts "Error when calling DatawarehouseApi->dry_run_report_queries_with_http_info: #{e}"
164
+ end
165
+ ```
166
+
167
+ ### Parameters
168
+
169
+ | Name | Type | Description | Notes |
170
+ | ---- | ---- | ----------- | ----- |
171
+ | **query_request** | [**ReportDryRunQueriesRequest**](ReportDryRunQueriesRequest.md) | Dry run request | |
172
+
173
+ ### Return type
174
+
175
+ [**ReportDryRunQueriesResponse**](ReportDryRunQueriesResponse.md)
176
+
177
+ ### Authorization
178
+
179
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
180
+
181
+ ### HTTP request headers
182
+
183
+ - **Content-Type**: application/json
184
+ - **Accept**: application/json
185
+
186
+
187
+ ## execute_custom_report
188
+
189
+ > <CustomReportResponse> execute_custom_report(custom_report_oid, execution_request)
190
+
191
+ Execute a custom report
192
+
193
+ Execute a custom report on the UltraCart account.
194
+
195
+
196
+ ### Examples
197
+
198
+
199
+ (No example for this operation).
200
+
201
+
202
+ #### Using the execute_custom_report_with_http_info variant
203
+
204
+ This returns an Array which contains the response data, status code and headers.
205
+
206
+ > <Array(<CustomReportResponse>, Integer, Hash)> execute_custom_report_with_http_info(custom_report_oid, execution_request)
207
+
208
+ ```ruby
209
+ begin
210
+ # Execute a custom report
211
+ data, status_code, headers = api_instance.execute_custom_report_with_http_info(custom_report_oid, execution_request)
212
+ p status_code # => 2xx
213
+ p headers # => { ... }
214
+ p data # => <CustomReportResponse>
215
+ rescue UltracartClient::ApiError => e
216
+ puts "Error when calling DatawarehouseApi->execute_custom_report_with_http_info: #{e}"
217
+ end
218
+ ```
219
+
220
+ ### Parameters
221
+
222
+ | Name | Type | Description | Notes |
223
+ | ---- | ---- | ----------- | ----- |
224
+ | **custom_report_oid** | **Integer** | The report oid to execute. | |
225
+ | **execution_request** | [**CustomReportExecutionRequest**](CustomReportExecutionRequest.md) | Request to execute custom report | |
226
+
227
+ ### Return type
228
+
229
+ [**CustomReportResponse**](CustomReportResponse.md)
230
+
231
+ ### Authorization
232
+
233
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
234
+
235
+ ### HTTP request headers
236
+
237
+ - **Content-Type**: application/json; charset=UTF-8
238
+ - **Accept**: application/json
239
+
240
+
241
+ ## execute_report_queries
242
+
243
+ > execute_report_queries(query_request)
244
+
245
+ Execute the report queries
246
+
247
+ Execute the report queries
248
+
249
+
250
+ ### Examples
251
+
252
+ ```ruby
253
+ # Internal API. No samples are provided as merchants will never need this api method
254
+ ```
255
+
256
+
257
+ #### Using the execute_report_queries_with_http_info variant
258
+
259
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
260
+
261
+ > <Array(nil, Integer, Hash)> execute_report_queries_with_http_info(query_request)
262
+
263
+ ```ruby
264
+ begin
265
+ # Execute the report queries
266
+ data, status_code, headers = api_instance.execute_report_queries_with_http_info(query_request)
267
+ p status_code # => 2xx
268
+ p headers # => { ... }
269
+ p data # => nil
270
+ rescue UltracartClient::ApiError => e
271
+ puts "Error when calling DatawarehouseApi->execute_report_queries_with_http_info: #{e}"
272
+ end
273
+ ```
274
+
275
+ ### Parameters
276
+
277
+ | Name | Type | Description | Notes |
278
+ | ---- | ---- | ----------- | ----- |
279
+ | **query_request** | [**ReportExecuteQueriesRequest**](ReportExecuteQueriesRequest.md) | Query request | |
280
+
281
+ ### Return type
282
+
283
+ nil (empty response body)
284
+
285
+ ### Authorization
286
+
287
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
288
+
289
+ ### HTTP request headers
290
+
291
+ - **Content-Type**: application/json
292
+ - **Accept**: application/json
293
+
294
+
295
+ ## get_custom_report
296
+
297
+ > <CustomReportResponse> get_custom_report(custom_report_oid)
298
+
299
+ Get a custom report
300
+
301
+ Retrieve a custom report
302
+
303
+
304
+ ### Examples
305
+
306
+
307
+ (No example for this operation).
308
+
309
+
310
+ #### Using the get_custom_report_with_http_info variant
311
+
312
+ This returns an Array which contains the response data, status code and headers.
313
+
314
+ > <Array(<CustomReportResponse>, Integer, Hash)> get_custom_report_with_http_info(custom_report_oid)
315
+
316
+ ```ruby
317
+ begin
318
+ # Get a custom report
319
+ data, status_code, headers = api_instance.get_custom_report_with_http_info(custom_report_oid)
320
+ p status_code # => 2xx
321
+ p headers # => { ... }
322
+ p data # => <CustomReportResponse>
323
+ rescue UltracartClient::ApiError => e
324
+ puts "Error when calling DatawarehouseApi->get_custom_report_with_http_info: #{e}"
325
+ end
326
+ ```
327
+
328
+ ### Parameters
329
+
330
+ | Name | Type | Description | Notes |
331
+ | ---- | ---- | ----------- | ----- |
332
+ | **custom_report_oid** | **Integer** | | |
333
+
334
+ ### Return type
335
+
336
+ [**CustomReportResponse**](CustomReportResponse.md)
337
+
338
+ ### Authorization
339
+
340
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
341
+
342
+ ### HTTP request headers
343
+
344
+ - **Content-Type**: Not defined
345
+ - **Accept**: application/json
346
+
347
+
348
+ ## get_custom_report_account_config
349
+
350
+ > <CustomReportAccountConfigResponse> get_custom_report_account_config
351
+
352
+ Get custom report account configuration
353
+
354
+ Retrieve a custom report account configuration
355
+
356
+
357
+ ### Examples
358
+
359
+
360
+ (No example for this operation).
361
+
362
+
363
+ #### Using the get_custom_report_account_config_with_http_info variant
364
+
365
+ This returns an Array which contains the response data, status code and headers.
366
+
367
+ > <Array(<CustomReportAccountConfigResponse>, Integer, Hash)> get_custom_report_account_config_with_http_info
368
+
369
+ ```ruby
370
+ begin
371
+ # Get custom report account configuration
372
+ data, status_code, headers = api_instance.get_custom_report_account_config_with_http_info
373
+ p status_code # => 2xx
374
+ p headers # => { ... }
375
+ p data # => <CustomReportAccountConfigResponse>
376
+ rescue UltracartClient::ApiError => e
377
+ puts "Error when calling DatawarehouseApi->get_custom_report_account_config_with_http_info: #{e}"
378
+ end
379
+ ```
380
+
381
+ ### Parameters
382
+
383
+ This endpoint does not need any parameter.
384
+
385
+ ### Return type
386
+
387
+ [**CustomReportAccountConfigResponse**](CustomReportAccountConfigResponse.md)
388
+
389
+ ### Authorization
390
+
391
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
392
+
393
+ ### HTTP request headers
394
+
395
+ - **Content-Type**: Not defined
396
+ - **Accept**: application/json
397
+
398
+
399
+ ## get_report
400
+
401
+ > <ReportResponse> get_report(report_oid)
402
+
403
+ Get a report
404
+
405
+ Retrieve a report
406
+
407
+
408
+ ### Examples
409
+
410
+ ```ruby
411
+ # Internal API. No samples are provided as merchants will never need this api method
412
+ ```
413
+
414
+
415
+ #### Using the get_report_with_http_info variant
416
+
417
+ This returns an Array which contains the response data, status code and headers.
418
+
419
+ > <Array(<ReportResponse>, Integer, Hash)> get_report_with_http_info(report_oid)
420
+
421
+ ```ruby
422
+ begin
423
+ # Get a report
424
+ data, status_code, headers = api_instance.get_report_with_http_info(report_oid)
425
+ p status_code # => 2xx
426
+ p headers # => { ... }
427
+ p data # => <ReportResponse>
428
+ rescue UltracartClient::ApiError => e
429
+ puts "Error when calling DatawarehouseApi->get_report_with_http_info: #{e}"
430
+ end
431
+ ```
432
+
433
+ ### Parameters
434
+
435
+ | Name | Type | Description | Notes |
436
+ | ---- | ---- | ----------- | ----- |
437
+ | **report_oid** | **Integer** | | |
438
+
439
+ ### Return type
440
+
441
+ [**ReportResponse**](ReportResponse.md)
442
+
443
+ ### Authorization
444
+
445
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
446
+
447
+ ### HTTP request headers
448
+
449
+ - **Content-Type**: Not defined
450
+ - **Accept**: application/json
451
+
452
+
453
+ ## get_report_data_set
454
+
455
+ > <ReportDataSetResponse> get_report_data_set(dataset_uuid)
456
+
457
+ Get a report data set
458
+
459
+ Retrieve a report data set
460
+
461
+
462
+ ### Examples
463
+
464
+ ```ruby
465
+ # Internal API. No samples are provided as merchants will never need this api method
466
+ ```
467
+
468
+
469
+ #### Using the get_report_data_set_with_http_info variant
470
+
471
+ This returns an Array which contains the response data, status code and headers.
472
+
473
+ > <Array(<ReportDataSetResponse>, Integer, Hash)> get_report_data_set_with_http_info(dataset_uuid)
474
+
475
+ ```ruby
476
+ begin
477
+ # Get a report data set
478
+ data, status_code, headers = api_instance.get_report_data_set_with_http_info(dataset_uuid)
479
+ p status_code # => 2xx
480
+ p headers # => { ... }
481
+ p data # => <ReportDataSetResponse>
482
+ rescue UltracartClient::ApiError => e
483
+ puts "Error when calling DatawarehouseApi->get_report_data_set_with_http_info: #{e}"
484
+ end
485
+ ```
486
+
487
+ ### Parameters
488
+
489
+ | Name | Type | Description | Notes |
490
+ | ---- | ---- | ----------- | ----- |
491
+ | **dataset_uuid** | **String** | | |
492
+
493
+ ### Return type
494
+
495
+ [**ReportDataSetResponse**](ReportDataSetResponse.md)
496
+
497
+ ### Authorization
498
+
499
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
500
+
501
+ ### HTTP request headers
502
+
503
+ - **Content-Type**: Not defined
504
+ - **Accept**: application/json
505
+
506
+
507
+ ## get_report_data_set_page
508
+
509
+ > <ReportDataSetPageResponse> get_report_data_set_page(dataset_uuid, page_number)
510
+
511
+ Get a report data set page
512
+
513
+ Retrieve a report data set page
514
+
515
+
516
+ ### Examples
517
+
518
+ ```ruby
519
+ # Internal API. No samples are provided as merchants will never need this api method
520
+ ```
521
+
522
+
523
+ #### Using the get_report_data_set_page_with_http_info variant
524
+
525
+ This returns an Array which contains the response data, status code and headers.
526
+
527
+ > <Array(<ReportDataSetPageResponse>, Integer, Hash)> get_report_data_set_page_with_http_info(dataset_uuid, page_number)
528
+
529
+ ```ruby
530
+ begin
531
+ # Get a report data set page
532
+ data, status_code, headers = api_instance.get_report_data_set_page_with_http_info(dataset_uuid, page_number)
533
+ p status_code # => 2xx
534
+ p headers # => { ... }
535
+ p data # => <ReportDataSetPageResponse>
536
+ rescue UltracartClient::ApiError => e
537
+ puts "Error when calling DatawarehouseApi->get_report_data_set_page_with_http_info: #{e}"
538
+ end
539
+ ```
540
+
541
+ ### Parameters
542
+
543
+ | Name | Type | Description | Notes |
544
+ | ---- | ---- | ----------- | ----- |
545
+ | **dataset_uuid** | **String** | | |
546
+ | **page_number** | **Integer** | | |
547
+
548
+ ### Return type
549
+
550
+ [**ReportDataSetPageResponse**](ReportDataSetPageResponse.md)
551
+
552
+ ### Authorization
553
+
554
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
555
+
556
+ ### HTTP request headers
557
+
558
+ - **Content-Type**: Not defined
559
+ - **Accept**: application/json
560
+
561
+
562
+ ## get_report_websocket_authorization
563
+
564
+ > <ReportAuthResponse> get_report_websocket_authorization
565
+
566
+ Get report websocket authorization
567
+
568
+ Retrieve a JWT to authorize a report to make a websocket connection.
569
+
570
+
571
+ ### Examples
572
+
573
+ ```ruby
574
+ # Internal API. No samples are provided as merchants will never need this api method
575
+ ```
576
+
577
+
578
+ #### Using the get_report_websocket_authorization_with_http_info variant
579
+
580
+ This returns an Array which contains the response data, status code and headers.
581
+
582
+ > <Array(<ReportAuthResponse>, Integer, Hash)> get_report_websocket_authorization_with_http_info
583
+
584
+ ```ruby
585
+ begin
586
+ # Get report websocket authorization
587
+ data, status_code, headers = api_instance.get_report_websocket_authorization_with_http_info
588
+ p status_code # => 2xx
589
+ p headers # => { ... }
590
+ p data # => <ReportAuthResponse>
591
+ rescue UltracartClient::ApiError => e
592
+ puts "Error when calling DatawarehouseApi->get_report_websocket_authorization_with_http_info: #{e}"
593
+ end
594
+ ```
595
+
596
+ ### Parameters
597
+
598
+ This endpoint does not need any parameter.
599
+
600
+ ### Return type
601
+
602
+ [**ReportAuthResponse**](ReportAuthResponse.md)
603
+
604
+ ### Authorization
605
+
606
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
607
+
608
+ ### HTTP request headers
609
+
610
+ - **Content-Type**: Not defined
611
+ - **Accept**: application/json
612
+
613
+
614
+ ## get_reports
615
+
616
+ > <ReportsResponse> get_reports
617
+
618
+ Get list of reports available
619
+
620
+ Retrieve a list of reports available
621
+
622
+
623
+ ### Examples
624
+
625
+ ```ruby
626
+ # Internal API. No samples are provided as merchants will never need this api method
627
+ ```
628
+
629
+
630
+ #### Using the get_reports_with_http_info variant
631
+
632
+ This returns an Array which contains the response data, status code and headers.
633
+
634
+ > <Array(<ReportsResponse>, Integer, Hash)> get_reports_with_http_info
635
+
636
+ ```ruby
637
+ begin
638
+ # Get list of reports available
639
+ data, status_code, headers = api_instance.get_reports_with_http_info
640
+ p status_code # => 2xx
641
+ p headers # => { ... }
642
+ p data # => <ReportsResponse>
643
+ rescue UltracartClient::ApiError => e
644
+ puts "Error when calling DatawarehouseApi->get_reports_with_http_info: #{e}"
645
+ end
646
+ ```
647
+
648
+ ### Parameters
649
+
650
+ This endpoint does not need any parameter.
651
+
652
+ ### Return type
653
+
654
+ [**ReportsResponse**](ReportsResponse.md)
655
+
656
+ ### Authorization
657
+
658
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
659
+
660
+ ### HTTP request headers
661
+
662
+ - **Content-Type**: Not defined
663
+ - **Accept**: application/json
664
+
665
+
666
+ ## insert_custom_report
667
+
668
+ > <CustomReportResponse> insert_custom_report(report)
669
+
670
+ Create a custom report
671
+
672
+ Create a new custom report on the UltraCart account.
673
+
674
+
675
+ ### Examples
676
+
677
+
678
+ (No example for this operation).
679
+
680
+
681
+ #### Using the insert_custom_report_with_http_info variant
682
+
683
+ This returns an Array which contains the response data, status code and headers.
684
+
685
+ > <Array(<CustomReportResponse>, Integer, Hash)> insert_custom_report_with_http_info(report)
686
+
687
+ ```ruby
688
+ begin
689
+ # Create a custom report
690
+ data, status_code, headers = api_instance.insert_custom_report_with_http_info(report)
691
+ p status_code # => 2xx
692
+ p headers # => { ... }
693
+ p data # => <CustomReportResponse>
694
+ rescue UltracartClient::ApiError => e
695
+ puts "Error when calling DatawarehouseApi->insert_custom_report_with_http_info: #{e}"
696
+ end
697
+ ```
698
+
699
+ ### Parameters
700
+
701
+ | Name | Type | Description | Notes |
702
+ | ---- | ---- | ----------- | ----- |
703
+ | **report** | [**CustomReport**](CustomReport.md) | Report to create | |
704
+
705
+ ### Return type
706
+
707
+ [**CustomReportResponse**](CustomReportResponse.md)
708
+
709
+ ### Authorization
710
+
711
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
712
+
713
+ ### HTTP request headers
714
+
715
+ - **Content-Type**: application/json; charset=UTF-8
716
+ - **Accept**: application/json
717
+
718
+
719
+ ## insert_report
720
+
721
+ > <ReportResponse> insert_report(report)
722
+
723
+ Create a report
724
+
725
+ Create a new report on the UltraCart account.
726
+
727
+
728
+ ### Examples
729
+
730
+ ```ruby
731
+ # Internal API. No samples are provided as merchants will never need this api method
732
+ ```
733
+
734
+
735
+ #### Using the insert_report_with_http_info variant
736
+
737
+ This returns an Array which contains the response data, status code and headers.
738
+
739
+ > <Array(<ReportResponse>, Integer, Hash)> insert_report_with_http_info(report)
740
+
741
+ ```ruby
742
+ begin
743
+ # Create a report
744
+ data, status_code, headers = api_instance.insert_report_with_http_info(report)
745
+ p status_code # => 2xx
746
+ p headers # => { ... }
747
+ p data # => <ReportResponse>
748
+ rescue UltracartClient::ApiError => e
749
+ puts "Error when calling DatawarehouseApi->insert_report_with_http_info: #{e}"
750
+ end
751
+ ```
752
+
753
+ ### Parameters
754
+
755
+ | Name | Type | Description | Notes |
756
+ | ---- | ---- | ----------- | ----- |
757
+ | **report** | [**Report**](Report.md) | Report to create | |
758
+
759
+ ### Return type
760
+
761
+ [**ReportResponse**](ReportResponse.md)
762
+
763
+ ### Authorization
764
+
765
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
766
+
767
+ ### HTTP request headers
768
+
769
+ - **Content-Type**: application/json; charset=UTF-8
770
+ - **Accept**: application/json
771
+
772
+
773
+ ## update_custom_report
774
+
775
+ > <CustomReportResponse> update_custom_report(custom_report_oid, report)
776
+
777
+ Update a custom report
778
+
779
+ Update a custom report on the UltraCart account.
780
+
781
+
782
+ ### Examples
783
+
784
+
785
+ (No example for this operation).
786
+
787
+
788
+ #### Using the update_custom_report_with_http_info variant
789
+
790
+ This returns an Array which contains the response data, status code and headers.
791
+
792
+ > <Array(<CustomReportResponse>, Integer, Hash)> update_custom_report_with_http_info(custom_report_oid, report)
793
+
794
+ ```ruby
795
+ begin
796
+ # Update a custom report
797
+ data, status_code, headers = api_instance.update_custom_report_with_http_info(custom_report_oid, report)
798
+ p status_code # => 2xx
799
+ p headers # => { ... }
800
+ p data # => <CustomReportResponse>
801
+ rescue UltracartClient::ApiError => e
802
+ puts "Error when calling DatawarehouseApi->update_custom_report_with_http_info: #{e}"
803
+ end
804
+ ```
805
+
806
+ ### Parameters
807
+
808
+ | Name | Type | Description | Notes |
809
+ | ---- | ---- | ----------- | ----- |
810
+ | **custom_report_oid** | **Integer** | The report oid to custom update. | |
811
+ | **report** | [**CustomReport**](CustomReport.md) | Report to custom update | |
812
+
813
+ ### Return type
814
+
815
+ [**CustomReportResponse**](CustomReportResponse.md)
816
+
817
+ ### Authorization
818
+
819
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
820
+
821
+ ### HTTP request headers
822
+
823
+ - **Content-Type**: application/json; charset=UTF-8
824
+ - **Accept**: application/json
825
+
826
+
827
+ ## update_custom_report_account_config
828
+
829
+ > <CustomReportAccountConfigResponse> update_custom_report_account_config(account_config)
830
+
831
+ Update custom report account config
832
+
833
+ Update custom report account config.
834
+
835
+
836
+ ### Examples
837
+
838
+
839
+ (No example for this operation).
840
+
841
+
842
+ #### Using the update_custom_report_account_config_with_http_info variant
843
+
844
+ This returns an Array which contains the response data, status code and headers.
845
+
846
+ > <Array(<CustomReportAccountConfigResponse>, Integer, Hash)> update_custom_report_account_config_with_http_info(account_config)
847
+
848
+ ```ruby
849
+ begin
850
+ # Update custom report account config
851
+ data, status_code, headers = api_instance.update_custom_report_account_config_with_http_info(account_config)
852
+ p status_code # => 2xx
853
+ p headers # => { ... }
854
+ p data # => <CustomReportAccountConfigResponse>
855
+ rescue UltracartClient::ApiError => e
856
+ puts "Error when calling DatawarehouseApi->update_custom_report_account_config_with_http_info: #{e}"
857
+ end
858
+ ```
859
+
860
+ ### Parameters
861
+
862
+ | Name | Type | Description | Notes |
863
+ | ---- | ---- | ----------- | ----- |
864
+ | **account_config** | [**CustomReportAccountConfig**](CustomReportAccountConfig.md) | Account config to update | |
865
+
866
+ ### Return type
867
+
868
+ [**CustomReportAccountConfigResponse**](CustomReportAccountConfigResponse.md)
869
+
870
+ ### Authorization
871
+
872
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
873
+
874
+ ### HTTP request headers
875
+
876
+ - **Content-Type**: application/json; charset=UTF-8
877
+ - **Accept**: application/json
878
+
879
+
880
+ ## update_report
881
+
882
+ > <ReportResponse> update_report(report_oid, report)
883
+
884
+ Update a report
885
+
886
+ Update a report on the UltraCart account.
887
+
888
+
889
+ ### Examples
890
+
891
+ ```ruby
892
+ # Internal API. No samples are provided as merchants will never need this api method
893
+ ```
894
+
895
+
896
+ #### Using the update_report_with_http_info variant
897
+
898
+ This returns an Array which contains the response data, status code and headers.
899
+
900
+ > <Array(<ReportResponse>, Integer, Hash)> update_report_with_http_info(report_oid, report)
901
+
902
+ ```ruby
903
+ begin
904
+ # Update a report
905
+ data, status_code, headers = api_instance.update_report_with_http_info(report_oid, report)
906
+ p status_code # => 2xx
907
+ p headers # => { ... }
908
+ p data # => <ReportResponse>
909
+ rescue UltracartClient::ApiError => e
910
+ puts "Error when calling DatawarehouseApi->update_report_with_http_info: #{e}"
911
+ end
912
+ ```
913
+
914
+ ### Parameters
915
+
916
+ | Name | Type | Description | Notes |
917
+ | ---- | ---- | ----------- | ----- |
918
+ | **report_oid** | **Integer** | The report oid to update. | |
919
+ | **report** | [**Report**](Report.md) | Report to update | |
920
+
921
+ ### Return type
922
+
923
+ [**ReportResponse**](ReportResponse.md)
924
+
925
+ ### Authorization
926
+
927
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
928
+
929
+ ### HTTP request headers
930
+
931
+ - **Content-Type**: application/json; charset=UTF-8
932
+ - **Accept**: application/json
933
+