ultracart_api 3.11.20 → 3.11.21
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 +12 -4
- data/docs/CustomReportAccountConfig.md +1 -0
- data/docs/CustomReportAnalysisRequest.md +9 -0
- data/docs/CustomReportAnalysisResponse.md +12 -0
- data/docs/CustomReportChartPngUploadResponse.md +13 -0
- data/docs/DatawarehouseApi.md +105 -0
- data/docs/ItemTag.md +1 -1
- data/docs/OrderApi.md +58 -0
- data/docs/ReplaceOrderItemIdRequest.md +11 -0
- data/lib/ultracart_api/api/datawarehouse_api.rb +116 -0
- data/lib/ultracart_api/api/order_api.rb +64 -0
- data/lib/ultracart_api/models/custom_report_account_config.rb +10 -1
- data/lib/ultracart_api/models/custom_report_analysis_request.rb +193 -0
- data/lib/ultracart_api/models/custom_report_analysis_response.rb +221 -0
- data/lib/ultracart_api/models/custom_report_chart_png_upload_response.rb +230 -0
- data/lib/ultracart_api/models/item_tag.rb +1 -1
- data/lib/ultracart_api/models/replace_order_item_id_request.rb +245 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d20e4cccc3734a6fa9c16a641520fbe569d0cbf42ec7d9ac5dad1d373e0353a8
|
4
|
+
data.tar.gz: 264507e5e031c6b06b455a44afa57bd1ffeabeaafff67c1bbe7f54dd425f2c88
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ad83c0433866612348aa5422f4ebbf763ddf490e1ce746fccc92d2ddd446374c12d64e0523d7b91a0610148e0ecbc700f2f3025a756d3d4a83b126d2bbcadfe4
|
7
|
+
data.tar.gz: b31439125febf3a0f5a0f4352bd19f1f8a633dc1e78b4450d2fe4a5a5d819db29c3ca9cd8804f6a7577a3972cc9a874edb24d48283e733db3fb507484dfa92c0
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.11.
|
10
|
+
- Package version: 3.11.21
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.11.
|
27
|
+
gem install ./ultracart_api-3.11.21.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.11.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.11.21.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.11.
|
35
|
+
gem 'ultracart_api', '~> 3.11.21'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -264,6 +264,7 @@ Class | Method | HTTP request | Description
|
|
264
264
|
*UltracartClient::CustomerApi* | [**update_customer_email_lists**](docs/CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
|
265
265
|
*UltracartClient::CustomerApi* | [**update_wish_list_item**](docs/CustomerApi.md#update_wish_list_item) | **PUT** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Update a customer wishlist item
|
266
266
|
*UltracartClient::CustomerApi* | [**validate_email_verification_token**](docs/CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
|
267
|
+
*UltracartClient::DatawarehouseApi* | [**analyze_custom_report**](docs/DatawarehouseApi.md#analyze_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/analysis | Analyze a custom report
|
267
268
|
*UltracartClient::DatawarehouseApi* | [**delete_custom_dashboard**](docs/DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
|
268
269
|
*UltracartClient::DatawarehouseApi* | [**delete_custom_dashboard_schedule**](docs/DatawarehouseApi.md#delete_custom_dashboard_schedule) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Delete a custom dashboard schedule
|
269
270
|
*UltracartClient::DatawarehouseApi* | [**delete_custom_report**](docs/DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
|
@@ -277,6 +278,7 @@ Class | Method | HTTP request | Description
|
|
277
278
|
*UltracartClient::DatawarehouseApi* | [**get_custom_dashboards**](docs/DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
|
278
279
|
*UltracartClient::DatawarehouseApi* | [**get_custom_report**](docs/DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
|
279
280
|
*UltracartClient::DatawarehouseApi* | [**get_custom_report_account_config**](docs/DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration
|
281
|
+
*UltracartClient::DatawarehouseApi* | [**get_custom_report_chart_png_upload_url**](docs/DatawarehouseApi.md#get_custom_report_chart_png_upload_url) | **GET** /datawarehouse/custom_reports/{custom_report_oid}/chart_png | Upload a PNG of a custom report chart
|
280
282
|
*UltracartClient::DatawarehouseApi* | [**get_custom_reports**](docs/DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports
|
281
283
|
*UltracartClient::DatawarehouseApi* | [**get_report**](docs/DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
|
282
284
|
*UltracartClient::DatawarehouseApi* | [**get_report_data_set**](docs/DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
|
@@ -358,6 +360,7 @@ Class | Method | HTTP request | Description
|
|
358
360
|
*UltracartClient::OrderApi* | [**is_refundable_order**](docs/OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
|
359
361
|
*UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
|
360
362
|
*UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
|
363
|
+
*UltracartClient::OrderApi* | [**replace_order_item_merchant_item_id**](docs/OrderApi.md#replace_order_item_merchant_item_id) | **PUT** /order/orders/{order_id}/replace_item_id | Replaces an order item id
|
361
364
|
*UltracartClient::OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
|
362
365
|
*UltracartClient::OrderApi* | [**resend_receipt**](docs/OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
|
363
366
|
*UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
|
@@ -926,6 +929,9 @@ Class | Method | HTTP request | Description
|
|
926
929
|
- [UltracartClient::CustomReport](docs/CustomReport.md)
|
927
930
|
- [UltracartClient::CustomReportAccountConfig](docs/CustomReportAccountConfig.md)
|
928
931
|
- [UltracartClient::CustomReportAccountConfigResponse](docs/CustomReportAccountConfigResponse.md)
|
932
|
+
- [UltracartClient::CustomReportAnalysisRequest](docs/CustomReportAnalysisRequest.md)
|
933
|
+
- [UltracartClient::CustomReportAnalysisResponse](docs/CustomReportAnalysisResponse.md)
|
934
|
+
- [UltracartClient::CustomReportChartPngUploadResponse](docs/CustomReportChartPngUploadResponse.md)
|
929
935
|
- [UltracartClient::CustomReportExecutionParameter](docs/CustomReportExecutionParameter.md)
|
930
936
|
- [UltracartClient::CustomReportExecutionRequest](docs/CustomReportExecutionRequest.md)
|
931
937
|
- [UltracartClient::CustomReportExecutionResponse](docs/CustomReportExecutionResponse.md)
|
@@ -1332,6 +1338,7 @@ Class | Method | HTTP request | Description
|
|
1332
1338
|
- [UltracartClient::PublishLibraryItemRequest](docs/PublishLibraryItemRequest.md)
|
1333
1339
|
- [UltracartClient::RegisterAffiliateClickRequest](docs/RegisterAffiliateClickRequest.md)
|
1334
1340
|
- [UltracartClient::RegisterAffiliateClickResponse](docs/RegisterAffiliateClickResponse.md)
|
1341
|
+
- [UltracartClient::ReplaceOrderItemIdRequest](docs/ReplaceOrderItemIdRequest.md)
|
1335
1342
|
- [UltracartClient::Report](docs/Report.md)
|
1336
1343
|
- [UltracartClient::ReportAuth](docs/ReportAuth.md)
|
1337
1344
|
- [UltracartClient::ReportAuthResponse](docs/ReportAuthResponse.md)
|
@@ -1570,6 +1577,7 @@ Not every change is committed to every SDK.
|
|
1570
1577
|
|
1571
1578
|
| Version | Date | Comments |
|
1572
1579
|
| --: | :-: | --- |
|
1580
|
+
| 3.11.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
|
1573
1581
|
| 3.11.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
|
1574
1582
|
| 3.11.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
|
1575
1583
|
| 3.11.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**opt_in** | **BOOLEAN** | True if they have opted into custom reports | [optional]
|
11
11
|
**opt_in_by_user** | **String** | User that opted into custom reporting | [optional]
|
12
12
|
**opt_in_date** | **String** | Date/time that custom reporting was opted in to | [optional]
|
13
|
+
**read_only** | **BOOLEAN** | | [optional]
|
13
14
|
**sql_budget** | **Float** | | [optional]
|
14
15
|
**sql_usage** | **Float** | | [optional]
|
15
16
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::CustomReportAnalysisResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**html** | **String** | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# UltracartClient::CustomReportChartPngUploadResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**signed_download_url** | **String** | | [optional]
|
9
|
+
**signed_upload_url** | **String** | | [optional]
|
10
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
11
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
12
|
+
|
13
|
+
|
data/docs/DatawarehouseApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**analyze_custom_report**](DatawarehouseApi.md#analyze_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/analysis | Analyze a custom report
|
7
8
|
[**delete_custom_dashboard**](DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
|
8
9
|
[**delete_custom_dashboard_schedule**](DatawarehouseApi.md#delete_custom_dashboard_schedule) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Delete a custom dashboard schedule
|
9
10
|
[**delete_custom_report**](DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
|
@@ -17,6 +18,7 @@ Method | HTTP request | Description
|
|
17
18
|
[**get_custom_dashboards**](DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
|
18
19
|
[**get_custom_report**](DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
|
19
20
|
[**get_custom_report_account_config**](DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration
|
21
|
+
[**get_custom_report_chart_png_upload_url**](DatawarehouseApi.md#get_custom_report_chart_png_upload_url) | **GET** /datawarehouse/custom_reports/{custom_report_oid}/chart_png | Upload a PNG of a custom report chart
|
20
22
|
[**get_custom_reports**](DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports
|
21
23
|
[**get_report**](DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
|
22
24
|
[**get_report_data_set**](DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
|
@@ -34,6 +36,59 @@ Method | HTTP request | Description
|
|
34
36
|
[**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
|
35
37
|
|
36
38
|
|
39
|
+
# **analyze_custom_report**
|
40
|
+
> CustomReportAnalysisResponse analyze_custom_report(analyze_request, custom_report_oid)
|
41
|
+
|
42
|
+
Analyze a custom report
|
43
|
+
|
44
|
+
Analyze a custom report on the UltraCart account.
|
45
|
+
|
46
|
+
### Example
|
47
|
+
```ruby
|
48
|
+
# load the gem
|
49
|
+
require 'ultracart_api'
|
50
|
+
|
51
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
52
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
53
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
54
|
+
|
55
|
+
|
56
|
+
analyze_request = UltracartClient::CustomReportAnalysisRequest.new # CustomReportAnalysisRequest | Request to analyze custom report
|
57
|
+
|
58
|
+
custom_report_oid = 56 # Integer | The report oid to analyze.
|
59
|
+
|
60
|
+
|
61
|
+
begin
|
62
|
+
#Analyze a custom report
|
63
|
+
result = api_instance.analyze_custom_report(analyze_request, custom_report_oid)
|
64
|
+
p result
|
65
|
+
rescue UltracartClient::ApiError => e
|
66
|
+
puts "Exception when calling DatawarehouseApi->analyze_custom_report: #{e}"
|
67
|
+
end
|
68
|
+
```
|
69
|
+
|
70
|
+
### Parameters
|
71
|
+
|
72
|
+
Name | Type | Description | Notes
|
73
|
+
------------- | ------------- | ------------- | -------------
|
74
|
+
**analyze_request** | [**CustomReportAnalysisRequest**](CustomReportAnalysisRequest.md)| Request to analyze custom report |
|
75
|
+
**custom_report_oid** | **Integer**| The report oid to analyze. |
|
76
|
+
|
77
|
+
### Return type
|
78
|
+
|
79
|
+
[**CustomReportAnalysisResponse**](CustomReportAnalysisResponse.md)
|
80
|
+
|
81
|
+
### Authorization
|
82
|
+
|
83
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
84
|
+
|
85
|
+
### HTTP request headers
|
86
|
+
|
87
|
+
- **Content-Type**: application/json; charset=UTF-8
|
88
|
+
- **Accept**: application/json
|
89
|
+
|
90
|
+
|
91
|
+
|
37
92
|
# **delete_custom_dashboard**
|
38
93
|
> delete_custom_dashboard(custom_dashboard_oid)
|
39
94
|
|
@@ -675,6 +730,56 @@ This endpoint does not need any parameter.
|
|
675
730
|
|
676
731
|
|
677
732
|
|
733
|
+
# **get_custom_report_chart_png_upload_url**
|
734
|
+
> CustomReportChartPngUploadResponse get_custom_report_chart_png_upload_url(custom_report_oid)
|
735
|
+
|
736
|
+
Upload a PNG of a custom report chart
|
737
|
+
|
738
|
+
Upload a PNG of a custom report chart
|
739
|
+
|
740
|
+
### Example
|
741
|
+
```ruby
|
742
|
+
# load the gem
|
743
|
+
require 'ultracart_api'
|
744
|
+
|
745
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
746
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
747
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
748
|
+
|
749
|
+
|
750
|
+
custom_report_oid = 56 # Integer | The report oid to upload a chart PNG for.
|
751
|
+
|
752
|
+
|
753
|
+
begin
|
754
|
+
#Upload a PNG of a custom report chart
|
755
|
+
result = api_instance.get_custom_report_chart_png_upload_url(custom_report_oid)
|
756
|
+
p result
|
757
|
+
rescue UltracartClient::ApiError => e
|
758
|
+
puts "Exception when calling DatawarehouseApi->get_custom_report_chart_png_upload_url: #{e}"
|
759
|
+
end
|
760
|
+
```
|
761
|
+
|
762
|
+
### Parameters
|
763
|
+
|
764
|
+
Name | Type | Description | Notes
|
765
|
+
------------- | ------------- | ------------- | -------------
|
766
|
+
**custom_report_oid** | **Integer**| The report oid to upload a chart PNG for. |
|
767
|
+
|
768
|
+
### Return type
|
769
|
+
|
770
|
+
[**CustomReportChartPngUploadResponse**](CustomReportChartPngUploadResponse.md)
|
771
|
+
|
772
|
+
### Authorization
|
773
|
+
|
774
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
775
|
+
|
776
|
+
### HTTP request headers
|
777
|
+
|
778
|
+
- **Content-Type**: application/json; charset=UTF-8
|
779
|
+
- **Accept**: application/json
|
780
|
+
|
781
|
+
|
782
|
+
|
678
783
|
# **get_custom_reports**
|
679
784
|
> CustomReportsResponse get_custom_reports
|
680
785
|
|
data/docs/ItemTag.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**tag_type** | **String** |
|
6
|
+
**tag_type** | **String** | tag_type | [optional]
|
7
7
|
**tag_value** | **String** | tag_value | [optional]
|
8
8
|
|
9
9
|
|
data/docs/OrderApi.md
CHANGED
@@ -26,6 +26,7 @@ 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
|
+
[**replace_order_item_merchant_item_id**](OrderApi.md#replace_order_item_merchant_item_id) | **PUT** /order/orders/{order_id}/replace_item_id | Replaces an order item id
|
29
30
|
[**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
|
30
31
|
[**resend_receipt**](OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
|
31
32
|
[**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
|
@@ -1265,6 +1266,63 @@ Name | Type | Description | Notes
|
|
1265
1266
|
|
1266
1267
|
|
1267
1268
|
|
1269
|
+
# **replace_order_item_merchant_item_id**
|
1270
|
+
> OrderResponse replace_order_item_merchant_item_id(replace_order_item_id_request, order_id, opts)
|
1271
|
+
|
1272
|
+
Replaces an order item id
|
1273
|
+
|
1274
|
+
Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
|
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
|
+
replace_order_item_id_request = UltracartClient::ReplaceOrderItemIdRequest.new # ReplaceOrderItemIdRequest | Replacement Request
|
1287
|
+
|
1288
|
+
order_id = 'order_id_example' # String | The order id to update.
|
1289
|
+
|
1290
|
+
opts = {
|
1291
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
1292
|
+
}
|
1293
|
+
|
1294
|
+
begin
|
1295
|
+
#Replaces an order item id
|
1296
|
+
result = api_instance.replace_order_item_merchant_item_id(replace_order_item_id_request, order_id, opts)
|
1297
|
+
p result
|
1298
|
+
rescue UltracartClient::ApiError => e
|
1299
|
+
puts "Exception when calling OrderApi->replace_order_item_merchant_item_id: #{e}"
|
1300
|
+
end
|
1301
|
+
```
|
1302
|
+
|
1303
|
+
### Parameters
|
1304
|
+
|
1305
|
+
Name | Type | Description | Notes
|
1306
|
+
------------- | ------------- | ------------- | -------------
|
1307
|
+
**replace_order_item_id_request** | [**ReplaceOrderItemIdRequest**](ReplaceOrderItemIdRequest.md)| Replacement Request |
|
1308
|
+
**order_id** | **String**| The order id to update. |
|
1309
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
1310
|
+
|
1311
|
+
### Return type
|
1312
|
+
|
1313
|
+
[**OrderResponse**](OrderResponse.md)
|
1314
|
+
|
1315
|
+
### Authorization
|
1316
|
+
|
1317
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1318
|
+
|
1319
|
+
### HTTP request headers
|
1320
|
+
|
1321
|
+
- **Content-Type**: application/json; charset=UTF-8
|
1322
|
+
- **Accept**: application/json
|
1323
|
+
|
1324
|
+
|
1325
|
+
|
1268
1326
|
# **replacement**
|
1269
1327
|
> OrderReplacementResponse replacement(order_id, replacement)
|
1270
1328
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::ReplaceOrderItemIdRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**item_index** | **Integer** | Index of the item on the order (one based index) | [optional]
|
7
|
+
**merchant_item_id** | **String** | Item ID | [optional]
|
8
|
+
**order_id** | **String** | Order ID | [optional]
|
9
|
+
**replacement_merchant_item_id** | **String** | Replacement Item ID | [optional]
|
10
|
+
|
11
|
+
|
@@ -32,6 +32,67 @@ module UltracartClient
|
|
32
32
|
UltracartClient::DatawarehouseApi.new(api_client)
|
33
33
|
end
|
34
34
|
|
35
|
+
# Analyze a custom report
|
36
|
+
# Analyze a custom report on the UltraCart account.
|
37
|
+
# @param analyze_request Request to analyze custom report
|
38
|
+
# @param custom_report_oid The report oid to analyze.
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [CustomReportAnalysisResponse]
|
41
|
+
def analyze_custom_report(analyze_request, custom_report_oid, opts = {})
|
42
|
+
data, _status_code, _headers = analyze_custom_report_with_http_info(analyze_request, custom_report_oid, opts)
|
43
|
+
data
|
44
|
+
end
|
45
|
+
|
46
|
+
# Analyze a custom report
|
47
|
+
# Analyze a custom report on the UltraCart account.
|
48
|
+
# @param analyze_request Request to analyze custom report
|
49
|
+
# @param custom_report_oid The report oid to analyze.
|
50
|
+
# @param [Hash] opts the optional parameters
|
51
|
+
# @return [Array<(CustomReportAnalysisResponse, Fixnum, Hash)>] CustomReportAnalysisResponse data, response status code and response headers
|
52
|
+
def analyze_custom_report_with_http_info(analyze_request, custom_report_oid, opts = {})
|
53
|
+
if @api_client.config.debugging
|
54
|
+
@api_client.config.logger.debug 'Calling API: DatawarehouseApi.analyze_custom_report ...'
|
55
|
+
end
|
56
|
+
# verify the required parameter 'analyze_request' is set
|
57
|
+
if @api_client.config.client_side_validation && analyze_request.nil?
|
58
|
+
fail ArgumentError, "Missing the required parameter 'analyze_request' when calling DatawarehouseApi.analyze_custom_report"
|
59
|
+
end
|
60
|
+
# verify the required parameter 'custom_report_oid' is set
|
61
|
+
if @api_client.config.client_side_validation && custom_report_oid.nil?
|
62
|
+
fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.analyze_custom_report"
|
63
|
+
end
|
64
|
+
# resource path
|
65
|
+
local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}/analysis'.sub('{' + 'custom_report_oid' + '}', custom_report_oid.to_s)
|
66
|
+
|
67
|
+
# query parameters
|
68
|
+
query_params = {}
|
69
|
+
|
70
|
+
# header parameters
|
71
|
+
header_params = {}
|
72
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
73
|
+
# HTTP header 'Accept' (if needed)
|
74
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
75
|
+
# HTTP header 'Content-Type'
|
76
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
77
|
+
|
78
|
+
# form parameters
|
79
|
+
form_params = {}
|
80
|
+
|
81
|
+
# http body (model)
|
82
|
+
post_body = @api_client.object_to_http_body(analyze_request)
|
83
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
84
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
85
|
+
:header_params => header_params,
|
86
|
+
:query_params => query_params,
|
87
|
+
:form_params => form_params,
|
88
|
+
:body => post_body,
|
89
|
+
:auth_names => auth_names,
|
90
|
+
:return_type => 'CustomReportAnalysisResponse')
|
91
|
+
if @api_client.config.debugging
|
92
|
+
@api_client.config.logger.debug "API called: DatawarehouseApi#analyze_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
93
|
+
end
|
94
|
+
return data, status_code, headers
|
95
|
+
end
|
35
96
|
# Delete a custom dashboard
|
36
97
|
# Delete a custom dashboard on the UltraCart account.
|
37
98
|
# @param custom_dashboard_oid The dashboard oid to delete.
|
@@ -742,6 +803,61 @@ module UltracartClient
|
|
742
803
|
end
|
743
804
|
return data, status_code, headers
|
744
805
|
end
|
806
|
+
# Upload a PNG of a custom report chart
|
807
|
+
# Upload a PNG of a custom report chart
|
808
|
+
# @param custom_report_oid The report oid to upload a chart PNG for.
|
809
|
+
# @param [Hash] opts the optional parameters
|
810
|
+
# @return [CustomReportChartPngUploadResponse]
|
811
|
+
def get_custom_report_chart_png_upload_url(custom_report_oid, opts = {})
|
812
|
+
data, _status_code, _headers = get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid, opts)
|
813
|
+
data
|
814
|
+
end
|
815
|
+
|
816
|
+
# Upload a PNG of a custom report chart
|
817
|
+
# Upload a PNG of a custom report chart
|
818
|
+
# @param custom_report_oid The report oid to upload a chart PNG for.
|
819
|
+
# @param [Hash] opts the optional parameters
|
820
|
+
# @return [Array<(CustomReportChartPngUploadResponse, Fixnum, Hash)>] CustomReportChartPngUploadResponse data, response status code and response headers
|
821
|
+
def get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid, opts = {})
|
822
|
+
if @api_client.config.debugging
|
823
|
+
@api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_report_chart_png_upload_url ...'
|
824
|
+
end
|
825
|
+
# verify the required parameter 'custom_report_oid' is set
|
826
|
+
if @api_client.config.client_side_validation && custom_report_oid.nil?
|
827
|
+
fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.get_custom_report_chart_png_upload_url"
|
828
|
+
end
|
829
|
+
# resource path
|
830
|
+
local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}/chart_png'.sub('{' + 'custom_report_oid' + '}', custom_report_oid.to_s)
|
831
|
+
|
832
|
+
# query parameters
|
833
|
+
query_params = {}
|
834
|
+
|
835
|
+
# header parameters
|
836
|
+
header_params = {}
|
837
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
838
|
+
# HTTP header 'Accept' (if needed)
|
839
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
840
|
+
# HTTP header 'Content-Type'
|
841
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
842
|
+
|
843
|
+
# form parameters
|
844
|
+
form_params = {}
|
845
|
+
|
846
|
+
# http body (model)
|
847
|
+
post_body = nil
|
848
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
849
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
850
|
+
:header_params => header_params,
|
851
|
+
:query_params => query_params,
|
852
|
+
:form_params => form_params,
|
853
|
+
:body => post_body,
|
854
|
+
:auth_names => auth_names,
|
855
|
+
:return_type => 'CustomReportChartPngUploadResponse')
|
856
|
+
if @api_client.config.debugging
|
857
|
+
@api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_report_chart_png_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
858
|
+
end
|
859
|
+
return data, status_code, headers
|
860
|
+
end
|
745
861
|
# Get custom reports
|
746
862
|
# Retrieve a custom reports
|
747
863
|
# @param [Hash] opts the optional parameters
|
@@ -1411,6 +1411,70 @@ module UltracartClient
|
|
1411
1411
|
end
|
1412
1412
|
return data, status_code, headers
|
1413
1413
|
end
|
1414
|
+
# Replaces an order item id
|
1415
|
+
# Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
|
1416
|
+
# @param replace_order_item_id_request Replacement Request
|
1417
|
+
# @param order_id The order id to update.
|
1418
|
+
# @param [Hash] opts the optional parameters
|
1419
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
1420
|
+
# @return [OrderResponse]
|
1421
|
+
def replace_order_item_merchant_item_id(replace_order_item_id_request, order_id, opts = {})
|
1422
|
+
data, _status_code, _headers = replace_order_item_merchant_item_id_with_http_info(replace_order_item_id_request, order_id, opts)
|
1423
|
+
data
|
1424
|
+
end
|
1425
|
+
|
1426
|
+
# Replaces an order item id
|
1427
|
+
# Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
|
1428
|
+
# @param replace_order_item_id_request Replacement Request
|
1429
|
+
# @param order_id The order id to update.
|
1430
|
+
# @param [Hash] opts the optional parameters
|
1431
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
1432
|
+
# @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
|
1433
|
+
def replace_order_item_merchant_item_id_with_http_info(replace_order_item_id_request, order_id, opts = {})
|
1434
|
+
if @api_client.config.debugging
|
1435
|
+
@api_client.config.logger.debug 'Calling API: OrderApi.replace_order_item_merchant_item_id ...'
|
1436
|
+
end
|
1437
|
+
# verify the required parameter 'replace_order_item_id_request' is set
|
1438
|
+
if @api_client.config.client_side_validation && replace_order_item_id_request.nil?
|
1439
|
+
fail ArgumentError, "Missing the required parameter 'replace_order_item_id_request' when calling OrderApi.replace_order_item_merchant_item_id"
|
1440
|
+
end
|
1441
|
+
# verify the required parameter 'order_id' is set
|
1442
|
+
if @api_client.config.client_side_validation && order_id.nil?
|
1443
|
+
fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.replace_order_item_merchant_item_id"
|
1444
|
+
end
|
1445
|
+
# resource path
|
1446
|
+
local_var_path = '/order/orders/{order_id}/replace_item_id'.sub('{' + 'order_id' + '}', order_id.to_s)
|
1447
|
+
|
1448
|
+
# query parameters
|
1449
|
+
query_params = {}
|
1450
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
1451
|
+
|
1452
|
+
# header parameters
|
1453
|
+
header_params = {}
|
1454
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1455
|
+
# HTTP header 'Accept' (if needed)
|
1456
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1457
|
+
# HTTP header 'Content-Type'
|
1458
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
1459
|
+
|
1460
|
+
# form parameters
|
1461
|
+
form_params = {}
|
1462
|
+
|
1463
|
+
# http body (model)
|
1464
|
+
post_body = @api_client.object_to_http_body(replace_order_item_id_request)
|
1465
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1466
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1467
|
+
:header_params => header_params,
|
1468
|
+
:query_params => query_params,
|
1469
|
+
:form_params => form_params,
|
1470
|
+
:body => post_body,
|
1471
|
+
:auth_names => auth_names,
|
1472
|
+
:return_type => 'OrderResponse')
|
1473
|
+
if @api_client.config.debugging
|
1474
|
+
@api_client.config.logger.debug "API called: OrderApi#replace_order_item_merchant_item_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1475
|
+
end
|
1476
|
+
return data, status_code, headers
|
1477
|
+
end
|
1414
1478
|
# Replacement order
|
1415
1479
|
# Create a replacement order based upon a previous order
|
1416
1480
|
# @param order_id The order id to generate a replacement for.
|
@@ -33,6 +33,8 @@ module UltracartClient
|
|
33
33
|
# Date/time that custom reporting was opted in to
|
34
34
|
attr_accessor :opt_in_date
|
35
35
|
|
36
|
+
attr_accessor :read_only
|
37
|
+
|
36
38
|
attr_accessor :sql_budget
|
37
39
|
|
38
40
|
attr_accessor :sql_usage
|
@@ -47,6 +49,7 @@ module UltracartClient
|
|
47
49
|
:'opt_in' => :'opt_in',
|
48
50
|
:'opt_in_by_user' => :'opt_in_by_user',
|
49
51
|
:'opt_in_date' => :'opt_in_date',
|
52
|
+
:'read_only' => :'read_only',
|
50
53
|
:'sql_budget' => :'sql_budget',
|
51
54
|
:'sql_usage' => :'sql_usage'
|
52
55
|
}
|
@@ -62,6 +65,7 @@ module UltracartClient
|
|
62
65
|
:'opt_in' => :'BOOLEAN',
|
63
66
|
:'opt_in_by_user' => :'String',
|
64
67
|
:'opt_in_date' => :'String',
|
68
|
+
:'read_only' => :'BOOLEAN',
|
65
69
|
:'sql_budget' => :'Float',
|
66
70
|
:'sql_usage' => :'Float'
|
67
71
|
}
|
@@ -103,6 +107,10 @@ module UltracartClient
|
|
103
107
|
self.opt_in_date = attributes[:'opt_in_date']
|
104
108
|
end
|
105
109
|
|
110
|
+
if attributes.has_key?(:'read_only')
|
111
|
+
self.read_only = attributes[:'read_only']
|
112
|
+
end
|
113
|
+
|
106
114
|
if attributes.has_key?(:'sql_budget')
|
107
115
|
self.sql_budget = attributes[:'sql_budget']
|
108
116
|
end
|
@@ -137,6 +145,7 @@ module UltracartClient
|
|
137
145
|
opt_in == o.opt_in &&
|
138
146
|
opt_in_by_user == o.opt_in_by_user &&
|
139
147
|
opt_in_date == o.opt_in_date &&
|
148
|
+
read_only == o.read_only &&
|
140
149
|
sql_budget == o.sql_budget &&
|
141
150
|
sql_usage == o.sql_usage
|
142
151
|
end
|
@@ -150,7 +159,7 @@ module UltracartClient
|
|
150
159
|
# Calculates hash code according to all attributes.
|
151
160
|
# @return [Fixnum] Hash code
|
152
161
|
def hash
|
153
|
-
[ai_budget, ai_usage, merchant_id, novice_sql_comments, opt_in, opt_in_by_user, opt_in_date, sql_budget, sql_usage].hash
|
162
|
+
[ai_budget, ai_usage, merchant_id, novice_sql_comments, opt_in, opt_in_by_user, opt_in_date, read_only, sql_budget, sql_usage].hash
|
154
163
|
end
|
155
164
|
|
156
165
|
# Builds the object from hash
|