ultracart_api 4.1.20 → 4.1.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 +10 -2
- data/docs/CustomReportAccountConfig.md +2 -0
- data/docs/CustomReportAnalysisRequest.md +20 -0
- data/docs/CustomReportAnalysisResponse.md +26 -0
- data/docs/CustomReportChartPngUploadResponse.md +28 -0
- data/docs/DatawarehouseApi.md +109 -0
- data/docs/ItemTag.md +1 -1
- data/docs/OrderApi.md +56 -0
- data/docs/ReplaceOrderItemIdRequest.md +24 -0
- data/lib/ultracart_api/api/datawarehouse_api.rb +139 -0
- data/lib/ultracart_api/api/order_api.rb +78 -0
- data/lib/ultracart_api/models/custom_report_account_config.rb +10 -1
- data/lib/ultracart_api/models/custom_report_analysis_request.rb +228 -0
- data/lib/ultracart_api/models/custom_report_analysis_response.rb +256 -0
- data/lib/ultracart_api/models/custom_report_chart_png_upload_response.rb +265 -0
- data/lib/ultracart_api/models/item_tag.rb +1 -1
- data/lib/ultracart_api/models/replace_order_item_id_request.rb +280 -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: a81555a84d9f7c6491053430ac98dd5168369622872b6aea0baa55a4041398b4
|
4
|
+
data.tar.gz: a0e067baf5005e9baba770d466e75f165153072002565f76297d93ea83a2a205
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c6b067c6e4e63dd5abc91be738a77231d6d8ca273c3a07f16b6b01ac33e5e173bba366f8ab68b7bbcf40dc48d1883c8a1fafe5cb47b1bc2f6873e3e56c6072e5
|
7
|
+
data.tar.gz: 0cc19e313437722ed16a70f1475ed4594d023174342567b4e7c7f784528b04240594305739161261445faae73a5cf5f1e571ea6ce5df165812ebb7dde19f064a
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 4.1.
|
10
|
+
- Package version: 4.1.21
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
13
13
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
16
16
|
gemfile:
|
17
17
|
|
18
18
|
```shell
|
19
|
-
gem 'ultracart_api', '4.1.
|
19
|
+
gem 'ultracart_api', '4.1.21'
|
20
20
|
```
|
21
21
|
|
22
22
|
install:
|
@@ -260,6 +260,7 @@ Class | Method | HTTP request | Description
|
|
260
260
|
*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
|
261
261
|
*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
|
262
262
|
*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
|
263
|
+
*UltracartClient::DatawarehouseApi* | [**analyze_custom_report**](docs/DatawarehouseApi.md#analyze_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/analysis | Analyze a custom report
|
263
264
|
*UltracartClient::DatawarehouseApi* | [**delete_custom_dashboard**](docs/DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
|
264
265
|
*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
|
265
266
|
*UltracartClient::DatawarehouseApi* | [**delete_custom_report**](docs/DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
|
@@ -273,6 +274,7 @@ Class | Method | HTTP request | Description
|
|
273
274
|
*UltracartClient::DatawarehouseApi* | [**get_custom_dashboards**](docs/DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
|
274
275
|
*UltracartClient::DatawarehouseApi* | [**get_custom_report**](docs/DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
|
275
276
|
*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
|
277
|
+
*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
|
276
278
|
*UltracartClient::DatawarehouseApi* | [**get_custom_reports**](docs/DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports
|
277
279
|
*UltracartClient::DatawarehouseApi* | [**get_report**](docs/DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
|
278
280
|
*UltracartClient::DatawarehouseApi* | [**get_report_data_set**](docs/DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
|
@@ -354,6 +356,7 @@ Class | Method | HTTP request | Description
|
|
354
356
|
*UltracartClient::OrderApi* | [**is_refundable_order**](docs/OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
|
355
357
|
*UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
|
356
358
|
*UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
|
359
|
+
*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
|
357
360
|
*UltracartClient::OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
|
358
361
|
*UltracartClient::OrderApi* | [**resend_receipt**](docs/OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
|
359
362
|
*UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
|
@@ -921,6 +924,9 @@ Class | Method | HTTP request | Description
|
|
921
924
|
- [UltracartClient::CustomReport](docs/CustomReport.md)
|
922
925
|
- [UltracartClient::CustomReportAccountConfig](docs/CustomReportAccountConfig.md)
|
923
926
|
- [UltracartClient::CustomReportAccountConfigResponse](docs/CustomReportAccountConfigResponse.md)
|
927
|
+
- [UltracartClient::CustomReportAnalysisRequest](docs/CustomReportAnalysisRequest.md)
|
928
|
+
- [UltracartClient::CustomReportAnalysisResponse](docs/CustomReportAnalysisResponse.md)
|
929
|
+
- [UltracartClient::CustomReportChartPngUploadResponse](docs/CustomReportChartPngUploadResponse.md)
|
924
930
|
- [UltracartClient::CustomReportExecutionParameter](docs/CustomReportExecutionParameter.md)
|
925
931
|
- [UltracartClient::CustomReportExecutionRequest](docs/CustomReportExecutionRequest.md)
|
926
932
|
- [UltracartClient::CustomReportExecutionResponse](docs/CustomReportExecutionResponse.md)
|
@@ -1327,6 +1333,7 @@ Class | Method | HTTP request | Description
|
|
1327
1333
|
- [UltracartClient::PublishLibraryItemRequest](docs/PublishLibraryItemRequest.md)
|
1328
1334
|
- [UltracartClient::RegisterAffiliateClickRequest](docs/RegisterAffiliateClickRequest.md)
|
1329
1335
|
- [UltracartClient::RegisterAffiliateClickResponse](docs/RegisterAffiliateClickResponse.md)
|
1336
|
+
- [UltracartClient::ReplaceOrderItemIdRequest](docs/ReplaceOrderItemIdRequest.md)
|
1330
1337
|
- [UltracartClient::Report](docs/Report.md)
|
1331
1338
|
- [UltracartClient::ReportAuth](docs/ReportAuth.md)
|
1332
1339
|
- [UltracartClient::ReportAuthResponse](docs/ReportAuthResponse.md)
|
@@ -1568,6 +1575,7 @@ Not every change is committed to every SDK.
|
|
1568
1575
|
|
1569
1576
|
| Version | Date | Comments |
|
1570
1577
|
| --: | :-: | --- |
|
1578
|
+
| 4.1.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
|
1571
1579
|
| 4.1.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
|
1572
1580
|
| 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
|
1573
1581
|
| 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
|
@@ -11,6 +11,7 @@
|
|
11
11
|
| **opt_in** | **Boolean** | True if they have opted into custom reports | [optional] |
|
12
12
|
| **opt_in_by_user** | **String** | User that opted into custom reporting | [optional] |
|
13
13
|
| **opt_in_date** | **String** | Date/time that custom reporting was opted in to | [optional] |
|
14
|
+
| **read_only** | **Boolean** | | [optional] |
|
14
15
|
| **sql_budget** | **Float** | | [optional] |
|
15
16
|
| **sql_usage** | **Float** | | [optional] |
|
16
17
|
|
@@ -27,6 +28,7 @@ instance = UltracartClient::CustomReportAccountConfig.new(
|
|
27
28
|
opt_in: null,
|
28
29
|
opt_in_by_user: null,
|
29
30
|
opt_in_date: null,
|
31
|
+
read_only: null,
|
30
32
|
sql_budget: null,
|
31
33
|
sql_usage: null
|
32
34
|
)
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::CustomReportAnalysisRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **png_url** | **String** | | [optional] |
|
8
|
+
| **result_url** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::CustomReportAnalysisRequest.new(
|
16
|
+
png_url: null,
|
17
|
+
result_url: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::CustomReportAnalysisResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **html** | **String** | | [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::CustomReportAnalysisResponse.new(
|
19
|
+
error: null,
|
20
|
+
html: null,
|
21
|
+
metadata: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# UltracartClient::CustomReportChartPngUploadResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **signed_download_url** | **String** | | [optional] |
|
10
|
+
| **signed_upload_url** | **String** | | [optional] |
|
11
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
12
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'ultracart_api'
|
18
|
+
|
19
|
+
instance = UltracartClient::CustomReportChartPngUploadResponse.new(
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
signed_download_url: null,
|
23
|
+
signed_upload_url: null,
|
24
|
+
success: null,
|
25
|
+
warning: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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,60 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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
|
+
|
41
|
+
> <CustomReportAnalysisResponse> analyze_custom_report(custom_report_oid, analyze_request)
|
42
|
+
|
43
|
+
Analyze a custom report
|
44
|
+
|
45
|
+
Analyze a custom report on the UltraCart account.
|
46
|
+
|
47
|
+
|
48
|
+
### Examples
|
49
|
+
|
50
|
+
|
51
|
+
(No example for this operation).
|
52
|
+
|
53
|
+
|
54
|
+
#### Using the analyze_custom_report_with_http_info variant
|
55
|
+
|
56
|
+
This returns an Array which contains the response data, status code and headers.
|
57
|
+
|
58
|
+
> <Array(<CustomReportAnalysisResponse>, Integer, Hash)> analyze_custom_report_with_http_info(custom_report_oid, analyze_request)
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
begin
|
62
|
+
# Analyze a custom report
|
63
|
+
data, status_code, headers = api_instance.analyze_custom_report_with_http_info(custom_report_oid, analyze_request)
|
64
|
+
p status_code # => 2xx
|
65
|
+
p headers # => { ... }
|
66
|
+
p data # => <CustomReportAnalysisResponse>
|
67
|
+
rescue UltracartClient::ApiError => e
|
68
|
+
puts "Error when calling DatawarehouseApi->analyze_custom_report_with_http_info: #{e}"
|
69
|
+
end
|
70
|
+
```
|
71
|
+
|
72
|
+
### Parameters
|
73
|
+
|
74
|
+
| Name | Type | Description | Notes |
|
75
|
+
| ---- | ---- | ----------- | ----- |
|
76
|
+
| **custom_report_oid** | **Integer** | The report oid to analyze. | |
|
77
|
+
| **analyze_request** | [**CustomReportAnalysisRequest**](CustomReportAnalysisRequest.md) | Request to analyze custom report | |
|
78
|
+
|
79
|
+
### Return type
|
80
|
+
|
81
|
+
[**CustomReportAnalysisResponse**](CustomReportAnalysisResponse.md)
|
82
|
+
|
83
|
+
### Authorization
|
84
|
+
|
85
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
86
|
+
|
87
|
+
### HTTP request headers
|
88
|
+
|
89
|
+
- **Content-Type**: application/json; charset=UTF-8
|
90
|
+
- **Accept**: application/json
|
91
|
+
|
92
|
+
|
37
93
|
## delete_custom_dashboard
|
38
94
|
|
39
95
|
> delete_custom_dashboard(custom_dashboard_oid)
|
@@ -724,6 +780,59 @@ This endpoint does not need any parameter.
|
|
724
780
|
- **Accept**: application/json
|
725
781
|
|
726
782
|
|
783
|
+
## get_custom_report_chart_png_upload_url
|
784
|
+
|
785
|
+
> <CustomReportChartPngUploadResponse> get_custom_report_chart_png_upload_url(custom_report_oid)
|
786
|
+
|
787
|
+
Upload a PNG of a custom report chart
|
788
|
+
|
789
|
+
Upload a PNG of a custom report chart
|
790
|
+
|
791
|
+
|
792
|
+
### Examples
|
793
|
+
|
794
|
+
|
795
|
+
(No example for this operation).
|
796
|
+
|
797
|
+
|
798
|
+
#### Using the get_custom_report_chart_png_upload_url_with_http_info variant
|
799
|
+
|
800
|
+
This returns an Array which contains the response data, status code and headers.
|
801
|
+
|
802
|
+
> <Array(<CustomReportChartPngUploadResponse>, Integer, Hash)> get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid)
|
803
|
+
|
804
|
+
```ruby
|
805
|
+
begin
|
806
|
+
# Upload a PNG of a custom report chart
|
807
|
+
data, status_code, headers = api_instance.get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid)
|
808
|
+
p status_code # => 2xx
|
809
|
+
p headers # => { ... }
|
810
|
+
p data # => <CustomReportChartPngUploadResponse>
|
811
|
+
rescue UltracartClient::ApiError => e
|
812
|
+
puts "Error when calling DatawarehouseApi->get_custom_report_chart_png_upload_url_with_http_info: #{e}"
|
813
|
+
end
|
814
|
+
```
|
815
|
+
|
816
|
+
### Parameters
|
817
|
+
|
818
|
+
| Name | Type | Description | Notes |
|
819
|
+
| ---- | ---- | ----------- | ----- |
|
820
|
+
| **custom_report_oid** | **Integer** | The report oid to upload a chart PNG for. | |
|
821
|
+
|
822
|
+
### Return type
|
823
|
+
|
824
|
+
[**CustomReportChartPngUploadResponse**](CustomReportChartPngUploadResponse.md)
|
825
|
+
|
826
|
+
### Authorization
|
827
|
+
|
828
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
829
|
+
|
830
|
+
### HTTP request headers
|
831
|
+
|
832
|
+
- **Content-Type**: Not defined
|
833
|
+
- **Accept**: application/json
|
834
|
+
|
835
|
+
|
727
836
|
## get_custom_reports
|
728
837
|
|
729
838
|
> <CustomReportsResponse> get_custom_reports
|
data/docs/ItemTag.md
CHANGED
data/docs/OrderApi.md
CHANGED
@@ -26,6 +26,7 @@ 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
|
+
| [**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 |
|
@@ -2280,6 +2281,61 @@ end
|
|
2280
2281
|
- **Accept**: application/json
|
2281
2282
|
|
2282
2283
|
|
2284
|
+
## replace_order_item_merchant_item_id
|
2285
|
+
|
2286
|
+
> <OrderResponse> replace_order_item_merchant_item_id(order_id, replace_order_item_id_request, opts)
|
2287
|
+
|
2288
|
+
Replaces an order item id
|
2289
|
+
|
2290
|
+
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.
|
2291
|
+
|
2292
|
+
|
2293
|
+
### Examples
|
2294
|
+
|
2295
|
+
|
2296
|
+
(No example for this operation).
|
2297
|
+
|
2298
|
+
|
2299
|
+
#### Using the replace_order_item_merchant_item_id_with_http_info variant
|
2300
|
+
|
2301
|
+
This returns an Array which contains the response data, status code and headers.
|
2302
|
+
|
2303
|
+
> <Array(<OrderResponse>, Integer, Hash)> replace_order_item_merchant_item_id_with_http_info(order_id, replace_order_item_id_request, opts)
|
2304
|
+
|
2305
|
+
```ruby
|
2306
|
+
begin
|
2307
|
+
# Replaces an order item id
|
2308
|
+
data, status_code, headers = api_instance.replace_order_item_merchant_item_id_with_http_info(order_id, replace_order_item_id_request, opts)
|
2309
|
+
p status_code # => 2xx
|
2310
|
+
p headers # => { ... }
|
2311
|
+
p data # => <OrderResponse>
|
2312
|
+
rescue UltracartClient::ApiError => e
|
2313
|
+
puts "Error when calling OrderApi->replace_order_item_merchant_item_id_with_http_info: #{e}"
|
2314
|
+
end
|
2315
|
+
```
|
2316
|
+
|
2317
|
+
### Parameters
|
2318
|
+
|
2319
|
+
| Name | Type | Description | Notes |
|
2320
|
+
| ---- | ---- | ----------- | ----- |
|
2321
|
+
| **order_id** | **String** | The order id to update. | |
|
2322
|
+
| **replace_order_item_id_request** | [**ReplaceOrderItemIdRequest**](ReplaceOrderItemIdRequest.md) | Replacement Request | |
|
2323
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
2324
|
+
|
2325
|
+
### Return type
|
2326
|
+
|
2327
|
+
[**OrderResponse**](OrderResponse.md)
|
2328
|
+
|
2329
|
+
### Authorization
|
2330
|
+
|
2331
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2332
|
+
|
2333
|
+
### HTTP request headers
|
2334
|
+
|
2335
|
+
- **Content-Type**: application/json; charset=UTF-8
|
2336
|
+
- **Accept**: application/json
|
2337
|
+
|
2338
|
+
|
2283
2339
|
## replacement
|
2284
2340
|
|
2285
2341
|
> <OrderReplacementResponse> replacement(order_id, replacement)
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# UltracartClient::ReplaceOrderItemIdRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **item_index** | **Integer** | Index of the item on the order (one based index) | [optional] |
|
8
|
+
| **merchant_item_id** | **String** | Item ID | [optional] |
|
9
|
+
| **order_id** | **String** | Order ID | [optional] |
|
10
|
+
| **replacement_merchant_item_id** | **String** | Replacement Item ID | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ultracart_api'
|
16
|
+
|
17
|
+
instance = UltracartClient::ReplaceOrderItemIdRequest.new(
|
18
|
+
item_index: null,
|
19
|
+
merchant_item_id: null,
|
20
|
+
order_id: null,
|
21
|
+
replacement_merchant_item_id: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -32,6 +32,81 @@ 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 custom_report_oid [Integer] The report oid to analyze.
|
38
|
+
# @param analyze_request [CustomReportAnalysisRequest] Request to analyze custom report
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [CustomReportAnalysisResponse]
|
41
|
+
def analyze_custom_report(custom_report_oid, analyze_request, opts = {})
|
42
|
+
data, _status_code, _headers = analyze_custom_report_with_http_info(custom_report_oid, analyze_request, opts)
|
43
|
+
data
|
44
|
+
end
|
45
|
+
|
46
|
+
# Analyze a custom report
|
47
|
+
# Analyze a custom report on the UltraCart account.
|
48
|
+
# @param custom_report_oid [Integer] The report oid to analyze.
|
49
|
+
# @param analyze_request [CustomReportAnalysisRequest] Request to analyze custom report
|
50
|
+
# @param [Hash] opts the optional parameters
|
51
|
+
# @return [Array<(CustomReportAnalysisResponse, Integer, Hash)>] CustomReportAnalysisResponse data, response status code and response headers
|
52
|
+
def analyze_custom_report_with_http_info(custom_report_oid, analyze_request, 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 'custom_report_oid' is set
|
57
|
+
if @api_client.config.client_side_validation && custom_report_oid.nil?
|
58
|
+
fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.analyze_custom_report"
|
59
|
+
end
|
60
|
+
# verify the required parameter 'analyze_request' is set
|
61
|
+
if @api_client.config.client_side_validation && analyze_request.nil?
|
62
|
+
fail ArgumentError, "Missing the required parameter 'analyze_request' 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' + '}', CGI.escape(custom_report_oid.to_s))
|
66
|
+
|
67
|
+
# query parameters
|
68
|
+
query_params = opts[:query_params] || {}
|
69
|
+
|
70
|
+
# header parameters
|
71
|
+
header_params = opts[: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
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
77
|
+
if !content_type.nil?
|
78
|
+
header_params['Content-Type'] = content_type
|
79
|
+
end
|
80
|
+
|
81
|
+
# form parameters
|
82
|
+
form_params = opts[:form_params] || {}
|
83
|
+
|
84
|
+
# http body (model)
|
85
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(analyze_request)
|
86
|
+
|
87
|
+
# return_type
|
88
|
+
return_type = opts[:debug_return_type] || 'CustomReportAnalysisResponse'
|
89
|
+
|
90
|
+
# auth_names
|
91
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
92
|
+
|
93
|
+
new_options = opts.merge(
|
94
|
+
:operation => :"DatawarehouseApi.analyze_custom_report",
|
95
|
+
:header_params => header_params,
|
96
|
+
:query_params => query_params,
|
97
|
+
:form_params => form_params,
|
98
|
+
:body => post_body,
|
99
|
+
:auth_names => auth_names,
|
100
|
+
:return_type => return_type
|
101
|
+
)
|
102
|
+
|
103
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
104
|
+
if @api_client.config.debugging
|
105
|
+
@api_client.config.logger.debug "API called: DatawarehouseApi#analyze_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
106
|
+
end
|
107
|
+
return data, status_code, headers
|
108
|
+
end
|
109
|
+
|
35
110
|
# Delete a custom dashboard
|
36
111
|
# Delete a custom dashboard on the UltraCart account.
|
37
112
|
# @param custom_dashboard_oid [Integer] The dashboard oid to delete.
|
@@ -884,6 +959,70 @@ module UltracartClient
|
|
884
959
|
return data, status_code, headers
|
885
960
|
end
|
886
961
|
|
962
|
+
# Upload a PNG of a custom report chart
|
963
|
+
# Upload a PNG of a custom report chart
|
964
|
+
# @param custom_report_oid [Integer] The report oid to upload a chart PNG for.
|
965
|
+
# @param [Hash] opts the optional parameters
|
966
|
+
# @return [CustomReportChartPngUploadResponse]
|
967
|
+
def get_custom_report_chart_png_upload_url(custom_report_oid, opts = {})
|
968
|
+
data, _status_code, _headers = get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid, opts)
|
969
|
+
data
|
970
|
+
end
|
971
|
+
|
972
|
+
# Upload a PNG of a custom report chart
|
973
|
+
# Upload a PNG of a custom report chart
|
974
|
+
# @param custom_report_oid [Integer] The report oid to upload a chart PNG for.
|
975
|
+
# @param [Hash] opts the optional parameters
|
976
|
+
# @return [Array<(CustomReportChartPngUploadResponse, Integer, Hash)>] CustomReportChartPngUploadResponse data, response status code and response headers
|
977
|
+
def get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid, opts = {})
|
978
|
+
if @api_client.config.debugging
|
979
|
+
@api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_report_chart_png_upload_url ...'
|
980
|
+
end
|
981
|
+
# verify the required parameter 'custom_report_oid' is set
|
982
|
+
if @api_client.config.client_side_validation && custom_report_oid.nil?
|
983
|
+
fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.get_custom_report_chart_png_upload_url"
|
984
|
+
end
|
985
|
+
# resource path
|
986
|
+
local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}/chart_png'.sub('{' + 'custom_report_oid' + '}', CGI.escape(custom_report_oid.to_s))
|
987
|
+
|
988
|
+
# query parameters
|
989
|
+
query_params = opts[:query_params] || {}
|
990
|
+
|
991
|
+
# header parameters
|
992
|
+
header_params = opts[:header_params] || {}
|
993
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
994
|
+
# HTTP header 'Accept' (if needed)
|
995
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
996
|
+
|
997
|
+
# form parameters
|
998
|
+
form_params = opts[:form_params] || {}
|
999
|
+
|
1000
|
+
# http body (model)
|
1001
|
+
post_body = opts[:debug_body]
|
1002
|
+
|
1003
|
+
# return_type
|
1004
|
+
return_type = opts[:debug_return_type] || 'CustomReportChartPngUploadResponse'
|
1005
|
+
|
1006
|
+
# auth_names
|
1007
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1008
|
+
|
1009
|
+
new_options = opts.merge(
|
1010
|
+
:operation => :"DatawarehouseApi.get_custom_report_chart_png_upload_url",
|
1011
|
+
:header_params => header_params,
|
1012
|
+
:query_params => query_params,
|
1013
|
+
:form_params => form_params,
|
1014
|
+
:body => post_body,
|
1015
|
+
:auth_names => auth_names,
|
1016
|
+
:return_type => return_type
|
1017
|
+
)
|
1018
|
+
|
1019
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1020
|
+
if @api_client.config.debugging
|
1021
|
+
@api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_report_chart_png_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1022
|
+
end
|
1023
|
+
return data, status_code, headers
|
1024
|
+
end
|
1025
|
+
|
887
1026
|
# Get custom reports
|
888
1027
|
# Retrieve a custom reports
|
889
1028
|
# @param [Hash] opts the optional parameters
|
@@ -1646,6 +1646,84 @@ module UltracartClient
|
|
1646
1646
|
return data, status_code, headers
|
1647
1647
|
end
|
1648
1648
|
|
1649
|
+
# Replaces an order item id
|
1650
|
+
# 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.
|
1651
|
+
# @param order_id [String] The order id to update.
|
1652
|
+
# @param replace_order_item_id_request [ReplaceOrderItemIdRequest] Replacement Request
|
1653
|
+
# @param [Hash] opts the optional parameters
|
1654
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
1655
|
+
# @return [OrderResponse]
|
1656
|
+
def replace_order_item_merchant_item_id(order_id, replace_order_item_id_request, opts = {})
|
1657
|
+
data, _status_code, _headers = replace_order_item_merchant_item_id_with_http_info(order_id, replace_order_item_id_request, opts)
|
1658
|
+
data
|
1659
|
+
end
|
1660
|
+
|
1661
|
+
# Replaces an order item id
|
1662
|
+
# 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.
|
1663
|
+
# @param order_id [String] The order id to update.
|
1664
|
+
# @param replace_order_item_id_request [ReplaceOrderItemIdRequest] Replacement Request
|
1665
|
+
# @param [Hash] opts the optional parameters
|
1666
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
1667
|
+
# @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
|
1668
|
+
def replace_order_item_merchant_item_id_with_http_info(order_id, replace_order_item_id_request, opts = {})
|
1669
|
+
if @api_client.config.debugging
|
1670
|
+
@api_client.config.logger.debug 'Calling API: OrderApi.replace_order_item_merchant_item_id ...'
|
1671
|
+
end
|
1672
|
+
# verify the required parameter 'order_id' is set
|
1673
|
+
if @api_client.config.client_side_validation && order_id.nil?
|
1674
|
+
fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.replace_order_item_merchant_item_id"
|
1675
|
+
end
|
1676
|
+
# verify the required parameter 'replace_order_item_id_request' is set
|
1677
|
+
if @api_client.config.client_side_validation && replace_order_item_id_request.nil?
|
1678
|
+
fail ArgumentError, "Missing the required parameter 'replace_order_item_id_request' when calling OrderApi.replace_order_item_merchant_item_id"
|
1679
|
+
end
|
1680
|
+
# resource path
|
1681
|
+
local_var_path = '/order/orders/{order_id}/replace_item_id'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
|
1682
|
+
|
1683
|
+
# query parameters
|
1684
|
+
query_params = opts[:query_params] || {}
|
1685
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
1686
|
+
|
1687
|
+
# header parameters
|
1688
|
+
header_params = opts[:header_params] || {}
|
1689
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1690
|
+
# HTTP header 'Accept' (if needed)
|
1691
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1692
|
+
# HTTP header 'Content-Type'
|
1693
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
1694
|
+
if !content_type.nil?
|
1695
|
+
header_params['Content-Type'] = content_type
|
1696
|
+
end
|
1697
|
+
|
1698
|
+
# form parameters
|
1699
|
+
form_params = opts[:form_params] || {}
|
1700
|
+
|
1701
|
+
# http body (model)
|
1702
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(replace_order_item_id_request)
|
1703
|
+
|
1704
|
+
# return_type
|
1705
|
+
return_type = opts[:debug_return_type] || 'OrderResponse'
|
1706
|
+
|
1707
|
+
# auth_names
|
1708
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1709
|
+
|
1710
|
+
new_options = opts.merge(
|
1711
|
+
:operation => :"OrderApi.replace_order_item_merchant_item_id",
|
1712
|
+
:header_params => header_params,
|
1713
|
+
:query_params => query_params,
|
1714
|
+
:form_params => form_params,
|
1715
|
+
:body => post_body,
|
1716
|
+
:auth_names => auth_names,
|
1717
|
+
:return_type => return_type
|
1718
|
+
)
|
1719
|
+
|
1720
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
1721
|
+
if @api_client.config.debugging
|
1722
|
+
@api_client.config.logger.debug "API called: OrderApi#replace_order_item_merchant_item_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1723
|
+
end
|
1724
|
+
return data, status_code, headers
|
1725
|
+
end
|
1726
|
+
|
1649
1727
|
# Replacement order
|
1650
1728
|
# Create a replacement order based upon a previous order
|
1651
1729
|
# @param order_id [String] The order id to generate a replacement for.
|