ultracart_api 3.11.15 → 3.11.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 (33) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -7
  3. data/docs/CustomDashboard.md +11 -0
  4. data/docs/CustomDashboardPage.md +10 -0
  5. data/docs/CustomDashboardPageReport.md +12 -0
  6. data/docs/CustomDashboardResponse.md +12 -0
  7. data/docs/CustomDashboardsResponse.md +12 -0
  8. data/docs/CustomReportExecutionResponse.md +15 -0
  9. data/docs/CustomReportsExecutionReportData.md +10 -0
  10. data/docs/CustomReportsExecutionRequest.md +9 -0
  11. data/docs/CustomReportsExecutionResponse.md +13 -0
  12. data/docs/CustomReportsResponse.md +12 -0
  13. data/docs/DatawarehouseApi.md +351 -2
  14. data/docs/EmailWebhookEditorValuesResponse.md +1 -0
  15. data/docs/OrderApi.md +4 -75
  16. data/docs/WebhookApi.md +0 -16
  17. data/lib/ultracart_api/api/datawarehouse_api.rb +381 -3
  18. data/lib/ultracart_api/api/order_api.rb +4 -86
  19. data/lib/ultracart_api/api/webhook_api.rb +0 -24
  20. data/lib/ultracart_api/models/custom_dashboard.rb +213 -0
  21. data/lib/ultracart_api/models/custom_dashboard_page.rb +204 -0
  22. data/lib/ultracart_api/models/custom_dashboard_page_report.rb +220 -0
  23. data/lib/ultracart_api/models/custom_dashboard_response.rb +221 -0
  24. data/lib/ultracart_api/models/custom_dashboards_response.rb +224 -0
  25. data/lib/ultracart_api/models/custom_report_execution_response.rb +250 -0
  26. data/lib/ultracart_api/models/custom_reports_execution_report_data.rb +202 -0
  27. data/lib/ultracart_api/models/custom_reports_execution_request.rb +197 -0
  28. data/lib/ultracart_api/models/custom_reports_execution_response.rb +234 -0
  29. data/lib/ultracart_api/models/custom_reports_response.rb +224 -0
  30. data/lib/ultracart_api/models/email_webhook_editor_values_response.rb +12 -1
  31. data/lib/ultracart_api/version.rb +1 -1
  32. data/lib/ultracart_api.rb +10 -0
  33. metadata +22 -2
