ultracart_api 4.1.86 → 4.1.87

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 87093ad6bef3385e3591780b4b9ef0e7e0f8eab61e072589d3f63580b0d33e31
4
- data.tar.gz: 9ca4f31ff6a36fdb271e81fac3ea21b59a08708900ea85fbce12132aa81b4e55
3
+ metadata.gz: 1b52c55df79bfa993a5bf17317604d6e41791b4bf81e0f6364c87ce9e30f87e6
4
+ data.tar.gz: 541bc62a5406b94c5719e30a975e8a0f3afd8c89d3609440f96838512f1e7074
5
5
  SHA512:
6
- metadata.gz: 00d80e10c6c9822d2eb258459e705aa21c34621a4ef50f5bc706593a9bb4279d7730605b3f7e233df6c84f4f58377cc0964210af61585a3ac814ec2bdc6acf13
7
- data.tar.gz: 35331067008eeca96c36462bcb1b4dc5878975fb9c6f464dd07a7e1ffbfabe9561cdc5dd319eb0f3a7c7a004f24b3b2df45fe714f9c7e183f63ee27fd37a1989
6
+ metadata.gz: 1a0b39ad2c4ad93d11d00d27be6a6e4e6b499ecafb6392ed8d15d8eb16f2b4211924b1a1c4dc4d80f85be50bdcbb081d628290957ee008160a67e8dc48e1524e
7
+ data.tar.gz: bc9b11eedcd22ae64d942fdadcfdda36cdc38693a476ee38e245e3406b89ff3fcfc978b29dc9fa8e979f9eb0072f8c3ba8cac0a77c3c51701887639b79110969
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.86
10
+ - Package version: 4.1.87
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.86'
19
+ gem 'ultracart_api', '4.1.87'
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,7 @@ 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.
423
425
  *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
426
  *UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
425
427
  *UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
@@ -712,6 +714,8 @@ Class | Method | HTTP request | Description
712
714
  - [UltracartClient::AutoOrderAddonItemOption](docs/AutoOrderAddonItemOption.md)
713
715
  - [UltracartClient::AutoOrderAddonItemsUpdateRequest](docs/AutoOrderAddonItemsUpdateRequest.md)
714
716
  - [UltracartClient::AutoOrderConsolidate](docs/AutoOrderConsolidate.md)
717
+ - [UltracartClient::AutoOrderEmail](docs/AutoOrderEmail.md)
718
+ - [UltracartClient::AutoOrderEmailsResponse](docs/AutoOrderEmailsResponse.md)
715
719
  - [UltracartClient::AutoOrderItem](docs/AutoOrderItem.md)
716
720
  - [UltracartClient::AutoOrderItemCancelRequest](docs/AutoOrderItemCancelRequest.md)
717
721
  - [UltracartClient::AutoOrderItemFutureSchedule](docs/AutoOrderItemFutureSchedule.md)
@@ -1424,6 +1428,8 @@ Class | Method | HTTP request | Description
1424
1428
  - [UltracartClient::OrderEdi](docs/OrderEdi.md)
1425
1429
  - [UltracartClient::OrderEdiDocument](docs/OrderEdiDocument.md)
1426
1430
  - [UltracartClient::OrderEdiDocumentsResponse](docs/OrderEdiDocumentsResponse.md)
1431
+ - [UltracartClient::OrderEmail](docs/OrderEmail.md)
1432
+ - [UltracartClient::OrderEmailsResponse](docs/OrderEmailsResponse.md)
1427
1433
  - [UltracartClient::OrderFormat](docs/OrderFormat.md)
1428
1434
  - [UltracartClient::OrderFormatResponse](docs/OrderFormatResponse.md)
1429
1435
  - [UltracartClient::OrderFraudScore](docs/OrderFraudScore.md)
@@ -1735,6 +1741,7 @@ Not every change is committed to every SDK.
1735
1741
 
1736
1742
  | Version | Date | Comments |
1737
1743
  | --: | :-: | --- |
1744
+ | 4.1.87 | 05/08/2026 | order and auto order emails |
1738
1745
  | 4.1.86 | 05/07/2026 | rest auto order api - additional item cancel request parameter for no orders after dts |
1739
1746
  | 4.1.85 | 05/05/2026 | improved warning object for customer insertCustomer and updateCustomer |
