ultracart_api 4.1.15 → 4.1.17

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 (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -5
  3. data/docs/CustomDashboard.md +24 -0
  4. data/docs/CustomDashboardPage.md +22 -0
  5. data/docs/CustomDashboardPageReport.md +26 -0
  6. data/docs/CustomDashboardResponse.md +26 -0
  7. data/docs/CustomDashboardsResponse.md +26 -0
  8. data/docs/CustomReportExecutionResponse.md +32 -0
  9. data/docs/CustomReportsExecutionReportData.md +22 -0
  10. data/docs/CustomReportsExecutionRequest.md +20 -0
  11. data/docs/CustomReportsExecutionResponse.md +28 -0
  12. data/docs/CustomReportsResponse.md +26 -0
  13. data/docs/DatawarehouseApi.md +379 -4
  14. data/docs/EmailEditorValuesResponse.md +26 -0
  15. data/docs/OrderApi.md +32 -67
  16. data/docs/StorefrontApi.md +52 -0
  17. data/docs/WebhookApi.md +0 -8
  18. data/lib/ultracart_api/api/datawarehouse_api.rb +460 -3
  19. data/lib/ultracart_api/api/order_api.rb +2 -93
  20. data/lib/ultracart_api/api/storefront_api.rb +62 -0
  21. data/lib/ultracart_api/api/webhook_api.rb +0 -24
  22. data/lib/ultracart_api/models/custom_dashboard.rb +248 -0
  23. data/lib/ultracart_api/models/custom_dashboard_page.rb +239 -0
  24. data/lib/ultracart_api/models/custom_dashboard_page_report.rb +255 -0
  25. data/lib/ultracart_api/models/custom_dashboard_response.rb +256 -0
  26. data/lib/ultracart_api/models/custom_dashboards_response.rb +259 -0
  27. data/lib/ultracart_api/models/custom_report_execution_response.rb +285 -0
  28. data/lib/ultracart_api/models/custom_reports_execution_report_data.rb +237 -0
  29. data/lib/ultracart_api/models/custom_reports_execution_request.rb +232 -0
  30. data/lib/ultracart_api/models/custom_reports_execution_response.rb +269 -0
  31. data/lib/ultracart_api/models/custom_reports_response.rb +259 -0
  32. data/lib/ultracart_api/models/email_editor_values_response.rb +258 -0
  33. data/lib/ultracart_api/version.rb +1 -1
  34. data/lib/ultracart_api.rb +11 -0
  35. metadata +24 -2
@@ -4,25 +4,85 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**delete_custom_dashboard**](DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard |
7
8
  | [**delete_custom_report**](DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report |
8
9
  | [**delete_report**](DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report |
9
10
  | [**dry_run_report_queries**](DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries |
10
11
  | [**execute_custom_report**](DatawarehouseApi.md#execute_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report |
12
+ | [**execute_custom_reports**](DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports |
11
13
  | [**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries |
14
+ | [**get_custom_dashboard**](DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard |
15
+ | [**get_custom_dashboards**](DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards |
12
16
  | [**get_custom_report**](DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report |
13
17
  | [**get_custom_report_account_config**](DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration |
18
+ | [**get_custom_reports**](DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports |
14
19
  | [**get_report**](DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report |
15
20
  | [**get_report_data_set**](DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set |
16
21
  | [**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
22
  | [**get_report_websocket_authorization**](DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization |
18
23
  | [**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available |
24
+ | [**insert_custom_dashboard**](DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard |
19
25
  | [**insert_custom_report**](DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report |
20
26
  | [**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report |
27
+ | [**update_custom_dashboard**](DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard |
21
28
  | [**update_custom_report**](DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report |
22
29
  | [**update_custom_report_account_config**](DatawarehouseApi.md#update_custom_report_account_config) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config |
23
30
  | [**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report |
24
31
 
25
32
 
33
+ ## delete_custom_dashboard
34
+
35
+ > delete_custom_dashboard(custom_dashboard_oid)
36
+
37
+ Delete a custom dashboard
38
+
39
+ Delete a custom dashboard on the UltraCart account.
40
+
41
+
42
+ ### Examples
43
+
44
+
45
+ (No example for this operation).
46
+
47
+
48
+ #### Using the delete_custom_dashboard_with_http_info variant
49
+
50
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
51
+
52
+ > <Array(nil, Integer, Hash)> delete_custom_dashboard_with_http_info(custom_dashboard_oid)
53
+
54
+ ```ruby
55
+ begin
56
+ # Delete a custom dashboard
57
+ data, status_code, headers = api_instance.delete_custom_dashboard_with_http_info(custom_dashboard_oid)
58
+ p status_code # => 2xx
59
+ p headers # => { ... }
60
+ p data # => nil
61
+ rescue UltracartClient::ApiError => e
62
+ puts "Error when calling DatawarehouseApi->delete_custom_dashboard_with_http_info: #{e}"
63
+ end
64
+ ```
65
+
66
+ ### Parameters
67
+
68
+ | Name | Type | Description | Notes |
69
+ | ---- | ---- | ----------- | ----- |
70
+ | **custom_dashboard_oid** | **Integer** | The dashboard oid to delete. | |
71
+
72
+ ### Return type
73
+
74
+ nil (empty response body)
75
+
76
+ ### Authorization
77
+
78
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: Not defined
83
+ - **Accept**: application/json
84
+
85
+
26
86
  ## delete_custom_report
27
87
 
28
88
  > delete_custom_report(custom_report_oid)
@@ -186,7 +246,7 @@ end
186
246
 
187
247
  ## execute_custom_report
188
248
 
189
- > <CustomReportResponse> execute_custom_report(custom_report_oid, execution_request)
249
+ > <CustomReportExecutionResponse> execute_custom_report(custom_report_oid, execution_request)
190
250
 
191
251
  Execute a custom report
192
252
 
@@ -203,7 +263,7 @@ Execute a custom report on the UltraCart account.
203
263
 
204
264
  This returns an Array which contains the response data, status code and headers.
205
265
 
206
- > <Array(<CustomReportResponse>, Integer, Hash)> execute_custom_report_with_http_info(custom_report_oid, execution_request)
266
+ > <Array(<CustomReportExecutionResponse>, Integer, Hash)> execute_custom_report_with_http_info(custom_report_oid, execution_request)
207
267
 
208
268
  ```ruby
209
269
  begin
@@ -211,7 +271,7 @@ begin
211
271
  data, status_code, headers = api_instance.execute_custom_report_with_http_info(custom_report_oid, execution_request)
212
272
  p status_code # => 2xx
213
273
  p headers # => { ... }
214
- p data # => <CustomReportResponse>
274
+ p data # => <CustomReportExecutionResponse>
215
275
  rescue UltracartClient::ApiError => e
216
276
  puts "Error when calling DatawarehouseApi->execute_custom_report_with_http_info: #{e}"
217
277
  end
@@ -226,7 +286,60 @@ end
226
286
 
227
287
  ### Return type
228
288
 
229
- [**CustomReportResponse**](CustomReportResponse.md)
289
+ [**CustomReportExecutionResponse**](CustomReportExecutionResponse.md)
290
+
291
+ ### Authorization
292
+
293
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
294
+
295
+ ### HTTP request headers
296
+
297
+ - **Content-Type**: application/json; charset=UTF-8
298
+ - **Accept**: application/json
299
+
300
+
301
+ ## execute_custom_reports
302
+
303
+ > <CustomReportsExecutionResponse> execute_custom_reports(execution_request)
304
+
305
+ Execute a custom reports
306
+
307
+ Execute a custom reports on the UltraCart account.
308
+
309
+
310
+ ### Examples
311
+
312
+
313
+ (No example for this operation).
314
+
315
+
316
+ #### Using the execute_custom_reports_with_http_info variant
317
+
318
+ This returns an Array which contains the response data, status code and headers.
319
+
320
+ > <Array(<CustomReportsExecutionResponse>, Integer, Hash)> execute_custom_reports_with_http_info(execution_request)
321
+
322
+ ```ruby
323
+ begin
324
+ # Execute a custom reports
325
+ data, status_code, headers = api_instance.execute_custom_reports_with_http_info(execution_request)
326
+ p status_code # => 2xx
327
+ p headers # => { ... }
328
+ p data # => <CustomReportsExecutionResponse>
329
+ rescue UltracartClient::ApiError => e
330
+ puts "Error when calling DatawarehouseApi->execute_custom_reports_with_http_info: #{e}"
331
+ end
332
+ ```
333
+
334
+ ### Parameters
335
+
336
+ | Name | Type | Description | Notes |
337
+ | ---- | ---- | ----------- | ----- |
338
+ | **execution_request** | [**CustomReportsExecutionRequest**](CustomReportsExecutionRequest.md) | Request to execute custom reports | |
339
+
340
+ ### Return type
341
+
342
+ [**CustomReportsExecutionResponse**](CustomReportsExecutionResponse.md)
230
343
 
231
344
  ### Authorization
232
345
 
@@ -292,6 +405,110 @@ nil (empty response body)
292
405
  - **Accept**: application/json
293
406
 
294
407
 
408
+ ## get_custom_dashboard
409
+
410
+ > <CustomDashboardResponse> get_custom_dashboard(custom_dashboard_oid)
411
+
412
+ Get a custom dashboard
413
+
414
+ Retrieve a custom dashboard
415
+
416
+
417
+ ### Examples
418
+
419
+
420
+ (No example for this operation).
421
+
422
+
423
+ #### Using the get_custom_dashboard_with_http_info variant
424
+
425
+ This returns an Array which contains the response data, status code and headers.
426
+
427
+ > <Array(<CustomDashboardResponse>, Integer, Hash)> get_custom_dashboard_with_http_info(custom_dashboard_oid)
428
+
429
+ ```ruby
430
+ begin
431
+ # Get a custom dashboard
432
+ data, status_code, headers = api_instance.get_custom_dashboard_with_http_info(custom_dashboard_oid)
433
+ p status_code # => 2xx
434
+ p headers # => { ... }
435
+ p data # => <CustomDashboardResponse>
436
+ rescue UltracartClient::ApiError => e
437
+ puts "Error when calling DatawarehouseApi->get_custom_dashboard_with_http_info: #{e}"
438
+ end
439
+ ```
440
+
441
+ ### Parameters
442
+
443
+ | Name | Type | Description | Notes |
444
+ | ---- | ---- | ----------- | ----- |
445
+ | **custom_dashboard_oid** | **Integer** | | |
446
+
447
+ ### Return type
448
+
449
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
450
+
451
+ ### Authorization
452
+
453
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
454
+
455
+ ### HTTP request headers
456
+
457
+ - **Content-Type**: Not defined
458
+ - **Accept**: application/json
459
+
460
+
461
+ ## get_custom_dashboards
462
+
463
+ > <CustomDashboardsResponse> get_custom_dashboards
464
+
465
+ Get custom dashboards
466
+
467
+ Retrieve a custom dashboards
468
+
469
+
470
+ ### Examples
471
+
472
+
473
+ (No example for this operation).
474
+
475
+
476
+ #### Using the get_custom_dashboards_with_http_info variant
477
+
478
+ This returns an Array which contains the response data, status code and headers.
479
+
480
+ > <Array(<CustomDashboardsResponse>, Integer, Hash)> get_custom_dashboards_with_http_info
481
+
482
+ ```ruby
483
+ begin
484
+ # Get custom dashboards
485
+ data, status_code, headers = api_instance.get_custom_dashboards_with_http_info
486
+ p status_code # => 2xx
487
+ p headers # => { ... }
488
+ p data # => <CustomDashboardsResponse>
489
+ rescue UltracartClient::ApiError => e
490
+ puts "Error when calling DatawarehouseApi->get_custom_dashboards_with_http_info: #{e}"
491
+ end
492
+ ```
493
+
494
+ ### Parameters
495
+
496
+ This endpoint does not need any parameter.
497
+
498
+ ### Return type
499
+
500
+ [**CustomDashboardsResponse**](CustomDashboardsResponse.md)
501
+
502
+ ### Authorization
503
+
504
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
505
+
506
+ ### HTTP request headers
507
+
508
+ - **Content-Type**: Not defined
509
+ - **Accept**: application/json
510
+
511
+
295
512
  ## get_custom_report
296
513
 
297
514
  > <CustomReportResponse> get_custom_report(custom_report_oid)
@@ -396,6 +613,57 @@ This endpoint does not need any parameter.
396
613
  - **Accept**: application/json
397
614
 
398
615
 
616
+ ## get_custom_reports
617
+
618
+ > <CustomReportsResponse> get_custom_reports
619
+
620
+ Get custom reports
621
+
622
+ Retrieve a custom reports
623
+
624
+
625
+ ### Examples
626
+
627
+
628
+ (No example for this operation).
629
+
630
+
631
+ #### Using the get_custom_reports_with_http_info variant
632
+
633
+ This returns an Array which contains the response data, status code and headers.
634
+
635
+ > <Array(<CustomReportsResponse>, Integer, Hash)> get_custom_reports_with_http_info
636
+
637
+ ```ruby
638
+ begin
639
+ # Get custom reports
640
+ data, status_code, headers = api_instance.get_custom_reports_with_http_info
641
+ p status_code # => 2xx
642
+ p headers # => { ... }
643
+ p data # => <CustomReportsResponse>
644
+ rescue UltracartClient::ApiError => e
645
+ puts "Error when calling DatawarehouseApi->get_custom_reports_with_http_info: #{e}"
646
+ end
647
+ ```
648
+
649
+ ### Parameters
650
+
651
+ This endpoint does not need any parameter.
652
+
653
+ ### Return type
654
+
655
+ [**CustomReportsResponse**](CustomReportsResponse.md)
656
+
657
+ ### Authorization
658
+
659
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
660
+
661
+ ### HTTP request headers
662
+
663
+ - **Content-Type**: Not defined
664
+ - **Accept**: application/json
665
+
666
+
399
667
  ## get_report
400
668
 
401
669
  > <ReportResponse> get_report(report_oid)
@@ -663,6 +931,59 @@ This endpoint does not need any parameter.
663
931
  - **Accept**: application/json
664
932
 
665
933
 
934
+ ## insert_custom_dashboard
935
+
936
+ > <CustomDashboardResponse> insert_custom_dashboard(dashboard)
937
+
938
+ Create a custom dashboard
939
+
940
+ Create a new custom dashboard on the UltraCart account.
941
+
942
+
943
+ ### Examples
944
+
945
+
946
+ (No example for this operation).
947
+
948
+
949
+ #### Using the insert_custom_dashboard_with_http_info variant
950
+
951
+ This returns an Array which contains the response data, status code and headers.
952
+
953
+ > <Array(<CustomDashboardResponse>, Integer, Hash)> insert_custom_dashboard_with_http_info(dashboard)
954
+
955
+ ```ruby
956
+ begin
957
+ # Create a custom dashboard
958
+ data, status_code, headers = api_instance.insert_custom_dashboard_with_http_info(dashboard)
959
+ p status_code # => 2xx
960
+ p headers # => { ... }
961
+ p data # => <CustomDashboardResponse>
962
+ rescue UltracartClient::ApiError => e
963
+ puts "Error when calling DatawarehouseApi->insert_custom_dashboard_with_http_info: #{e}"
964
+ end
965
+ ```
966
+
967
+ ### Parameters
968
+
969
+ | Name | Type | Description | Notes |
970
+ | ---- | ---- | ----------- | ----- |
971
+ | **dashboard** | [**CustomDashboard**](CustomDashboard.md) | Dashboard to create | |
972
+
973
+ ### Return type
974
+
975
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
976
+
977
+ ### Authorization
978
+
979
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
980
+
981
+ ### HTTP request headers
982
+
983
+ - **Content-Type**: application/json; charset=UTF-8
984
+ - **Accept**: application/json
985
+
986
+
666
987
  ## insert_custom_report
667
988
 
668
989
  > <CustomReportResponse> insert_custom_report(report)
@@ -770,6 +1091,60 @@ end
770
1091
  - **Accept**: application/json
771
1092
 
772
1093
 
1094
+ ## update_custom_dashboard
1095
+
1096
+ > <CustomDashboardResponse> update_custom_dashboard(custom_dashboard_oid, dashboard)
1097
+
1098
+ Update a custom dashboard
1099
+
1100
+ Update a custom dashboard on the UltraCart account.
1101
+
1102
+
1103
+ ### Examples
1104
+
1105
+
1106
+ (No example for this operation).
1107
+
1108
+
1109
+ #### Using the update_custom_dashboard_with_http_info variant
1110
+
1111
+ This returns an Array which contains the response data, status code and headers.
1112
+
1113
+ > <Array(<CustomDashboardResponse>, Integer, Hash)> update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard)
1114
+
1115
+ ```ruby
1116
+ begin
1117
+ # Update a custom dashboard
1118
+ data, status_code, headers = api_instance.update_custom_dashboard_with_http_info(custom_dashboard_oid, dashboard)
1119
+ p status_code # => 2xx
1120
+ p headers # => { ... }
1121
+ p data # => <CustomDashboardResponse>
1122
+ rescue UltracartClient::ApiError => e
1123
+ puts "Error when calling DatawarehouseApi->update_custom_dashboard_with_http_info: #{e}"
1124
+ end
1125
+ ```
1126
+
1127
+ ### Parameters
1128
+
1129
+ | Name | Type | Description | Notes |
1130
+ | ---- | ---- | ----------- | ----- |
1131
+ | **custom_dashboard_oid** | **Integer** | The dashboard oid to custom update. | |
1132
+ | **dashboard** | [**CustomDashboard**](CustomDashboard.md) | Dashboard to custom update | |
1133
+
1134
+ ### Return type
1135
+
1136
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
1137
+
1138
+ ### Authorization
1139
+
1140
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1141
+
1142
+ ### HTTP request headers
1143
+
1144
+ - **Content-Type**: application/json; charset=UTF-8
1145
+ - **Accept**: application/json
1146
+
1147
+
773
1148
  ## update_custom_report
774
1149
 
775
1150
  > <CustomReportResponse> update_custom_report(custom_report_oid, report)
@@ -0,0 +1,26 @@
1
+ # UltracartClient::EmailEditorValuesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **loyalty_tiers** | **Array&lt;String&gt;** | | [optional] |
9
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::EmailEditorValuesResponse.new(
19
+ error: null,
20
+ loyalty_tiers: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
data/docs/OrderApi.md CHANGED
@@ -5,7 +5,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**adjust_order_total**](OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total |
8
- | [**block_refund_on_order**](OrderApi.md#block_refund_on_order) | **POST** /order/orders/{order_id}/refund_block | Set a refund block on an order |
8
+ | [**block_refund_on_order**](OrderApi.md#block_refund_on_order) | **GET** /order/orders/{order_id}/refund_block | Set a refund block on an order |
9
9
  | [**cancel_order**](OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order |
10
10
  | [**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order |
11
11
  | [**duplicate_order**](OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order |
@@ -26,11 +26,10 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
26
26
  | [**is_refundable_order**](OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded |
27
27
  | [**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment |
28
28
  | [**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order |
29
- | [**refund_order_completely**](OrderApi.md#refund_order_completely) | **PUT** /order/orders/{order_id}/refund_completely | Refund an order completely |
30
29
  | [**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order |
31
30
  | [**resend_receipt**](OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt |
32
31
  | [**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation |
33
- | [**unblock_refund_on_order**](OrderApi.md#unblock_refund_on_order) | **POST** /order/orders/{order_id}/refund_unblock | Remove a refund block on an order |
32
+ | [**unblock_refund_on_order**](OrderApi.md#unblock_refund_on_order) | **GET** /order/orders/{order_id}/refund_unblock | Remove a refund block on an order |
34
33
  | [**update_accounts_receivable_retry_config**](OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration |
35
34
  | [**update_order**](OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order |
36
35
  | [**validate_order**](OrderApi.md#validate_order) | **POST** /order/validate | Validate |
@@ -127,8 +126,22 @@ Sets a refund block on an order to prevent a user from performing a refund. Com
127
126
 
128
127
  ### Examples
129
128
 
129
+ ```ruby
130
+ require 'ultracart_api'
131
+ require_relative '../constants'
130
132
 
131
- (No example for this operation).
133
+ #
134
+ # blockRefundOnOrder sets an order property that is considered when a refund request is made.
135
+ # If the property is present, the refund is denied. Being an order property allows for querying
136
+ # upon it within BigQuery for audit purposes.
137
+ #
138
+ order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
139
+
140
+ order_id = 'DEMO-0009105222'
141
+ order_api.block_refund_on_order(order_id, {block_reason: 'Chargeback'})
142
+
143
+ p 'Method executed successfully. Returns back 204 No Content'
144
+ ```
132
145
 
133
146
 
134
147
  #### Using the block_refund_on_order_with_http_info variant
@@ -2267,68 +2280,6 @@ end
2267
2280
  - **Accept**: application/json
2268
2281
 
2269
2282
 
2270
- ## refund_order_completely
2271
-
2272
- > <OrderResponse> refund_order_completely(order_id, opts)
2273
-
2274
- Refund an order completely
2275
-
2276
- Perform a refund operation on an order and then update the order if successful.
2277
-
2278
-
2279
- ### Examples
2280
-
2281
-
2282
- (No example for this operation).
2283
-
2284
-
2285
- #### Using the refund_order_completely_with_http_info variant
2286
-
2287
- This returns an Array which contains the response data, status code and headers.
2288
-
2289
- > <Array(<OrderResponse>, Integer, Hash)> refund_order_completely_with_http_info(order_id, opts)
2290
-
2291
- ```ruby
2292
- begin
2293
- # Refund an order completely
2294
- data, status_code, headers = api_instance.refund_order_completely_with_http_info(order_id, opts)
2295
- p status_code # => 2xx
2296
- p headers # => { ... }
2297
- p data # => <OrderResponse>
2298
- rescue UltracartClient::ApiError => e
2299
- puts "Error when calling OrderApi->refund_order_completely_with_http_info: #{e}"
2300
- end
2301
- ```
2302
-
2303
- ### Parameters
2304
-
2305
- | Name | Type | Description | Notes |
2306
- | ---- | ---- | ----------- | ----- |
2307
- | **order_id** | **String** | The order id to refund. | |
2308
- | **reject_after_refund** | **Boolean** | Reject order after refund | [optional][default to false] |
2309
- | **skip_customer_notification** | **Boolean** | Skip customer email notification | [optional][default to false] |
2310
- | **auto_order_cancel** | **Boolean** | Cancel associated auto orders | [optional][default to false] |
2311
- | **manual_refund** | **Boolean** | Consider a manual refund done externally | [optional][default to false] |
2312
- | **reverse_affiliate_transactions** | **Boolean** | Reverse affiliate transactions | [optional][default to true] |
2313
- | **issue_store_credit** | **Boolean** | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account | [optional][default to false] |
2314
- | **auto_order_cancel_reason** | **String** | Reason for auto orders cancellation | [optional] |
2315
- | **refund_reason** | **String** | Reason for refund | [optional] |
2316
- | **reject_reason** | **String** | Reason for reject | [optional] |
2317
-
2318
- ### Return type
2319
-
2320
- [**OrderResponse**](OrderResponse.md)
2321
-
2322
- ### Authorization
2323
-
2324
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2325
-
2326
- ### HTTP request headers
2327
-
2328
- - **Content-Type**: Not defined
2329
- - **Accept**: application/json
2330
-
2331
-
2332
2283
  ## replacement
2333
2284
 
2334
2285
  > <OrderReplacementResponse> replacement(order_id, replacement)
@@ -2591,8 +2542,22 @@ Removes a refund block on an order to prevent a user from performing a refund.
2591
2542
 
2592
2543
  ### Examples
2593
2544
 
2545
+ ```ruby
2546
+ require 'ultracart_api'
2547
+ require_relative '../constants'
2594
2548
 
2595
- (No example for this operation).
2549
+ #
2550
+ # unblockRefundOnOrder removes an order property that is considered when a refund request is made.
2551
+ # If the property is present, the refund is denied. Being an order property allows for querying
2552
+ # upon it within BigQuery for audit purposes.#
2553
+ #
2554
+ order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
2555
+
2556
+ order_id = 'DEMO-0009105222'
2557
+ order_api.unblock_refund_on_order(order_id)
2558
+
2559
+ p 'Method executed successfully. Returns back 204 No Content'
2560
+ ```
2596
2561
 
2597
2562
 
2598
2563
  #### Using the unblock_refund_on_order_with_http_info variant
@@ -44,6 +44,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
44
44
  | [**get_email_campaigns**](StorefrontApi.md#get_email_campaigns) | **GET** /storefront/{storefront_oid}/email/campaigns | Get email campaigns |
45
45
  | [**get_email_campaigns_with_stats**](StorefrontApi.md#get_email_campaigns_with_stats) | **GET** /storefront/{storefront_oid}/email/campaignsWithStats/{stat_days} | Get email campaigns with stats |
46
46
  | [**get_email_commseq**](StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq |
47
+ | [**get_email_commseq_editor_values**](StorefrontApi.md#get_email_commseq_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/editorValues | Get email merchant specific editor values |
47
48
  | [**get_email_commseq_email_stats**](StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats |
48
49
  | [**get_email_commseq_postcard_stats**](StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats |
49
50
  | [**get_email_commseq_postcard_tracking**](StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking |
@@ -2303,6 +2304,57 @@ end
2303
2304
  - **Accept**: application/json
2304
2305
 
2305
2306
 
2307
+ ## get_email_commseq_editor_values
2308
+
2309
+ > <EmailEditorValuesResponse> get_email_commseq_editor_values(storefront_oid)
2310
+
2311
+ Get email merchant specific editor values
2312
+
2313
+
2314
+ ### Examples
2315
+
2316
+
2317
+ (No example for this operation).
2318
+
2319
+
2320
+ #### Using the get_email_commseq_editor_values_with_http_info variant
2321
+
2322
+ This returns an Array which contains the response data, status code and headers.
2323
+
2324
+ > <Array(<EmailEditorValuesResponse>, Integer, Hash)> get_email_commseq_editor_values_with_http_info(storefront_oid)
2325
+
2326
+ ```ruby
2327
+ begin
2328
+ # Get email merchant specific editor values
2329
+ data, status_code, headers = api_instance.get_email_commseq_editor_values_with_http_info(storefront_oid)
2330
+ p status_code # => 2xx
2331
+ p headers # => { ... }
2332
+ p data # => <EmailEditorValuesResponse>
2333
+ rescue UltracartClient::ApiError => e
2334
+ puts "Error when calling StorefrontApi->get_email_commseq_editor_values_with_http_info: #{e}"
2335
+ end
2336
+ ```
2337
+
2338
+ ### Parameters
2339
+
2340
+ | Name | Type | Description | Notes |
2341
+ | ---- | ---- | ----------- | ----- |
2342
+ | **storefront_oid** | **Integer** | | |
2343
+
2344
+ ### Return type
2345
+
2346
+ [**EmailEditorValuesResponse**](EmailEditorValuesResponse.md)
2347
+
2348
+ ### Authorization
2349
+
2350
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2351
+
2352
+ ### HTTP request headers
2353
+
2354
+ - **Content-Type**: Not defined
2355
+ - **Accept**: application/json
2356
+
2357
+
2306
2358
  ## get_email_commseq_email_stats
2307
2359
 
2308
2360
  > <EmailStatSummaryResponse> get_email_commseq_email_stats(storefront_oid, commseq_uuid, stats_request)