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.
- checksums.yaml +4 -4
- data/README.md +23 -2
- data/docs/AffiliateApi.md +123 -167
- data/docs/AutoOrderApi.md +1250 -903
- data/docs/CartUpsellAfter.md +6 -2
- data/docs/ChannelPartnerApi.md +1678 -1121
- data/docs/ChargebackApi.md +297 -405
- data/docs/CheckoutApi.md +1622 -1424
- data/docs/ConversationApi.md +4820 -6315
- data/docs/ConversationVirtualAgentCapabilities.md +4 -0
- data/docs/CouponApi.md +1522 -1443
- data/docs/CustomReport.md +36 -0
- data/docs/CustomReportAccountConfig.md +34 -0
- data/docs/CustomReportAccountConfigResponse.md +26 -0
- data/docs/CustomReportExecutionParameter.md +22 -0
- data/docs/CustomReportExecutionRequest.md +18 -0
- data/docs/CustomReportParameter.md +28 -0
- data/docs/CustomReportParameterOption.md +20 -0
- data/docs/CustomReportQuery.md +28 -0
- data/docs/CustomReportResponse.md +26 -0
- data/docs/CustomReportTooltip.md +20 -0
- data/docs/CustomerApi.md +2570 -1845
- data/docs/DatawarehouseApi.md +933 -723
- data/docs/FulfillmentApi.md +567 -441
- data/docs/GiftCertificateApi.md +617 -598
- data/docs/IntegrationLogApi.md +290 -385
- data/docs/Item.md +1 -1
- data/docs/ItemApi.md +2174 -1746
- data/docs/OauthApi.md +203 -163
- data/docs/OrderApi.md +2883 -2177
- data/docs/SsoApi.md +223 -288
- data/docs/StorefrontApi.md +9692 -12967
- data/docs/TaxApi.md +1541 -2017
- data/docs/UserApi.md +606 -790
- data/docs/WebhookApi.md +787 -628
- data/docs/WorkflowApi.md +666 -879
- data/lib/ultracart_api/api/datawarehouse_api.rb +474 -0
- data/lib/ultracart_api/api/order_api.rb +131 -0
- data/lib/ultracart_api/models/cart_upsell_after.rb +25 -5
- data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +55 -1
- data/lib/ultracart_api/models/custom_report.rb +306 -0
- data/lib/ultracart_api/models/custom_report_account_config.rb +296 -0
- data/lib/ultracart_api/models/custom_report_account_config_response.rb +256 -0
- data/lib/ultracart_api/models/custom_report_execution_parameter.rb +237 -0
- data/lib/ultracart_api/models/custom_report_execution_request.rb +221 -0
- data/lib/ultracart_api/models/custom_report_parameter.rb +266 -0
- data/lib/ultracart_api/models/custom_report_parameter_option.rb +228 -0
- data/lib/ultracart_api/models/custom_report_query.rb +266 -0
- data/lib/ultracart_api/models/custom_report_response.rb +256 -0
- data/lib/ultracart_api/models/custom_report_tooltip.rb +228 -0
- data/lib/ultracart_api/models/item.rb +1 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +10 -0
- metadata +22 -2
data/docs/DatawarehouseApi.md
CHANGED
@@ -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
|
-
| [**
|
8
|
-
| [**
|
9
|
-
| [**
|
10
|
-
| [**
|
11
|
-
| [**
|
12
|
-
| [**
|
13
|
-
| [**
|
14
|
-
| [**
|
15
|
-
| [**
|
16
|
-
| [**
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
```
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
###
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
#
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
```
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
###
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
###
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
#
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
#
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
```
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
|
418
|
-
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
|
429
|
-
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
###
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
```
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
|
481
|
-
|
482
|
-
|
483
|
-
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
|
508
|
-
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
|
519
|
-
|
520
|
-
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
#
|
532
|
-
|
533
|
-
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
|
561
|
-
|
562
|
-
|
563
|
-
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
568
|
-
|
569
|
-
|
570
|
-
|
571
|
-
###
|
572
|
-
|
573
|
-
|
574
|
-
|
575
|
-
|
576
|
-
|
577
|
-
|
578
|
-
|
579
|
-
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
587
|
-
|
588
|
-
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
|
608
|
-
|
609
|
-
|
610
|
-
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
|
620
|
-
|
621
|
-
|
622
|
-
|
623
|
-
|
624
|
-
|
625
|
-
|
626
|
-
|
627
|
-
|
628
|
-
|
629
|
-
|
630
|
-
|
631
|
-
|
632
|
-
|
633
|
-
|
634
|
-
|
635
|
-
|
636
|
-
|
637
|
-
|
638
|
-
|
639
|
-
|
640
|
-
|
641
|
-
|
642
|
-
|
643
|
-
|
644
|
-
|
645
|
-
|
646
|
-
|
647
|
-
|
648
|
-
|
649
|
-
|
650
|
-
|
651
|
-
|
652
|
-
|
653
|
-
|
654
|
-
|
655
|
-
|
656
|
-
|
657
|
-
|
658
|
-
|
659
|
-
|
660
|
-
###
|
661
|
-
|
662
|
-
|
663
|
-
|
664
|
-
|
665
|
-
|
666
|
-
|
667
|
-
|
668
|
-
|
669
|
-
|
670
|
-
|
671
|
-
|
672
|
-
|
673
|
-
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
|
684
|
-
|
685
|
-
|
686
|
-
|
687
|
-
|
688
|
-
|
689
|
-
|
690
|
-
|
691
|
-
|
692
|
-
|
693
|
-
|
694
|
-
|
695
|
-
|
696
|
-
|
697
|
-
|
698
|
-
|
699
|
-
|
700
|
-
|
701
|
-
|
702
|
-
|
703
|
-
|
704
|
-
|
705
|
-
|
706
|
-
|
707
|
-
|
708
|
-
|
709
|
-
|
710
|
-
|
711
|
-
|
712
|
-
|
713
|
-
|
714
|
-
|
715
|
-
|
716
|
-
|
717
|
-
|
718
|
-
|
719
|
-
|
720
|
-
|
721
|
-
|
722
|
-
|
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
|
+
|