1740
1747
  | 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&lt;AutoOrderEmail&gt;**](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&lt;OrderEmail&gt;**](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,7 @@ 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. |
25
26
  | [**get_order_upsell_cart**](OrderApi.md#get_order_upsell_cart) | **PUT** /order/orders/{order_id}/upsell_with_cart | Get Order Upsell Cart |
26
27
  | [**get_orders**](OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders |
27
28
  | [**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch |
@@ -1359,6 +1360,59 @@ end
1359
1360
  - **Accept**: application/json
1360
1361
 
1361
1362
 
1363
+ ## get_order_emails
1364
+
1365
+ > <OrderEmailsResponse> get_order_emails(order_id)
1366
+
1367
+ Retrieve email delivery information for this order.
1368
+
1369
+ Retrieves email delivery records associated with the specified order id.
1370
+
1371
+
1372
+ ### Examples
1373
+
1374
+
1375
+ (No example for this operation).
1376
+
1377
+
1378
+ #### Using the get_order_emails_with_http_info variant
1379
+
1380
+ This returns an Array which contains the response data, status code and headers.
1381
+
1382
+ > <Array(<OrderEmailsResponse>, Integer, Hash)> get_order_emails_with_http_info(order_id)
1383
+
1384
+ ```ruby
1385
+ begin
1386
+ # Retrieve email delivery information for this order.
1387
+ data, status_code, headers = api_instance.get_order_emails_with_http_info(order_id)
1388
+ p status_code # => 2xx
1389
+ p headers # => { ... }
1390
+ p data # => <OrderEmailsResponse>
1391
+ rescue UltracartClient::ApiError => e
1392
+ puts "Error when calling OrderApi->get_order_emails_with_http_info: #{e}"
1393
+ end
1394
+ ```
1395
+
1396
+ ### Parameters
1397
+
1398
+ | Name | Type | Description | Notes |
1399
+ | ---- | ---- | ----------- | ----- |
1400
+ | **order_id** | **String** | The order id to retrieve email delivery information for. | |
1401
+
1402
+ ### Return type
1403
+
1404
+ [**OrderEmailsResponse**](OrderEmailsResponse.md)
1405
+
1406
+ ### Authorization
1407
+
1408
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1409
+
1410
+ ### HTTP request headers
1411
+
1412
+ - **Content-Type**: Not defined
1413
+ - **Accept**: application/json
1414
+
1415
+
1362
1416
  ## get_order_upsell_cart
1363
1417
 
1364
1418
  > <OrderResponse> get_order_upsell_cart(order_id, upsell_cart_request, opts)
@@ -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&lt;OrderEmail&gt;**](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
+
@@ -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
@@ -1236,6 +1236,70 @@ module UltracartClient
1236
1236
  return data, status_code, headers
1237
1237
  end
1238
1238
 
1239
+ # Retrieve email delivery information for this order.
1240
+ # Retrieves email delivery records associated with the specified order id.
1241
+ # @param order_id [String] The order id to retrieve email delivery information for.
1242
+ # @param [Hash] opts the optional parameters
1243
+ # @return [OrderEmailsResponse]
1244
+ def get_order_emails(order_id, opts = {})
1245
+ data, _status_code, _headers = get_order_emails_with_http_info(order_id, opts)
1246
+ data
1247
+ end
1248
+
1249
+ # Retrieve email delivery information for this order.
1250
+ # Retrieves email delivery records associated with the specified order id.
1251
+ # @param order_id [String] The order id to retrieve email delivery information for.
1252
+ # @param [Hash] opts the optional parameters
1253
+ # @return [Array<(OrderEmailsResponse, Integer, Hash)>] OrderEmailsResponse data, response status code and response headers
1254
+ def get_order_emails_with_http_info(order_id, opts = {})
1255
+ if @api_client.config.debugging
1256
+ @api_client.config.logger.debug 'Calling API: OrderApi.get_order_emails ...'
1257
+ end
1258
+ # verify the required parameter 'order_id' is set
1259
+ if @api_client.config.client_side_validation && order_id.nil?
1260
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order_emails"
1261
+ end
1262
+ # resource path
1263
+ local_var_path = '/order/orders/{order_id}/emails'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
1264
+
1265
+ # query parameters
1266
+ query_params = opts[:query_params] || {}
1267
+
1268
+ # header parameters
1269
+ header_params = opts[:header_params] || {}
1270
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1271
+ # HTTP header 'Accept' (if needed)
1272
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1273
+
1274
+ # form parameters
1275
+ form_params = opts[:form_params] || {}
1276
+
1277
+ # http body (model)
1278
+ post_body = opts[:debug_body]
1279
+
1280
+ # return_type
1281
+ return_type = opts[:debug_return_type] || 'OrderEmailsResponse'
1282
+
1283
+ # auth_names
1284
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1285
+
1286
+ new_options = opts.merge(
1287
+ :operation => :"OrderApi.get_order_emails",
1288
+ :header_params => header_params,
1289
+ :query_params => query_params,
1290
+ :form_params => form_params,
1291
+ :body => post_body,
1292
+ :auth_names => auth_names,
1293
+ :return_type => return_type
1294
+ )
1295
+
1296
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1297
+ if @api_client.config.debugging
1298
+ @api_client.config.logger.debug "API called: OrderApi#get_order_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1299
+ end
1300
+ return data, status_code, headers
1301
+ end
1302
+
1239
1303
  # Get Order Upsell Cart
1240
1304
  # Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
1241
1305
  # @param order_id [String] The order id to base things on.
@@ -51,6 +51,9 @@ module UltracartClient
51
51
  # The date/time the auto order was disabled due to failed rebills
52
52
  attr_accessor :disabled_dts
53
53
 
54
+ # Email delivery records associated with this auto order.
55
+ attr_accessor :emails
56
+
54
57
  # True if this auto order is enabled
55
58
  attr_accessor :enabled
56
59
 
@@ -134,6 +137,7 @@ module UltracartClient
134
137
  :'completed' => :'completed',
135
138
  :'credit_card_attempt' => :'credit_card_attempt',
136
139
  :'disabled_dts' => :'disabled_dts',
140
+ :'emails' => :'emails',
137
141
  :'enabled' => :'enabled',
138
142
  :'failure_reason' => :'failure_reason',
139
143
  :'items' => :'items',
@@ -173,6 +177,7 @@ module UltracartClient
173
177
  :'completed' => :'Boolean',
174
178
  :'credit_card_attempt' => :'Integer',
175
179
  :'disabled_dts' => :'String',
180
+ :'emails' => :'Array<AutoOrderEmail>',
176
181
  :'enabled' => :'Boolean',
177
182
  :'failure_reason' => :'String',
178
183
  :'items' => :'Array<AutoOrderItem>',
@@ -263,6 +268,12 @@ module UltracartClient
263
268
  self.disabled_dts = attributes[:'disabled_dts']
264
269
  end
265
270
 
271
+ if attributes.key?(:'emails')
272
+ if (value = attributes[:'emails']).is_a?(Array)
273
+ self.emails = value
274
+ end
275
+ end
276
+
266
277
  if attributes.key?(:'enabled')
267
278
  self.enabled = attributes[:'enabled']
268
279
  end
@@ -378,6 +389,7 @@ module UltracartClient
378
389
  completed == o.completed &&
379
390
  credit_card_attempt == o.credit_card_attempt &&
380
391
  disabled_dts == o.disabled_dts &&
392
+ emails == o.emails &&
381
393
  enabled == o.enabled &&
382
394
  failure_reason == o.failure_reason &&
383
395
  items == o.items &&
@@ -405,7 +417,7 @@ module UltracartClient
405
417
  # Calculates hash code according to all attributes.
406
418
  # @return [Integer] Hash code
407
419
  def hash
408
- [add_ons, auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, management, merchant_id, merged_dts, merged_into_auto_order_oid, next_attempt, original_order, original_order_id, override_affiliate_id, properties, rebill_orders, rotating_transaction_gateway_code, status].hash
420
+ [add_ons, auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, emails, enabled, failure_reason, items, logs, management, merchant_id, merged_dts, merged_into_auto_order_oid, next_attempt, original_order, original_order_id, override_affiliate_id, properties, rebill_orders, rotating_transaction_gateway_code, status].hash
409
421
  end
410
422
 
411
423
  # Builds the object from hash