@@ -4,25 +4,81 @@ 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
+ > delete_custom_dashboard(custom_dashboard_oid)
35
+
36
+ Delete a custom dashboard
37
+
38
+ Delete a custom dashboard on the UltraCart account.
39
+
40
+ ### Example
41
+ ```ruby
42
+ # load the gem
43
+ require 'ultracart_api'
44
+
45
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
46
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
47
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
48
+
49
+
50
+ custom_dashboard_oid = 56 # Integer | The dashboard oid to delete.
51
+
52
+
53
+ begin
54
+ #Delete a custom dashboard
55
+ api_instance.delete_custom_dashboard(custom_dashboard_oid)
56
+ rescue UltracartClient::ApiError => e
57
+ puts "Exception when calling DatawarehouseApi->delete_custom_dashboard: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ Name | Type | Description | Notes
64
+ ------------- | ------------- | ------------- | -------------
65
+ **custom_dashboard_oid** | **Integer**| The dashboard oid to delete. |
66
+
67
+ ### Return type
68
+
69
+ nil (empty response body)
70
+
71
+ ### Authorization
72
+
73
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
74
+
75
+ ### HTTP request headers
76
+
77
+ - **Content-Type**: application/json
78
+ - **Accept**: application/json
79
+
80
+
81
+
26
82
  # **delete_custom_report**
27
83
  > delete_custom_report(custom_report_oid)
28
84
 
@@ -172,7 +228,7 @@ Name | Type | Description | Notes
172
228
 
173
229
 
174
230
  # **execute_custom_report**
175
- > CustomReportResponse execute_custom_report(execution_request, custom_report_oid)
231
+ > CustomReportExecutionResponse execute_custom_report(execution_request, custom_report_oid)
176
232
 
177
233
  Execute a custom report
178
234
 
@@ -211,7 +267,57 @@ Name | Type | Description | Notes
211
267
 
212
268
  ### Return type
213
269
 
214
- [**CustomReportResponse**](CustomReportResponse.md)
270
+ [**CustomReportExecutionResponse**](CustomReportExecutionResponse.md)
271
+
272
+ ### Authorization
273
+
274
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
275
+
276
+ ### HTTP request headers
277
+
278
+ - **Content-Type**: application/json; charset=UTF-8
279
+ - **Accept**: application/json
280
+
281
+
282
+
283
+ # **execute_custom_reports**
284
+ > CustomReportsExecutionResponse execute_custom_reports(execution_request)
285
+
286
+ Execute a custom reports
287
+
288
+ Execute a custom reports on the UltraCart account.
289
+
290
+ ### Example
291
+ ```ruby
292
+ # load the gem
293
+ require 'ultracart_api'
294
+
295
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
296
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
297
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
298
+
299
+
300
+ execution_request = UltracartClient::CustomReportsExecutionRequest.new # CustomReportsExecutionRequest | Request to execute custom reports
301
+
302
+
303
+ begin
304
+ #Execute a custom reports
305
+ result = api_instance.execute_custom_reports(execution_request)
306
+ p result
307
+ rescue UltracartClient::ApiError => e
308
+ puts "Exception when calling DatawarehouseApi->execute_custom_reports: #{e}"
309
+ end
310
+ ```
311
+
312
+ ### Parameters
313
+
314
+ Name | Type | Description | Notes
315
+ ------------- | ------------- | ------------- | -------------
316
+ **execution_request** | [**CustomReportsExecutionRequest**](CustomReportsExecutionRequest.md)| Request to execute custom reports |
317
+
318
+ ### Return type
319
+
320
+ [**CustomReportsExecutionResponse**](CustomReportsExecutionResponse.md)
215
321
 
216
322
  ### Authorization
217
323
 
@@ -273,6 +379,101 @@ nil (empty response body)
273
379
 
274
380
 
275
381
 
382
+ # **get_custom_dashboard**
383
+ > CustomDashboardResponse get_custom_dashboard(custom_dashboard_oid)
384
+
385
+ Get a custom dashboard
386
+
387
+ Retrieve a custom dashboard
388
+
389
+ ### Example
390
+ ```ruby
391
+ # load the gem
392
+ require 'ultracart_api'
393
+
394
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
395
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
396
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
397
+
398
+
399
+ custom_dashboard_oid = 56 # Integer |
400
+
401
+
402
+ begin
403
+ #Get a custom dashboard
404
+ result = api_instance.get_custom_dashboard(custom_dashboard_oid)
405
+ p result
406
+ rescue UltracartClient::ApiError => e
407
+ puts "Exception when calling DatawarehouseApi->get_custom_dashboard: #{e}"
408
+ end
409
+ ```
410
+
411
+ ### Parameters
412
+
413
+ Name | Type | Description | Notes
414
+ ------------- | ------------- | ------------- | -------------
415
+ **custom_dashboard_oid** | **Integer**| |
416
+
417
+ ### Return type
418
+
419
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
420
+
421
+ ### Authorization
422
+
423
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
424
+
425
+ ### HTTP request headers
426
+
427
+ - **Content-Type**: application/json
428
+ - **Accept**: application/json
429
+
430
+
431
+
432
+ # **get_custom_dashboards**
433
+ > CustomDashboardsResponse get_custom_dashboards
434
+
435
+ Get custom dashboards
436
+
437
+ Retrieve a custom dashboards
438
+
439
+ ### Example
440
+ ```ruby
441
+ # load the gem
442
+ require 'ultracart_api'
443
+
444
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
445
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
446
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
447
+
448
+
449
+
450
+ begin
451
+ #Get custom dashboards
452
+ result = api_instance.get_custom_dashboards
453
+ p result
454
+ rescue UltracartClient::ApiError => e
455
+ puts "Exception when calling DatawarehouseApi->get_custom_dashboards: #{e}"
456
+ end
457
+ ```
458
+
459
+ ### Parameters
460
+ This endpoint does not need any parameter.
461
+
462
+ ### Return type
463
+
464
+ [**CustomDashboardsResponse**](CustomDashboardsResponse.md)
465
+
466
+ ### Authorization
467
+
468
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
469
+
470
+ ### HTTP request headers
471
+
472
+ - **Content-Type**: application/json
473
+ - **Accept**: application/json
474
+
475
+
476
+
276
477
  # **get_custom_report**
277
478
  > CustomReportResponse get_custom_report(custom_report_oid)
278
479
 
@@ -368,6 +569,51 @@ This endpoint does not need any parameter.
368
569
 
369
570
 
370
571
 
572
+ # **get_custom_reports**
573
+ > CustomReportsResponse get_custom_reports
574
+
575
+ Get custom reports
576
+
577
+ Retrieve a custom reports
578
+
579
+ ### Example
580
+ ```ruby
581
+ # load the gem
582
+ require 'ultracart_api'
583
+
584
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
585
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
586
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
587
+
588
+
589
+
590
+ begin
591
+ #Get custom reports
592
+ result = api_instance.get_custom_reports
593
+ p result
594
+ rescue UltracartClient::ApiError => e
595
+ puts "Exception when calling DatawarehouseApi->get_custom_reports: #{e}"
596
+ end
597
+ ```
598
+
599
+ ### Parameters
600
+ This endpoint does not need any parameter.
601
+
602
+ ### Return type
603
+
604
+ [**CustomReportsResponse**](CustomReportsResponse.md)
605
+
606
+ ### Authorization
607
+
608
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
609
+
610
+ ### HTTP request headers
611
+
612
+ - **Content-Type**: application/json
613
+ - **Accept**: application/json
614
+
615
+
616
+
371
617
  # **get_report**
372
618
  > ReportResponse get_report(report_oid)
373
619
 
@@ -611,6 +857,56 @@ This endpoint does not need any parameter.
611
857
 
612
858
 
613
859
 
860
+ # **insert_custom_dashboard**
861
+ > CustomDashboardResponse insert_custom_dashboard(dashboard)
862
+
863
+ Create a custom dashboard
864
+
865
+ Create a new custom dashboard on the UltraCart account.
866
+
867
+ ### Example
868
+ ```ruby
869
+ # load the gem
870
+ require 'ultracart_api'
871
+
872
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
873
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
874
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
875
+
876
+
877
+ dashboard = UltracartClient::CustomDashboard.new # CustomDashboard | Dashboard to create
878
+
879
+
880
+ begin
881
+ #Create a custom dashboard
882
+ result = api_instance.insert_custom_dashboard(dashboard)
883
+ p result
884
+ rescue UltracartClient::ApiError => e
885
+ puts "Exception when calling DatawarehouseApi->insert_custom_dashboard: #{e}"
886
+ end
887
+ ```
888
+
889
+ ### Parameters
890
+
891
+ Name | Type | Description | Notes
892
+ ------------- | ------------- | ------------- | -------------
893
+ **dashboard** | [**CustomDashboard**](CustomDashboard.md)| Dashboard to create |
894
+
895
+ ### Return type
896
+
897
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
898
+
899
+ ### Authorization
900
+
901
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
902
+
903
+ ### HTTP request headers
904
+
905
+ - **Content-Type**: application/json; charset=UTF-8
906
+ - **Accept**: application/json
907
+
908
+
909
+
614
910
  # **insert_custom_report**
615
911
  > CustomReportResponse insert_custom_report(report)
616
912
 
@@ -711,6 +1007,59 @@ Name | Type | Description | Notes
711
1007
 
712
1008
 
713
1009
 
1010
+ # **update_custom_dashboard**
1011
+ > CustomDashboardResponse update_custom_dashboard(dashboard, custom_dashboard_oid)
1012
+
1013
+ Update a custom dashboard
1014
+
1015
+ Update a custom dashboard on the UltraCart account.
1016
+
1017
+ ### Example
1018
+ ```ruby
1019
+ # load the gem
1020
+ require 'ultracart_api'
1021
+
1022
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1023
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1024
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
1025
+
1026
+
1027
+ dashboard = UltracartClient::CustomDashboard.new # CustomDashboard | Dashboard to custom update
1028
+
1029
+ custom_dashboard_oid = 56 # Integer | The dashboard oid to custom update.
1030
+
1031
+
1032
+ begin
1033
+ #Update a custom dashboard
1034
+ result = api_instance.update_custom_dashboard(dashboard, custom_dashboard_oid)
1035
+ p result
1036
+ rescue UltracartClient::ApiError => e
1037
+ puts "Exception when calling DatawarehouseApi->update_custom_dashboard: #{e}"
1038
+ end
1039
+ ```
1040
+
1041
+ ### Parameters
1042
+
1043
+ Name | Type | Description | Notes
1044
+ ------------- | ------------- | ------------- | -------------
1045
+ **dashboard** | [**CustomDashboard**](CustomDashboard.md)| Dashboard to custom update |
1046
+ **custom_dashboard_oid** | **Integer**| The dashboard oid to custom update. |
1047
+
1048
+ ### Return type
1049
+
1050
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
1051
+
1052
+ ### Authorization
1053
+
1054
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1055
+
1056
+ ### HTTP request headers
1057
+
1058
+ - **Content-Type**: application/json; charset=UTF-8
1059
+ - **Accept**: application/json
1060
+
1061
+
1062
+
714
1063
  # **update_custom_report**
715
1064
  > CustomReportResponse update_custom_report(report, custom_report_oid)
716
1065
 
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  **available_expansions** | **Array<String>** | | [optional]
7
7
  **available_tokens** | **Array<String>** | | [optional]
8
8
  **error** | [**Error**](Error.md) | | [optional]
9
+ **loyalty_tiers** | **Array<String>** | | [optional]
9
10
  **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
10
11
  **rest_object_type** | **String** | | [optional]
11
12
  **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
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 @@ Method | HTTP request | Description
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
@@ -137,7 +136,7 @@ nil (empty response body)
137
136
 
138
137
  ### HTTP request headers
139
138
 
140
- - **Content-Type**: application/json; charset=UTF-8
139
+ - **Content-Type**: application/json
141
140
  - **Accept**: application/json
142
141
 
143
142
 
@@ -1266,76 +1265,6 @@ Name | Type | Description | Notes
1266
1265
 
1267
1266
 
1268
1267
 
1269
- # **refund_order_completely**
1270
- > OrderResponse refund_order_completely(order_id, opts)
1271
-
1272
- Refund an order completely
1273
-
1274
- Perform a refund operation on an order and then update the order if successful.
1275
-
1276
- ### Example
1277
- ```ruby
1278
- # load the gem
1279
- require 'ultracart_api'
1280
-
1281
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1282
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1283
- api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
1284
-
1285
-
1286
- order_id = 'order_id_example' # String | The order id to refund.
1287
-
1288
- opts = {
1289
- reject_after_refund: false, # BOOLEAN | Reject order after refund
1290
- skip_customer_notification: false, # BOOLEAN | Skip customer email notification
1291
- auto_order_cancel: false, # BOOLEAN | Cancel associated auto orders
1292
- manual_refund: false, # BOOLEAN | Consider a manual refund done externally
1293
- reverse_affiliate_transactions: true, # BOOLEAN | Reverse affiliate transactions
1294
- issue_store_credit: false, # BOOLEAN | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
1295
- auto_order_cancel_reason: 'auto_order_cancel_reason_example', # String | Reason for auto orders cancellation
1296
- refund_reason: 'refund_reason_example', # String | Reason for refund
1297
- reject_reason: 'reject_reason_example' # String | Reason for reject
1298
- }
1299
-
1300
- begin
1301
- #Refund an order completely
1302
- result = api_instance.refund_order_completely(order_id, opts)
1303
- p result
1304
- rescue UltracartClient::ApiError => e
1305
- puts "Exception when calling OrderApi->refund_order_completely: #{e}"
1306
- end
1307
- ```
1308
-
1309
- ### Parameters
1310
-
1311
- Name | Type | Description | Notes
1312
- ------------- | ------------- | ------------- | -------------
1313
- **order_id** | **String**| The order id to refund. |
1314
- **reject_after_refund** | **BOOLEAN**| Reject order after refund | [optional] [default to false]
1315
- **skip_customer_notification** | **BOOLEAN**| Skip customer email notification | [optional] [default to false]
1316
- **auto_order_cancel** | **BOOLEAN**| Cancel associated auto orders | [optional] [default to false]
1317
- **manual_refund** | **BOOLEAN**| Consider a manual refund done externally | [optional] [default to false]
1318
- **reverse_affiliate_transactions** | **BOOLEAN**| Reverse affiliate transactions | [optional] [default to true]
1319
- **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]
1320
- **auto_order_cancel_reason** | **String**| Reason for auto orders cancellation | [optional]
1321
- **refund_reason** | **String**| Reason for refund | [optional]
1322
- **reject_reason** | **String**| Reason for reject | [optional]
1323
-
1324
- ### Return type
1325
-
1326
- [**OrderResponse**](OrderResponse.md)
1327
-
1328
- ### Authorization
1329
-
1330
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1331
-
1332
- ### HTTP request headers
1333
-
1334
- - **Content-Type**: application/json; charset=UTF-8
1335
- - **Accept**: application/json
1336
-
1337
-
1338
-
1339
1268
  # **replacement**
1340
1269
  > OrderReplacementResponse replacement(order_id, replacement)
1341
1270
 
@@ -1533,7 +1462,7 @@ nil (empty response body)
1533
1462
 
1534
1463
  ### HTTP request headers
1535
1464
 
1536
- - **Content-Type**: application/json; charset=UTF-8
1465
+ - **Content-Type**: application/json
1537
1466
  - **Accept**: application/json
1538
1467
 
1539
1468
 
data/docs/WebhookApi.md CHANGED
@@ -186,14 +186,6 @@ api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false,
186
186
  webhook_oid = 56 # Integer | The webhook oid to retrieve log summaries for.
187
187
 
188
188
  opts = {
189
- request_id: 'request_id_example', # String |
190
- begin_date: 'begin_date_example', # String |
191
- end_date: 'end_date_example', # String |
192
- status: 'status_example', # String |
193
- event: 'event_example', # String |
194
- order_id: 'order_id_example', # String |
195
- request: 'request_example', # String |
196
- duration: 56, # Integer |
197
189
  _limit: 100, # Integer | The maximum number of records to return on this one API call.
198
190
  _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
199
191
  _since: '_since_example' # String | Fetch log summaries that have been delivered since this date/time.
@@ -213,14 +205,6 @@ end
213
205
  Name | Type | Description | Notes
214
206
  ------------- | ------------- | ------------- | -------------
215
207
  **webhook_oid** | **Integer**| The webhook oid to retrieve log summaries for. |
216
- **request_id** | **String**| | [optional]
217
- **begin_date** | **String**| | [optional]
218
- **end_date** | **String**| | [optional]
219
- **status** | **String**| | [optional]
220
- **event** | **String**| | [optional]
221
- **order_id** | **String**| | [optional]
222
- **request** | **String**| | [optional]
223
- **duration** | **Integer**| | [optional]
224
208
  **_limit** | **Integer**| The maximum number of records to return on this one API call. | [optional] [default to 100]
225
209
  **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
226
210
  **_since** | **String**| Fetch log summaries that have been delivered since this date/time. | [optional]