ultracart_api 4.1.86 → 4.1.88
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 +15 -2
- data/docs/AutoOrder.md +2 -0
- data/docs/AutoOrderApi.md +54 -0
- data/docs/AutoOrderEmail.md +54 -0
- data/docs/AutoOrderEmailsResponse.md +26 -0
- data/docs/Order.md +2 -0
- data/docs/OrderApi.md +108 -0
- data/docs/OrderEmail.md +54 -0
- data/docs/OrderEmailsResponse.md +26 -0
- data/docs/OrderPageView.md +26 -0
- data/docs/OrderPageViewHistoryResponse.md +28 -0
- data/docs/OrderPageViewMetaData.md +20 -0
- data/docs/OrderPageViewParam.md +20 -0
- data/lib/ultracart_api/api/auto_order_api.rb +64 -0
- data/lib/ultracart_api/api/order_api.rb +128 -0
- data/lib/ultracart_api/models/auto_order.rb +13 -1
- data/lib/ultracart_api/models/auto_order_email.rb +402 -0
- data/lib/ultracart_api/models/auto_order_emails_response.rb +259 -0
- data/lib/ultracart_api/models/order.rb +13 -1
- data/lib/ultracart_api/models/order_email.rb +402 -0
- data/lib/ultracart_api/models/order_emails_response.rb +259 -0
- data/lib/ultracart_api/models/order_page_view.rb +264 -0
- data/lib/ultracart_api/models/order_page_view_history_response.rb +269 -0
- data/lib/ultracart_api/models/order_page_view_meta_data.rb +230 -0
- data/lib/ultracart_api/models/order_page_view_param.rb +230 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +8 -0
- metadata +18 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: efaed1b31d103f12d7258eae8733cb3a28e9c0f41de39ebce07c499cf266ef6c
|
|
4
|
+
data.tar.gz: b691f33913b5f6a6582ce264ab4b52cd97c080cedfb6ed162f558ea5db9fd6c4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1a1dd42c639e6b0d2ad68b48aabae53b1d5c6b4b62d0e60d3b0e6920c736ec0a97daf8131c8e11c49c613ac77014efe308a4c88c2ad0c780b84ddc459efb99f5
|
|
7
|
+
data.tar.gz: bfe67f849bb4fe24ba696f571c151c28fb332612ebeb86e131f4e574c87450018ca281dcad7b37a77c05ee98e4bdd92b492ed25c6da9a60bd1758afecac1d9da
|
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.88
|
|
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.88'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -90,6 +90,7 @@ Class | Method | HTTP request | Description
|
|
|
90
90
|
*UltracartClient::AutoOrderApi* | [**get_auto_order**](docs/AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid
|
|
91
91
|
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_code**](docs/AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code
|
|
92
92
|
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id
|
|
93
|
+
*UltracartClient::AutoOrderApi* | [**get_auto_order_emails**](docs/AutoOrderApi.md#get_auto_order_emails) | **GET** /auto_order/auto_orders/{auto_order_oid}/emails | Retrieve email delivery information for this auto order.
|
|
93
94
|
*UltracartClient::AutoOrderApi* | [**get_auto_orders**](docs/AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders
|
|
94
95
|
*UltracartClient::AutoOrderApi* | [**get_auto_orders_batch**](docs/AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch
|
|
95
96
|
*UltracartClient::AutoOrderApi* | [**get_auto_orders_by_query**](docs/AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
|
|
@@ -420,6 +421,8 @@ Class | Method | HTTP request | Description
|
|
|
420
421
|
*UltracartClient::OrderApi* | [**get_order**](docs/OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
|
|
421
422
|
*UltracartClient::OrderApi* | [**get_order_by_token**](docs/OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
|
|
422
423
|
*UltracartClient::OrderApi* | [**get_order_edi_documents**](docs/OrderApi.md#get_order_edi_documents) | **GET** /order/orders/{order_id}/edi | Retrieve EDI documents associated with this order.
|
|
424
|
+
*UltracartClient::OrderApi* | [**get_order_emails**](docs/OrderApi.md#get_order_emails) | **GET** /order/orders/{order_id}/emails | Retrieve email delivery information for this order.
|
|
425
|
+
*UltracartClient::OrderApi* | [**get_order_page_view_history**](docs/OrderApi.md#get_order_page_view_history) | **GET** /order/orders/{order_id}/page_view_history | Retrieve page view history for this order.
|
|
423
426
|
*UltracartClient::OrderApi* | [**get_order_upsell_cart**](docs/OrderApi.md#get_order_upsell_cart) | **PUT** /order/orders/{order_id}/upsell_with_cart | Get Order Upsell Cart
|
|
424
427
|
*UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
|
|
425
428
|
*UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
|
|
@@ -712,6 +715,8 @@ Class | Method | HTTP request | Description
|
|
|
712
715
|
- [UltracartClient::AutoOrderAddonItemOption](docs/AutoOrderAddonItemOption.md)
|
|
713
716
|
- [UltracartClient::AutoOrderAddonItemsUpdateRequest](docs/AutoOrderAddonItemsUpdateRequest.md)
|
|
714
717
|
- [UltracartClient::AutoOrderConsolidate](docs/AutoOrderConsolidate.md)
|
|
718
|
+
- [UltracartClient::AutoOrderEmail](docs/AutoOrderEmail.md)
|
|
719
|
+
- [UltracartClient::AutoOrderEmailsResponse](docs/AutoOrderEmailsResponse.md)
|
|
715
720
|
- [UltracartClient::AutoOrderItem](docs/AutoOrderItem.md)
|
|
716
721
|
- [UltracartClient::AutoOrderItemCancelRequest](docs/AutoOrderItemCancelRequest.md)
|
|
717
722
|
- [UltracartClient::AutoOrderItemFutureSchedule](docs/AutoOrderItemFutureSchedule.md)
|
|
@@ -1424,6 +1429,8 @@ Class | Method | HTTP request | Description
|
|
|
1424
1429
|
- [UltracartClient::OrderEdi](docs/OrderEdi.md)
|
|
1425
1430
|
- [UltracartClient::OrderEdiDocument](docs/OrderEdiDocument.md)
|
|
1426
1431
|
- [UltracartClient::OrderEdiDocumentsResponse](docs/OrderEdiDocumentsResponse.md)
|
|
1432
|
+
- [UltracartClient::OrderEmail](docs/OrderEmail.md)
|
|
1433
|
+
- [UltracartClient::OrderEmailsResponse](docs/OrderEmailsResponse.md)
|
|
1427
1434
|
- [UltracartClient::OrderFormat](docs/OrderFormat.md)
|
|
1428
1435
|
- [UltracartClient::OrderFormatResponse](docs/OrderFormatResponse.md)
|
|
1429
1436
|
- [UltracartClient::OrderFraudScore](docs/OrderFraudScore.md)
|
|
@@ -1442,6 +1449,10 @@ Class | Method | HTTP request | Description
|
|
|
1442
1449
|
- [UltracartClient::OrderLinkedShipment](docs/OrderLinkedShipment.md)
|
|
1443
1450
|
- [UltracartClient::OrderMarketing](docs/OrderMarketing.md)
|
|
1444
1451
|
- [UltracartClient::OrderPackingSlipResponse](docs/OrderPackingSlipResponse.md)
|
|
1452
|
+
- [UltracartClient::OrderPageView](docs/OrderPageView.md)
|
|
1453
|
+
- [UltracartClient::OrderPageViewHistoryResponse](docs/OrderPageViewHistoryResponse.md)
|
|
1454
|
+
- [UltracartClient::OrderPageViewMetaData](docs/OrderPageViewMetaData.md)
|
|
1455
|
+
- [UltracartClient::OrderPageViewParam](docs/OrderPageViewParam.md)
|
|
1445
1456
|
- [UltracartClient::OrderPayment](docs/OrderPayment.md)
|
|
1446
1457
|
- [UltracartClient::OrderPaymentCheck](docs/OrderPaymentCheck.md)
|
|
1447
1458
|
- [UltracartClient::OrderPaymentCreditCard](docs/OrderPaymentCreditCard.md)
|
|
@@ -1735,6 +1746,8 @@ Not every change is committed to every SDK.
|
|
|
1735
1746
|
|
|
1736
1747
|
| Version | Date | Comments |
|
|
1737
1748
|
| --: | :-: | --- |
|
|
1749
|
+
| 4.1.88 | 05/08/2026 | order page view history |
|
|
1750
|
+
| 4.1.87 | 05/08/2026 | order and auto order emails |
|
|
1738
1751
|
| 4.1.86 | 05/07/2026 | rest auto order api - additional item cancel request parameter for no orders after dts |
|
|
1739
1752
|
| 4.1.85 | 05/05/2026 | improved warning object for customer insertCustomer and updateCustomer |
|
|
1740
1753
|
| 4.1.84 | 05/04/2026 | Order API - add hold stage to allowed values on order query request |
|
data/docs/AutoOrder.md
CHANGED
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
| **completed** | **Boolean** | True if the auto order ran successfully to completion | [optional] |
|
|
17
17
|
| **credit_card_attempt** | **Integer** | The number of credit card attempts that have taken place | [optional] |
|
|
18
18
|
| **disabled_dts** | **String** | The date/time the auto order was disabled due to failed rebills | [optional] |
|
|
19
|
+
| **emails** | [**Array<AutoOrderEmail>**](AutoOrderEmail.md) | Email delivery records associated with this auto order. | [optional] |
|
|
19
20
|
| **enabled** | **Boolean** | True if this auto order is enabled | [optional] |
|
|
20
21
|
| **failure_reason** | **String** | The reason this auto order failed during the last rebill attempt | [optional] |
|
|
21
22
|
| **items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | The items that are setup to rebill | [optional] |
|
|
@@ -51,6 +52,7 @@ instance = UltracartClient::AutoOrder.new(
|
|
|
51
52
|
completed: null,
|
|
52
53
|
credit_card_attempt: null,
|
|
53
54
|
disabled_dts: null,
|
|
55
|
+
emails: null,
|
|
54
56
|
enabled: null,
|
|
55
57
|
failure_reason: null,
|
|
56
58
|
items: null,
|
data/docs/AutoOrderApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
10
10
|
| [**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid |
|
|
11
11
|
| [**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code |
|
|
12
12
|
| [**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id |
|
|
13
|
+
| [**get_auto_order_emails**](AutoOrderApi.md#get_auto_order_emails) | **GET** /auto_order/auto_orders/{auto_order_oid}/emails | Retrieve email delivery information for this auto order. |
|
|
13
14
|
| [**get_auto_orders**](AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders |
|
|
14
15
|
| [**get_auto_orders_batch**](AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch |
|
|
15
16
|
| [**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query |
|
|
@@ -566,6 +567,59 @@ end
|
|
|
566
567
|
- **Accept**: application/json
|
|
567
568
|
|
|
568
569
|
|
|
570
|
+
## get_auto_order_emails
|
|
571
|
+
|
|
572
|
+
> <AutoOrderEmailsResponse> get_auto_order_emails(auto_order_oid)
|
|
573
|
+
|
|
574
|
+
Retrieve email delivery information for this auto order.
|
|
575
|
+
|
|
576
|
+
Retrieves email delivery records associated with the specified auto order.
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
### Examples
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
(No example for this operation).
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
#### Using the get_auto_order_emails_with_http_info variant
|
|
586
|
+
|
|
587
|
+
This returns an Array which contains the response data, status code and headers.
|
|
588
|
+
|
|
589
|
+
> <Array(<AutoOrderEmailsResponse>, Integer, Hash)> get_auto_order_emails_with_http_info(auto_order_oid)
|
|
590
|
+
|
|
591
|
+
```ruby
|
|
592
|
+
begin
|
|
593
|
+
# Retrieve email delivery information for this auto order.
|
|
594
|
+
data, status_code, headers = api_instance.get_auto_order_emails_with_http_info(auto_order_oid)
|
|
595
|
+
p status_code # => 2xx
|
|
596
|
+
p headers # => { ... }
|
|
597
|
+
p data # => <AutoOrderEmailsResponse>
|
|
598
|
+
rescue UltracartClient::ApiError => e
|
|
599
|
+
puts "Error when calling AutoOrderApi->get_auto_order_emails_with_http_info: #{e}"
|
|
600
|
+
end
|
|
601
|
+
```
|
|
602
|
+
|
|
603
|
+
### Parameters
|
|
604
|
+
|
|
605
|
+
| Name | Type | Description | Notes |
|
|
606
|
+
| ---- | ---- | ----------- | ----- |
|
|
607
|
+
| **auto_order_oid** | **Integer** | The auto order oid to retrieve email delivery information for. | |
|
|
608
|
+
|
|
609
|
+
### Return type
|
|
610
|
+
|
|
611
|
+
[**AutoOrderEmailsResponse**](AutoOrderEmailsResponse.md)
|
|
612
|
+
|
|
613
|
+
### Authorization
|
|
614
|
+
|
|
615
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
616
|
+
|
|
617
|
+
### HTTP request headers
|
|
618
|
+
|
|
619
|
+
- **Content-Type**: Not defined
|
|
620
|
+
- **Accept**: application/json
|
|
621
|
+
|
|
622
|
+
|
|
569
623
|
## get_auto_orders
|
|
570
624
|
|
|
571
625
|
> <AutoOrdersResponse> get_auto_orders(opts)
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# UltracartClient::AutoOrderEmail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **bounce_diagnostic_code** | **String** | | [optional] |
|
|
8
|
+
| **bounce_dts** | **String** | Date/time that the email was bounced | [optional] |
|
|
9
|
+
| **bounce_sub_type** | **String** | | [optional] |
|
|
10
|
+
| **bounce_type** | **String** | | [optional] |
|
|
11
|
+
| **clicked** | **Boolean** | | [optional] |
|
|
12
|
+
| **clicked_dts** | **String** | Date/time that the email was clicked | [optional] |
|
|
13
|
+
| **delivered** | **Boolean** | | [optional] |
|
|
14
|
+
| **delivery_dts** | **String** | Date/time that the email was delivered | [optional] |
|
|
15
|
+
| **email** | **String** | Email | [optional] |
|
|
16
|
+
| **internal** | **Boolean** | | [optional] |
|
|
17
|
+
| **message_id** | **String** | | [optional] |
|
|
18
|
+
| **opened** | **Boolean** | | [optional] |
|
|
19
|
+
| **opened_dts** | **String** | Date/time that the email was opened | [optional] |
|
|
20
|
+
| **reporting_mta** | **String** | | [optional] |
|
|
21
|
+
| **send_dts** | **String** | Date/time that the email was sent | [optional] |
|
|
22
|
+
| **skip_reason** | **String** | | [optional] |
|
|
23
|
+
| **skipped** | **Boolean** | | [optional] |
|
|
24
|
+
| **smtp_response** | **String** | | [optional] |
|
|
25
|
+
| **subject** | **String** | | [optional] |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'ultracart_api'
|
|
31
|
+
|
|
32
|
+
instance = UltracartClient::AutoOrderEmail.new(
|
|
33
|
+
bounce_diagnostic_code: null,
|
|
34
|
+
bounce_dts: null,
|
|
35
|
+
bounce_sub_type: null,
|
|
36
|
+
bounce_type: null,
|
|
37
|
+
clicked: null,
|
|
38
|
+
clicked_dts: null,
|
|
39
|
+
delivered: null,
|
|
40
|
+
delivery_dts: null,
|
|
41
|
+
email: null,
|
|
42
|
+
internal: null,
|
|
43
|
+
message_id: null,
|
|
44
|
+
opened: null,
|
|
45
|
+
opened_dts: null,
|
|
46
|
+
reporting_mta: null,
|
|
47
|
+
send_dts: null,
|
|
48
|
+
skip_reason: null,
|
|
49
|
+
skipped: null,
|
|
50
|
+
smtp_response: null,
|
|
51
|
+
subject: null
|
|
52
|
+
)
|
|
53
|
+
```
|
|
54
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::AutoOrderEmailsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **emails** | [**Array<AutoOrderEmail>**](AutoOrderEmail.md) | emails | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.md) | | [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::AutoOrderEmailsResponse.new(
|
|
19
|
+
emails: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/Order.md
CHANGED
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
| **customer_profile** | [**Customer**](Customer.md) | | [optional] |
|
|
19
19
|
| **digital_order** | [**OrderDigitalOrder**](OrderDigitalOrder.md) | | [optional] |
|
|
20
20
|
| **edi** | [**OrderEdi**](OrderEdi.md) | | [optional] |
|
|
21
|
+
| **emails** | [**Array<OrderEmail>**](OrderEmail.md) | Email delivery records associated with this order. | [optional] |
|
|
21
22
|
| **exchange_rate** | **Float** | Exchange rate at the time the order was placed if currency code is different than the base currency | [optional] |
|
|
22
23
|
| **fraud_score** | [**OrderFraudScore**](OrderFraudScore.md) | | [optional] |
|
|
23
24
|
| **gift** | [**OrderGift**](OrderGift.md) | | [optional] |
|
|
@@ -64,6 +65,7 @@ instance = UltracartClient::Order.new(
|
|
|
64
65
|
customer_profile: null,
|
|
65
66
|
digital_order: null,
|
|
66
67
|
edi: null,
|
|
68
|
+
emails: null,
|
|
67
69
|
exchange_rate: null,
|
|
68
70
|
fraud_score: null,
|
|
69
71
|
gift: null,
|
data/docs/OrderApi.md
CHANGED
|
@@ -22,6 +22,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
22
22
|
| [**get_order**](OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order |
|
|
23
23
|
| [**get_order_by_token**](OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token |
|
|
24
24
|
| [**get_order_edi_documents**](OrderApi.md#get_order_edi_documents) | **GET** /order/orders/{order_id}/edi | Retrieve EDI documents associated with this order. |
|
|
25
|
+
| [**get_order_emails**](OrderApi.md#get_order_emails) | **GET** /order/orders/{order_id}/emails | Retrieve email delivery information for this order. |
|
|
26
|
+
| [**get_order_page_view_history**](OrderApi.md#get_order_page_view_history) | **GET** /order/orders/{order_id}/page_view_history | Retrieve page view history for this order. |
|
|
25
27
|
| [**get_order_upsell_cart**](OrderApi.md#get_order_upsell_cart) | **PUT** /order/orders/{order_id}/upsell_with_cart | Get Order Upsell Cart |
|
|
26
28
|
| [**get_orders**](OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders |
|
|
27
29
|
| [**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch |
|
|
@@ -1359,6 +1361,112 @@ end
|
|
|
1359
1361
|
- **Accept**: application/json
|
|
1360
1362
|
|
|
1361
1363
|
|
|
1364
|
+
## get_order_emails
|
|
1365
|
+
|
|
1366
|
+
> <OrderEmailsResponse> get_order_emails(order_id)
|
|
1367
|
+
|
|
1368
|
+
Retrieve email delivery information for this order.
|
|
1369
|
+
|
|
1370
|
+
Retrieves email delivery records associated with the specified order id.
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
### Examples
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
(No example for this operation).
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
#### Using the get_order_emails_with_http_info variant
|
|
1380
|
+
|
|
1381
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1382
|
+
|
|
1383
|
+
> <Array(<OrderEmailsResponse>, Integer, Hash)> get_order_emails_with_http_info(order_id)
|
|
1384
|
+
|
|
1385
|
+
```ruby
|
|
1386
|
+
begin
|
|
1387
|
+
# Retrieve email delivery information for this order.
|
|
1388
|
+
data, status_code, headers = api_instance.get_order_emails_with_http_info(order_id)
|
|
1389
|
+
p status_code # => 2xx
|
|
1390
|
+
p headers # => { ... }
|
|
1391
|
+
p data # => <OrderEmailsResponse>
|
|
1392
|
+
rescue UltracartClient::ApiError => e
|
|
1393
|
+
puts "Error when calling OrderApi->get_order_emails_with_http_info: #{e}"
|
|
1394
|
+
end
|
|
1395
|
+
```
|
|
1396
|
+
|
|
1397
|
+
### Parameters
|
|
1398
|
+
|
|
1399
|
+
| Name | Type | Description | Notes |
|
|
1400
|
+
| ---- | ---- | ----------- | ----- |
|
|
1401
|
+
| **order_id** | **String** | The order id to retrieve email delivery information for. | |
|
|
1402
|
+
|
|
1403
|
+
### Return type
|
|
1404
|
+
|
|
1405
|
+
[**OrderEmailsResponse**](OrderEmailsResponse.md)
|
|
1406
|
+
|
|
1407
|
+
### Authorization
|
|
1408
|
+
|
|
1409
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1410
|
+
|
|
1411
|
+
### HTTP request headers
|
|
1412
|
+
|
|
1413
|
+
- **Content-Type**: Not defined
|
|
1414
|
+
- **Accept**: application/json
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
## get_order_page_view_history
|
|
1418
|
+
|
|
1419
|
+
> <OrderPageViewHistoryResponse> get_order_page_view_history(order_id)
|
|
1420
|
+
|
|
1421
|
+
Retrieve page view history for this order.
|
|
1422
|
+
|
|
1423
|
+
Retrieves the page views captured during the session that placed this order.
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
### Examples
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
(No example for this operation).
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
#### Using the get_order_page_view_history_with_http_info variant
|
|
1433
|
+
|
|
1434
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1435
|
+
|
|
1436
|
+
> <Array(<OrderPageViewHistoryResponse>, Integer, Hash)> get_order_page_view_history_with_http_info(order_id)
|
|
1437
|
+
|
|
1438
|
+
```ruby
|
|
1439
|
+
begin
|
|
1440
|
+
# Retrieve page view history for this order.
|
|
1441
|
+
data, status_code, headers = api_instance.get_order_page_view_history_with_http_info(order_id)
|
|
1442
|
+
p status_code # => 2xx
|
|
1443
|
+
p headers # => { ... }
|
|
1444
|
+
p data # => <OrderPageViewHistoryResponse>
|
|
1445
|
+
rescue UltracartClient::ApiError => e
|
|
1446
|
+
puts "Error when calling OrderApi->get_order_page_view_history_with_http_info: #{e}"
|
|
1447
|
+
end
|
|
1448
|
+
```
|
|
1449
|
+
|
|
1450
|
+
### Parameters
|
|
1451
|
+
|
|
1452
|
+
| Name | Type | Description | Notes |
|
|
1453
|
+
| ---- | ---- | ----------- | ----- |
|
|
1454
|
+
| **order_id** | **String** | The order id to retrieve page view history for. | |
|
|
1455
|
+
|
|
1456
|
+
### Return type
|
|
1457
|
+
|
|
1458
|
+
[**OrderPageViewHistoryResponse**](OrderPageViewHistoryResponse.md)
|
|
1459
|
+
|
|
1460
|
+
### Authorization
|
|
1461
|
+
|
|
1462
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1463
|
+
|
|
1464
|
+
### HTTP request headers
|
|
1465
|
+
|
|
1466
|
+
- **Content-Type**: Not defined
|
|
1467
|
+
- **Accept**: application/json
|
|
1468
|
+
|
|
1469
|
+
|
|
1362
1470
|
## get_order_upsell_cart
|
|
1363
1471
|
|
|
1364
1472
|
> <OrderResponse> get_order_upsell_cart(order_id, upsell_cart_request, opts)
|
data/docs/OrderEmail.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# UltracartClient::OrderEmail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **bounce_diagnostic_code** | **String** | | [optional] |
|
|
8
|
+
| **bounce_dts** | **String** | Date/time that the email was bounced | [optional] |
|
|
9
|
+
| **bounce_sub_type** | **String** | | [optional] |
|
|
10
|
+
| **bounce_type** | **String** | | [optional] |
|
|
11
|
+
| **clicked** | **Boolean** | | [optional] |
|
|
12
|
+
| **clicked_dts** | **String** | Date/time that the email was clicked | [optional] |
|
|
13
|
+
| **delivered** | **Boolean** | | [optional] |
|
|
14
|
+
| **delivery_dts** | **String** | Date/time that the email was delivered | [optional] |
|
|
15
|
+
| **email** | **String** | Email | [optional] |
|
|
16
|
+
| **internal** | **Boolean** | | [optional] |
|
|
17
|
+
| **message_id** | **String** | | [optional] |
|
|
18
|
+
| **opened** | **Boolean** | | [optional] |
|
|
19
|
+
| **opened_dts** | **String** | Date/time that the email was opened | [optional] |
|
|
20
|
+
| **reporting_mta** | **String** | | [optional] |
|
|
21
|
+
| **send_dts** | **String** | Date/time that the email was sent | [optional] |
|
|
22
|
+
| **skip_reason** | **String** | | [optional] |
|
|
23
|
+
| **skipped** | **Boolean** | | [optional] |
|
|
24
|
+
| **smtp_response** | **String** | | [optional] |
|
|
25
|
+
| **subject** | **String** | | [optional] |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'ultracart_api'
|
|
31
|
+
|
|
32
|
+
instance = UltracartClient::OrderEmail.new(
|
|
33
|
+
bounce_diagnostic_code: null,
|
|
34
|
+
bounce_dts: null,
|
|
35
|
+
bounce_sub_type: null,
|
|
36
|
+
bounce_type: null,
|
|
37
|
+
clicked: null,
|
|
38
|
+
clicked_dts: null,
|
|
39
|
+
delivered: null,
|
|
40
|
+
delivery_dts: null,
|
|
41
|
+
email: null,
|
|
42
|
+
internal: null,
|
|
43
|
+
message_id: null,
|
|
44
|
+
opened: null,
|
|
45
|
+
opened_dts: null,
|
|
46
|
+
reporting_mta: null,
|
|
47
|
+
send_dts: null,
|
|
48
|
+
skip_reason: null,
|
|
49
|
+
skipped: null,
|
|
50
|
+
smtp_response: null,
|
|
51
|
+
subject: null
|
|
52
|
+
)
|
|
53
|
+
```
|
|
54
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::OrderEmailsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **emails** | [**Array<OrderEmail>**](OrderEmail.md) | emails | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.md) | | [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::OrderEmailsResponse.new(
|
|
19
|
+
emails: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::OrderPageView
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **meta_data** | [**Array<OrderPageViewMetaData>**](OrderPageViewMetaData.md) | Meta tag name/value pairs captured on the page view | [optional] |
|
|
8
|
+
| **params** | [**Array<OrderPageViewParam>**](OrderPageViewParam.md) | Query string parameters captured on the page view | [optional] |
|
|
9
|
+
| **time_on_page** | **Integer** | Time spent on the page in seconds | [optional] |
|
|
10
|
+
| **url** | **String** | URL of the page that was viewed | [optional] |
|
|
11
|
+
| **view_dts** | **String** | Date/time the page was viewed | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::OrderPageView.new(
|
|
19
|
+
meta_data: null,
|
|
20
|
+
params: null,
|
|
21
|
+
time_on_page: null,
|
|
22
|
+
url: null,
|
|
23
|
+
view_dts: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::OrderPageViewHistoryResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
9
|
+
| **page_views** | [**Array<OrderPageView>**](OrderPageView.md) | Page views captured during the session that placed this order | [optional] |
|
|
10
|
+
| **referrer** | **String** | HTTP referrer captured at the start of the session that placed this order | [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::OrderPageViewHistoryResponse.new(
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
page_views: null,
|
|
23
|
+
referrer: null,
|
|
24
|
+
success: null,
|
|
25
|
+
warning: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::OrderPageViewMetaData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Meta tag name | [optional] |
|
|
8
|
+
| **value** | **String** | Meta tag value | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::OrderPageViewMetaData.new(
|
|
16
|
+
name: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::OrderPageViewParam
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Query string parameter name | [optional] |
|
|
8
|
+
| **value** | **String** | Query string parameter value | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::OrderPageViewParam.new(
|
|
16
|
+
name: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -458,6 +458,70 @@ module UltracartClient
|
|
|
458
458
|
return data, status_code, headers
|
|
459
459
|
end
|
|
460
460
|
|
|
461
|
+
# Retrieve email delivery information for this auto order.
|
|
462
|
+
# Retrieves email delivery records associated with the specified auto order.
|
|
463
|
+
# @param auto_order_oid [Integer] The auto order oid to retrieve email delivery information for.
|
|
464
|
+
# @param [Hash] opts the optional parameters
|
|
465
|
+
# @return [AutoOrderEmailsResponse]
|
|
466
|
+
def get_auto_order_emails(auto_order_oid, opts = {})
|
|
467
|
+
data, _status_code, _headers = get_auto_order_emails_with_http_info(auto_order_oid, opts)
|
|
468
|
+
data
|
|
469
|
+
end
|
|
470
|
+
|
|
471
|
+
# Retrieve email delivery information for this auto order.
|
|
472
|
+
# Retrieves email delivery records associated with the specified auto order.
|
|
473
|
+
# @param auto_order_oid [Integer] The auto order oid to retrieve email delivery information for.
|
|
474
|
+
# @param [Hash] opts the optional parameters
|
|
475
|
+
# @return [Array<(AutoOrderEmailsResponse, Integer, Hash)>] AutoOrderEmailsResponse data, response status code and response headers
|
|
476
|
+
def get_auto_order_emails_with_http_info(auto_order_oid, opts = {})
|
|
477
|
+
if @api_client.config.debugging
|
|
478
|
+
@api_client.config.logger.debug 'Calling API: AutoOrderApi.get_auto_order_emails ...'
|
|
479
|
+
end
|
|
480
|
+
# verify the required parameter 'auto_order_oid' is set
|
|
481
|
+
if @api_client.config.client_side_validation && auto_order_oid.nil?
|
|
482
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.get_auto_order_emails"
|
|
483
|
+
end
|
|
484
|
+
# resource path
|
|
485
|
+
local_var_path = '/auto_order/auto_orders/{auto_order_oid}/emails'.sub('{' + 'auto_order_oid' + '}', CGI.escape(auto_order_oid.to_s))
|
|
486
|
+
|
|
487
|
+
# query parameters
|
|
488
|
+
query_params = opts[:query_params] || {}
|
|
489
|
+
|
|
490
|
+
# header parameters
|
|
491
|
+
header_params = opts[:header_params] || {}
|
|
492
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
493
|
+
# HTTP header 'Accept' (if needed)
|
|
494
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
495
|
+
|
|
496
|
+
# form parameters
|
|
497
|
+
form_params = opts[:form_params] || {}
|
|
498
|
+
|
|
499
|
+
# http body (model)
|
|
500
|
+
post_body = opts[:debug_body]
|
|
501
|
+
|
|
502
|
+
# return_type
|
|
503
|
+
return_type = opts[:debug_return_type] || 'AutoOrderEmailsResponse'
|
|
504
|
+
|
|
505
|
+
# auth_names
|
|
506
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
507
|
+
|
|
508
|
+
new_options = opts.merge(
|
|
509
|
+
:operation => :"AutoOrderApi.get_auto_order_emails",
|
|
510
|
+
:header_params => header_params,
|
|
511
|
+
:query_params => query_params,
|
|
512
|
+
:form_params => form_params,
|
|
513
|
+
:body => post_body,
|
|
514
|
+
:auth_names => auth_names,
|
|
515
|
+
:return_type => return_type
|
|
516
|
+
)
|
|
517
|
+
|
|
518
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
519
|
+
if @api_client.config.debugging
|
|
520
|
+
@api_client.config.logger.debug "API called: AutoOrderApi#get_auto_order_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
521
|
+
end
|
|
522
|
+
return data, status_code, headers
|
|
523
|
+
end
|
|
524
|
+
|
|
461
525
|
# Retrieve auto orders
|
|
462
526
|
# Retrieves auto orders from the account. If no parameters are specified, all auto orders will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
463
527
|
# @param [Hash] opts the optional parameters
|