ultracart_api 4.1.120 → 4.1.122
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 +8 -2
- data/docs/AutoOrderApi.md +111 -0
- data/docs/AutoOrderPaymentUpdateRequest.md +28 -0
- data/docs/AutoOrderRebillResponse.md +34 -0
- data/docs/EmailDispatchLog.md +2 -0
- data/docs/EmailSettings.md +2 -0
- data/docs/StorefrontApi.md +3 -1
- data/lib/ultracart_api/api/auto_order_api.rb +145 -0
- data/lib/ultracart_api/api/storefront_api.rb +8 -2
- data/lib/ultracart_api/models/auto_order_payment_update_request.rb +304 -0
- data/lib/ultracart_api/models/auto_order_rebill_response.rb +296 -0
- data/lib/ultracart_api/models/email_dispatch_log.rb +11 -1
- data/lib/ultracart_api/models/email_settings.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +2 -0
- metadata +6 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 71942b52f2c627128d180191ed15c60a07c07c82127fee920cf3126817de23f5
|
|
4
|
+
data.tar.gz: 649eda60fe73357484d88de638a90d6edccf883518b6ffb244f30a96e9a0414d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6e88efbd8fb93c3f7089c44acb19cc70e53661c2c79d16205b68888f3211f1d0581823736ae644973380a1841a7b33ec175f4787216cfb3e325e892a30b98772
|
|
7
|
+
data.tar.gz: 8a003fbcb04fc63a0389f864eba35a23d4c975f7f7725dad7a6635a8d2b403561253653bfa46d9e96f61eab7ea0d85e46e5d0a75de586e87a70b235e0fd88eed
|
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.122
|
|
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.122'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -90,6 +90,7 @@ Class | Method | HTTP request | Description
|
|
|
90
90
|
*UltracartClient::AffiliateApi* | [**insert_affiliate**](docs/AffiliateApi.md#insert_affiliate) | **POST** /affiliate/affiliates | Insert an affiliate
|
|
91
91
|
*UltracartClient::AffiliateApi* | [**send_affiliate_welcome_email**](docs/AffiliateApi.md#send_affiliate_welcome_email) | **POST** /affiliate/affiliates/{affiliate_oid}/welcome_email | Send a welcome email to an affiliate
|
|
92
92
|
*UltracartClient::AffiliateApi* | [**update_affiliate**](docs/AffiliateApi.md#update_affiliate) | **PUT** /affiliate/affiliates/{affiliate_oid} | Update an affiliate
|
|
93
|
+
*UltracartClient::AutoOrderApi* | [**attempt_auto_order_rebill**](docs/AutoOrderApi.md#attempt_auto_order_rebill) | **POST** /auto_order/auto_orders/{auto_order_oid}/rebill | Attempt a failed rebill on an auto order
|
|
93
94
|
*UltracartClient::AutoOrderApi* | [**cancel_auto_order_item_by_reference_order_id**](docs/AutoOrderApi.md#cancel_auto_order_item_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel | Cancel a single item on an auto order
|
|
94
95
|
*UltracartClient::AutoOrderApi* | [**consolidate_auto_orders**](docs/AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders
|
|
95
96
|
*UltracartClient::AutoOrderApi* | [**establish_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id
|
|
@@ -105,6 +106,7 @@ Class | Method | HTTP request | Description
|
|
|
105
106
|
*UltracartClient::AutoOrderApi* | [**update_auto_order**](docs/AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
|
|
106
107
|
*UltracartClient::AutoOrderApi* | [**update_auto_order_item_add_ons**](docs/AutoOrderApi.md#update_auto_order_item_add_ons) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/add_ons | Update an auto order item add ons
|
|
107
108
|
*UltracartClient::AutoOrderApi* | [**update_auto_order_item_properties**](docs/AutoOrderApi.md#update_auto_order_item_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties | Update an auto order item properties
|
|
109
|
+
*UltracartClient::AutoOrderApi* | [**update_auto_order_payment**](docs/AutoOrderApi.md#update_auto_order_payment) | **PUT** /auto_order/auto_orders/{auto_order_oid}/payment | Update the payment information on an auto order
|
|
108
110
|
*UltracartClient::AutoOrderApi* | [**update_auto_order_properties**](docs/AutoOrderApi.md#update_auto_order_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/properties | Update an auto order properties
|
|
109
111
|
*UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
|
|
110
112
|
*UltracartClient::BulkApi* | [**bulk_cancel_job**](docs/BulkApi.md#bulk_cancel_job) | **DELETE** /bulk/{object}/{job_id} | Request cancellation of a bulk job
|
|
@@ -764,10 +766,12 @@ Class | Method | HTTP request | Description
|
|
|
764
766
|
- [UltracartClient::AutoOrderItemSimpleSchedule](docs/AutoOrderItemSimpleSchedule.md)
|
|
765
767
|
- [UltracartClient::AutoOrderLog](docs/AutoOrderLog.md)
|
|
766
768
|
- [UltracartClient::AutoOrderManagement](docs/AutoOrderManagement.md)
|
|
769
|
+
- [UltracartClient::AutoOrderPaymentUpdateRequest](docs/AutoOrderPaymentUpdateRequest.md)
|
|
767
770
|
- [UltracartClient::AutoOrderPropertiesUpdateRequest](docs/AutoOrderPropertiesUpdateRequest.md)
|
|
768
771
|
- [UltracartClient::AutoOrderProperty](docs/AutoOrderProperty.md)
|
|
769
772
|
- [UltracartClient::AutoOrderQuery](docs/AutoOrderQuery.md)
|
|
770
773
|
- [UltracartClient::AutoOrderQueryBatch](docs/AutoOrderQueryBatch.md)
|
|
774
|
+
- [UltracartClient::AutoOrderRebillResponse](docs/AutoOrderRebillResponse.md)
|
|
771
775
|
- [UltracartClient::AutoOrderResponse](docs/AutoOrderResponse.md)
|
|
772
776
|
- [UltracartClient::AutoOrdersRequest](docs/AutoOrdersRequest.md)
|
|
773
777
|
- [UltracartClient::AutoOrdersResponse](docs/AutoOrdersResponse.md)
|
|
@@ -1825,6 +1829,8 @@ Not every change is committed to every SDK.
|
|
|
1825
1829
|
|
|
1826
1830
|
| Version | Date | Comments |
|
|
1827
1831
|
| --: | :-: | --- |
|
|
1832
|
+
| 4.1.122 | 07/29/2026 | auto order api - new methods for payment information and rebill |
|
|
1833
|
+
| 4.1.121 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |
|
|
1828
1834
|
| 4.1.120 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |
|
|
1829
1835
|
| 4.1.119 | 07/15/2026 | order api - query transaction details for cache target |
|
|
1830
1836
|
| 4.1.118 | 07/14/2026 | affiliate - send welcome letter method |
|
data/docs/AutoOrderApi.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
|
+
| [**attempt_auto_order_rebill**](AutoOrderApi.md#attempt_auto_order_rebill) | **POST** /auto_order/auto_orders/{auto_order_oid}/rebill | Attempt a failed rebill on an auto order |
|
|
7
8
|
| [**cancel_auto_order_item_by_reference_order_id**](AutoOrderApi.md#cancel_auto_order_item_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel | Cancel a single item on an auto order |
|
|
8
9
|
| [**consolidate_auto_orders**](AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders |
|
|
9
10
|
| [**establish_auto_order_by_reference_order_id**](AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id |
|
|
@@ -19,10 +20,65 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
19
20
|
| [**update_auto_order**](AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order |
|
|
20
21
|
| [**update_auto_order_item_add_ons**](AutoOrderApi.md#update_auto_order_item_add_ons) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/add_ons | Update an auto order item add ons |
|
|
21
22
|
| [**update_auto_order_item_properties**](AutoOrderApi.md#update_auto_order_item_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties | Update an auto order item properties |
|
|
23
|
+
| [**update_auto_order_payment**](AutoOrderApi.md#update_auto_order_payment) | **PUT** /auto_order/auto_orders/{auto_order_oid}/payment | Update the payment information on an auto order |
|
|
22
24
|
| [**update_auto_order_properties**](AutoOrderApi.md#update_auto_order_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/properties | Update an auto order properties |
|
|
23
25
|
| [**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders |
|
|
24
26
|
|
|
25
27
|
|
|
28
|
+
## attempt_auto_order_rebill
|
|
29
|
+
|
|
30
|
+
> <AutoOrderRebillResponse> attempt_auto_order_rebill(auto_order_oid, opts)
|
|
31
|
+
|
|
32
|
+
Attempt a failed rebill on an auto order
|
|
33
|
+
|
|
34
|
+
Attempts to rebill an auto order using the payment information already on the original order. The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging. Runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
### Examples
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
(No example for this operation).
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
#### Using the attempt_auto_order_rebill_with_http_info variant
|
|
44
|
+
|
|
45
|
+
This returns an Array which contains the response data, status code and headers.
|
|
46
|
+
|
|
47
|
+
> <Array(<AutoOrderRebillResponse>, Integer, Hash)> attempt_auto_order_rebill_with_http_info(auto_order_oid, opts)
|
|
48
|
+
|
|
49
|
+
```ruby
|
|
50
|
+
begin
|
|
51
|
+
# Attempt a failed rebill on an auto order
|
|
52
|
+
data, status_code, headers = api_instance.attempt_auto_order_rebill_with_http_info(auto_order_oid, opts)
|
|
53
|
+
p status_code # => 2xx
|
|
54
|
+
p headers # => { ... }
|
|
55
|
+
p data # => <AutoOrderRebillResponse>
|
|
56
|
+
rescue UltracartClient::ApiError => e
|
|
57
|
+
puts "Error when calling AutoOrderApi->attempt_auto_order_rebill_with_http_info: #{e}"
|
|
58
|
+
end
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
| Name | Type | Description | Notes |
|
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
|
65
|
+
| **auto_order_oid** | **Integer** | The auto order oid to rebill. | |
|
|
66
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
67
|
+
|
|
68
|
+
### Return type
|
|
69
|
+
|
|
70
|
+
[**AutoOrderRebillResponse**](AutoOrderRebillResponse.md)
|
|
71
|
+
|
|
72
|
+
### Authorization
|
|
73
|
+
|
|
74
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
75
|
+
|
|
76
|
+
### HTTP request headers
|
|
77
|
+
|
|
78
|
+
- **Content-Type**: Not defined
|
|
79
|
+
- **Accept**: application/json
|
|
80
|
+
|
|
81
|
+
|
|
26
82
|
## cancel_auto_order_item_by_reference_order_id
|
|
27
83
|
|
|
28
84
|
> <AutoOrderResponse> cancel_auto_order_item_by_reference_order_id(reference_order_id, original_item_id, opts)
|
|
@@ -1430,6 +1486,61 @@ end
|
|
|
1430
1486
|
- **Accept**: application/json
|
|
1431
1487
|
|
|
1432
1488
|
|
|
1489
|
+
## update_auto_order_payment
|
|
1490
|
+
|
|
1491
|
+
> <AutoOrderRebillResponse> update_auto_order_payment(auto_order_oid, auto_order_payment_update_request, opts)
|
|
1492
|
+
|
|
1493
|
+
Update the payment information on an auto order
|
|
1494
|
+
|
|
1495
|
+
Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order. Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected. Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
### Examples
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
(No example for this operation).
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
#### Using the update_auto_order_payment_with_http_info variant
|
|
1505
|
+
|
|
1506
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1507
|
+
|
|
1508
|
+
> <Array(<AutoOrderRebillResponse>, Integer, Hash)> update_auto_order_payment_with_http_info(auto_order_oid, auto_order_payment_update_request, opts)
|
|
1509
|
+
|
|
1510
|
+
```ruby
|
|
1511
|
+
begin
|
|
1512
|
+
# Update the payment information on an auto order
|
|
1513
|
+
data, status_code, headers = api_instance.update_auto_order_payment_with_http_info(auto_order_oid, auto_order_payment_update_request, opts)
|
|
1514
|
+
p status_code # => 2xx
|
|
1515
|
+
p headers # => { ... }
|
|
1516
|
+
p data # => <AutoOrderRebillResponse>
|
|
1517
|
+
rescue UltracartClient::ApiError => e
|
|
1518
|
+
puts "Error when calling AutoOrderApi->update_auto_order_payment_with_http_info: #{e}"
|
|
1519
|
+
end
|
|
1520
|
+
```
|
|
1521
|
+
|
|
1522
|
+
### Parameters
|
|
1523
|
+
|
|
1524
|
+
| Name | Type | Description | Notes |
|
|
1525
|
+
| ---- | ---- | ----------- | ----- |
|
|
1526
|
+
| **auto_order_oid** | **Integer** | The auto order oid to update payment information on. | |
|
|
1527
|
+
| **auto_order_payment_update_request** | [**AutoOrderPaymentUpdateRequest**](AutoOrderPaymentUpdateRequest.md) | Payment information to place on the auto order | |
|
|
1528
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
1529
|
+
|
|
1530
|
+
### Return type
|
|
1531
|
+
|
|
1532
|
+
[**AutoOrderRebillResponse**](AutoOrderRebillResponse.md)
|
|
1533
|
+
|
|
1534
|
+
### Authorization
|
|
1535
|
+
|
|
1536
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1537
|
+
|
|
1538
|
+
### HTTP request headers
|
|
1539
|
+
|
|
1540
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1541
|
+
- **Accept**: application/json
|
|
1542
|
+
|
|
1543
|
+
|
|
1433
1544
|
## update_auto_order_properties
|
|
1434
1545
|
|
|
1435
1546
|
> <AutoOrderResponse> update_auto_order_properties(auto_order_oid, auto_order_properties_update_request, opts)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::AutoOrderPaymentUpdateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **attempt_rebill** | **Boolean** | Attempt to rebill the auto order immediately after the payment information is updated. Defaults to false. | [optional] |
|
|
8
|
+
| **card_expiration_month** | **Integer** | Card expiration month (1-12) | [optional] |
|
|
9
|
+
| **card_expiration_year** | **Integer** | Card expiration year (four digit) | [optional] |
|
|
10
|
+
| **card_number_token** | **String** | Hosted field token for the credit card number. Tokens are valid for two hours. | [optional] |
|
|
11
|
+
| **card_type** | **String** | Credit card type. Optional. When the hosted field token carries the card type, the token wins. | [optional] |
|
|
12
|
+
| **card_verification_number_token** | **String** | Hosted field token for the card verification number (CVV). Required when the order has a vaulted card that must be re-vaulted. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ultracart_api'
|
|
18
|
+
|
|
19
|
+
instance = UltracartClient::AutoOrderPaymentUpdateRequest.new(
|
|
20
|
+
attempt_rebill: null,
|
|
21
|
+
card_expiration_month: null,
|
|
22
|
+
card_expiration_year: null,
|
|
23
|
+
card_number_token: null,
|
|
24
|
+
card_type: null,
|
|
25
|
+
card_verification_number_token: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# UltracartClient::AutoOrderRebillResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **auto_order** | [**AutoOrder**](AutoOrder.md) | | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
9
|
+
| **failure_reason** | **String** | Why the rebill attempt did not succeed | [optional] |
|
|
10
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
11
|
+
| **rebill_attempted** | **Boolean** | True if a rebill was attempted during this call | [optional] |
|
|
12
|
+
| **rebill_order_id** | **String** | The order id created by a successful rebill | [optional] |
|
|
13
|
+
| **rebill_success** | **Boolean** | True if the rebill attempt produced an order | [optional] |
|
|
14
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
15
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'ultracart_api'
|
|
21
|
+
|
|
22
|
+
instance = UltracartClient::AutoOrderRebillResponse.new(
|
|
23
|
+
auto_order: null,
|
|
24
|
+
error: null,
|
|
25
|
+
failure_reason: null,
|
|
26
|
+
metadata: null,
|
|
27
|
+
rebill_attempted: null,
|
|
28
|
+
rebill_order_id: null,
|
|
29
|
+
rebill_success: null,
|
|
30
|
+
success: null,
|
|
31
|
+
warning: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
data/docs/EmailDispatchLog.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **detail** | **String** | Dispatch detail text (free-form log of how the customer moved through the step) | [optional] |
|
|
7
8
|
| **email** | **String** | Customer email, resolved from the customer UUID for the page | [optional] |
|
|
8
9
|
| **esp_commseq_step_uuid** | **String** | Communication sequence step UUID | [optional] |
|
|
9
10
|
| **esp_commseq_uuid** | **String** | Communication sequence (flow/campaign) UUID | [optional] |
|
|
@@ -16,6 +17,7 @@
|
|
|
16
17
|
require 'ultracart_api'
|
|
17
18
|
|
|
18
19
|
instance = UltracartClient::EmailDispatchLog.new(
|
|
20
|
+
detail: null,
|
|
19
21
|
email: null,
|
|
20
22
|
esp_commseq_step_uuid: null,
|
|
21
23
|
esp_commseq_uuid: null,
|
data/docs/EmailSettings.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **emails_per_day** | **Integer** | Emails per day allowed | [optional] |
|
|
8
8
|
| **emails_per_hour** | **Integer** | Emails per hour allowed | [optional] |
|
|
9
9
|
| **emails_per_month** | **Integer** | Emails per month allowed | [optional] |
|
|
10
|
+
| **machine_open_ignore** | **Boolean** | If machine open should be ignored | [optional] |
|
|
10
11
|
| **marketing_esp_domain_user** | **String** | | [optional] |
|
|
11
12
|
| **marketing_esp_domain_uuid** | **String** | | [optional] |
|
|
12
13
|
| **marketing_esp_friendly_name** | **String** | | [optional] |
|
|
@@ -33,6 +34,7 @@ instance = UltracartClient::EmailSettings.new(
|
|
|
33
34
|
emails_per_day: null,
|
|
34
35
|
emails_per_hour: null,
|
|
35
36
|
emails_per_month: null,
|
|
37
|
+
machine_open_ignore: null,
|
|
36
38
|
marketing_esp_domain_user: null,
|
|
37
39
|
marketing_esp_domain_uuid: null,
|
|
38
40
|
marketing_esp_friendly_name: null,
|
data/docs/StorefrontApi.md
CHANGED
|
@@ -2993,6 +2993,7 @@ end
|
|
|
2993
2993
|
| **page_number** | **Integer** | | [optional] |
|
|
2994
2994
|
| **page_size** | **Integer** | | [optional] |
|
|
2995
2995
|
| **scan_forward** | **Boolean** | | [optional] |
|
|
2996
|
+
| **include_detail** | **Boolean** | | [optional] |
|
|
2996
2997
|
|
|
2997
2998
|
### Return type
|
|
2998
2999
|
|
|
@@ -5086,7 +5087,7 @@ end
|
|
|
5086
5087
|
|
|
5087
5088
|
Get a paginated, date-boundable dispatch-log feed for a step
|
|
5088
5089
|
|
|
5089
|
-
Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
|
|
5090
|
+
Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
|
|
5090
5091
|
|
|
5091
5092
|
|
|
5092
5093
|
### Examples
|
|
@@ -5124,6 +5125,7 @@ end
|
|
|
5124
5125
|
| **_until** | **String** | | [optional] |
|
|
5125
5126
|
| **page_number** | **Integer** | | [optional] |
|
|
5126
5127
|
| **page_size** | **Integer** | | [optional] |
|
|
5128
|
+
| **include_detail** | **Boolean** | | [optional] |
|
|
5127
5129
|
|
|
5128
5130
|
### Return type
|
|
5129
5131
|
|
|
@@ -32,6 +32,73 @@ module UltracartClient
|
|
|
32
32
|
UltracartClient::AutoOrderApi.new(api_client)
|
|
33
33
|
end
|
|
34
34
|
|
|
35
|
+
# Attempt a failed rebill on an auto order
|
|
36
|
+
# Attempts to rebill an auto order using the payment information already on the original order. The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging. Runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
|
|
37
|
+
# @param auto_order_oid [Integer] The auto order oid to rebill.
|
|
38
|
+
# @param [Hash] opts the optional parameters
|
|
39
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
40
|
+
# @return [AutoOrderRebillResponse]
|
|
41
|
+
def attempt_auto_order_rebill(auto_order_oid, opts = {})
|
|
42
|
+
data, _status_code, _headers = attempt_auto_order_rebill_with_http_info(auto_order_oid, opts)
|
|
43
|
+
data
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# Attempt a failed rebill on an auto order
|
|
47
|
+
# Attempts to rebill an auto order using the payment information already on the original order. The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging. Runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
|
|
48
|
+
# @param auto_order_oid [Integer] The auto order oid to rebill.
|
|
49
|
+
# @param [Hash] opts the optional parameters
|
|
50
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
51
|
+
# @return [Array<(AutoOrderRebillResponse, Integer, Hash)>] AutoOrderRebillResponse data, response status code and response headers
|
|
52
|
+
def attempt_auto_order_rebill_with_http_info(auto_order_oid, opts = {})
|
|
53
|
+
if @api_client.config.debugging
|
|
54
|
+
@api_client.config.logger.debug 'Calling API: AutoOrderApi.attempt_auto_order_rebill ...'
|
|
55
|
+
end
|
|
56
|
+
# verify the required parameter 'auto_order_oid' is set
|
|
57
|
+
if @api_client.config.client_side_validation && auto_order_oid.nil?
|
|
58
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.attempt_auto_order_rebill"
|
|
59
|
+
end
|
|
60
|
+
# resource path
|
|
61
|
+
local_var_path = '/auto_order/auto_orders/{auto_order_oid}/rebill'.sub('{' + 'auto_order_oid' + '}', CGI.escape(auto_order_oid.to_s))
|
|
62
|
+
|
|
63
|
+
# query parameters
|
|
64
|
+
query_params = opts[:query_params] || {}
|
|
65
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
|
66
|
+
|
|
67
|
+
# header parameters
|
|
68
|
+
header_params = opts[:header_params] || {}
|
|
69
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
70
|
+
# HTTP header 'Accept' (if needed)
|
|
71
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
72
|
+
|
|
73
|
+
# form parameters
|
|
74
|
+
form_params = opts[:form_params] || {}
|
|
75
|
+
|
|
76
|
+
# http body (model)
|
|
77
|
+
post_body = opts[:debug_body]
|
|
78
|
+
|
|
79
|
+
# return_type
|
|
80
|
+
return_type = opts[:debug_return_type] || 'AutoOrderRebillResponse'
|
|
81
|
+
|
|
82
|
+
# auth_names
|
|
83
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
84
|
+
|
|
85
|
+
new_options = opts.merge(
|
|
86
|
+
:operation => :"AutoOrderApi.attempt_auto_order_rebill",
|
|
87
|
+
:header_params => header_params,
|
|
88
|
+
:query_params => query_params,
|
|
89
|
+
:form_params => form_params,
|
|
90
|
+
:body => post_body,
|
|
91
|
+
:auth_names => auth_names,
|
|
92
|
+
:return_type => return_type
|
|
93
|
+
)
|
|
94
|
+
|
|
95
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
96
|
+
if @api_client.config.debugging
|
|
97
|
+
@api_client.config.logger.debug "API called: AutoOrderApi#attempt_auto_order_rebill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
98
|
+
end
|
|
99
|
+
return data, status_code, headers
|
|
100
|
+
end
|
|
101
|
+
|
|
35
102
|
# Cancel a single item on an auto order
|
|
36
103
|
# Cancels a single item on an auto order identified by the original order id and the item's original_item_id. The request body may specify mode=_end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.
|
|
37
104
|
# @param reference_order_id [String] The reference order id (original_order_id) of the auto order.
|
|
@@ -1187,6 +1254,84 @@ module UltracartClient
|
|
|
1187
1254
|
return data, status_code, headers
|
|
1188
1255
|
end
|
|
1189
1256
|
|
|
1257
|
+
# Update the payment information on an auto order
|
|
1258
|
+
# Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order. Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected. Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
|
|
1259
|
+
# @param auto_order_oid [Integer] The auto order oid to update payment information on.
|
|
1260
|
+
# @param auto_order_payment_update_request [AutoOrderPaymentUpdateRequest] Payment information to place on the auto order
|
|
1261
|
+
# @param [Hash] opts the optional parameters
|
|
1262
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
1263
|
+
# @return [AutoOrderRebillResponse]
|
|
1264
|
+
def update_auto_order_payment(auto_order_oid, auto_order_payment_update_request, opts = {})
|
|
1265
|
+
data, _status_code, _headers = update_auto_order_payment_with_http_info(auto_order_oid, auto_order_payment_update_request, opts)
|
|
1266
|
+
data
|
|
1267
|
+
end
|
|
1268
|
+
|
|
1269
|
+
# Update the payment information on an auto order
|
|
1270
|
+
# Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order. Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected. Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted. A declined card is reported in the response body rather than as an API error.
|
|
1271
|
+
# @param auto_order_oid [Integer] The auto order oid to update payment information on.
|
|
1272
|
+
# @param auto_order_payment_update_request [AutoOrderPaymentUpdateRequest] Payment information to place on the auto order
|
|
1273
|
+
# @param [Hash] opts the optional parameters
|
|
1274
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
1275
|
+
# @return [Array<(AutoOrderRebillResponse, Integer, Hash)>] AutoOrderRebillResponse data, response status code and response headers
|
|
1276
|
+
def update_auto_order_payment_with_http_info(auto_order_oid, auto_order_payment_update_request, opts = {})
|
|
1277
|
+
if @api_client.config.debugging
|
|
1278
|
+
@api_client.config.logger.debug 'Calling API: AutoOrderApi.update_auto_order_payment ...'
|
|
1279
|
+
end
|
|
1280
|
+
# verify the required parameter 'auto_order_oid' is set
|
|
1281
|
+
if @api_client.config.client_side_validation && auto_order_oid.nil?
|
|
1282
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.update_auto_order_payment"
|
|
1283
|
+
end
|
|
1284
|
+
# verify the required parameter 'auto_order_payment_update_request' is set
|
|
1285
|
+
if @api_client.config.client_side_validation && auto_order_payment_update_request.nil?
|
|
1286
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_payment_update_request' when calling AutoOrderApi.update_auto_order_payment"
|
|
1287
|
+
end
|
|
1288
|
+
# resource path
|
|
1289
|
+
local_var_path = '/auto_order/auto_orders/{auto_order_oid}/payment'.sub('{' + 'auto_order_oid' + '}', CGI.escape(auto_order_oid.to_s))
|
|
1290
|
+
|
|
1291
|
+
# query parameters
|
|
1292
|
+
query_params = opts[:query_params] || {}
|
|
1293
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
|
1294
|
+
|
|
1295
|
+
# header parameters
|
|
1296
|
+
header_params = opts[:header_params] || {}
|
|
1297
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1298
|
+
# HTTP header 'Accept' (if needed)
|
|
1299
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1300
|
+
# HTTP header 'Content-Type'
|
|
1301
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
1302
|
+
if !content_type.nil?
|
|
1303
|
+
header_params['Content-Type'] = content_type
|
|
1304
|
+
end
|
|
1305
|
+
|
|
1306
|
+
# form parameters
|
|
1307
|
+
form_params = opts[:form_params] || {}
|
|
1308
|
+
|
|
1309
|
+
# http body (model)
|
|
1310
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(auto_order_payment_update_request)
|
|
1311
|
+
|
|
1312
|
+
# return_type
|
|
1313
|
+
return_type = opts[:debug_return_type] || 'AutoOrderRebillResponse'
|
|
1314
|
+
|
|
1315
|
+
# auth_names
|
|
1316
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1317
|
+
|
|
1318
|
+
new_options = opts.merge(
|
|
1319
|
+
:operation => :"AutoOrderApi.update_auto_order_payment",
|
|
1320
|
+
:header_params => header_params,
|
|
1321
|
+
:query_params => query_params,
|
|
1322
|
+
:form_params => form_params,
|
|
1323
|
+
:body => post_body,
|
|
1324
|
+
:auth_names => auth_names,
|
|
1325
|
+
:return_type => return_type
|
|
1326
|
+
)
|
|
1327
|
+
|
|
1328
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1329
|
+
if @api_client.config.debugging
|
|
1330
|
+
@api_client.config.logger.debug "API called: AutoOrderApi#update_auto_order_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1331
|
+
end
|
|
1332
|
+
return data, status_code, headers
|
|
1333
|
+
end
|
|
1334
|
+
|
|
1190
1335
|
# Update an auto order properties
|
|
1191
1336
|
# Update an auto order properties. Returns the auto order based upon expansion
|
|
1192
1337
|
# @param auto_order_oid [Integer] The auto order oid to update.
|
|
@@ -3611,6 +3611,7 @@ module UltracartClient
|
|
|
3611
3611
|
# @option opts [Integer] :page_number
|
|
3612
3612
|
# @option opts [Integer] :page_size
|
|
3613
3613
|
# @option opts [Boolean] :scan_forward
|
|
3614
|
+
# @option opts [Boolean] :include_detail
|
|
3614
3615
|
# @return [EmailDispatchLogsResponse]
|
|
3615
3616
|
def get_email_customer_dispatch_logs(storefront_oid, email_customer_uuid, opts = {})
|
|
3616
3617
|
data, _status_code, _headers = get_email_customer_dispatch_logs_with_http_info(storefront_oid, email_customer_uuid, opts)
|
|
@@ -3627,6 +3628,7 @@ module UltracartClient
|
|
|
3627
3628
|
# @option opts [Integer] :page_number
|
|
3628
3629
|
# @option opts [Integer] :page_size
|
|
3629
3630
|
# @option opts [Boolean] :scan_forward
|
|
3631
|
+
# @option opts [Boolean] :include_detail
|
|
3630
3632
|
# @return [Array<(EmailDispatchLogsResponse, Integer, Hash)>] EmailDispatchLogsResponse data, response status code and response headers
|
|
3631
3633
|
def get_email_customer_dispatch_logs_with_http_info(storefront_oid, email_customer_uuid, opts = {})
|
|
3632
3634
|
if @api_client.config.debugging
|
|
@@ -3650,6 +3652,7 @@ module UltracartClient
|
|
|
3650
3652
|
query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
|
|
3651
3653
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
3652
3654
|
query_params[:'scanForward'] = opts[:'scan_forward'] if !opts[:'scan_forward'].nil?
|
|
3655
|
+
query_params[:'includeDetail'] = opts[:'include_detail'] if !opts[:'include_detail'].nil?
|
|
3653
3656
|
|
|
3654
3657
|
# header parameters
|
|
3655
3658
|
header_params = opts[:header_params] || {}
|
|
@@ -6338,7 +6341,7 @@ module UltracartClient
|
|
|
6338
6341
|
end
|
|
6339
6342
|
|
|
6340
6343
|
# Get a paginated, date-boundable dispatch-log feed for a step
|
|
6341
|
-
# Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
|
|
6344
|
+
# Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
|
|
6342
6345
|
# @param storefront_oid [Integer]
|
|
6343
6346
|
# @param commseq_uuid [String]
|
|
6344
6347
|
# @param commseq_step_uuid [String]
|
|
@@ -6347,6 +6350,7 @@ module UltracartClient
|
|
|
6347
6350
|
# @option opts [String] :_until
|
|
6348
6351
|
# @option opts [Integer] :page_number
|
|
6349
6352
|
# @option opts [Integer] :page_size
|
|
6353
|
+
# @option opts [Boolean] :include_detail
|
|
6350
6354
|
# @return [EmailDispatchLogsResponse]
|
|
6351
6355
|
def get_email_step_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
|
|
6352
6356
|
data, _status_code, _headers = get_email_step_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
|
@@ -6354,7 +6358,7 @@ module UltracartClient
|
|
|
6354
6358
|
end
|
|
6355
6359
|
|
|
6356
6360
|
# Get a paginated, date-boundable dispatch-log feed for a step
|
|
6357
|
-
# Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
|
|
6361
|
+
# Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
|
|
6358
6362
|
# @param storefront_oid [Integer]
|
|
6359
6363
|
# @param commseq_uuid [String]
|
|
6360
6364
|
# @param commseq_step_uuid [String]
|
|
@@ -6363,6 +6367,7 @@ module UltracartClient
|
|
|
6363
6367
|
# @option opts [String] :_until
|
|
6364
6368
|
# @option opts [Integer] :page_number
|
|
6365
6369
|
# @option opts [Integer] :page_size
|
|
6370
|
+
# @option opts [Boolean] :include_detail
|
|
6366
6371
|
# @return [Array<(EmailDispatchLogsResponse, Integer, Hash)>] EmailDispatchLogsResponse data, response status code and response headers
|
|
6367
6372
|
def get_email_step_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
|
|
6368
6373
|
if @api_client.config.debugging
|
|
@@ -6389,6 +6394,7 @@ module UltracartClient
|
|
|
6389
6394
|
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
6390
6395
|
query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
|
|
6391
6396
|
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
6397
|
+
query_params[:'includeDetail'] = opts[:'include_detail'] if !opts[:'include_detail'].nil?
|
|
6392
6398
|
|
|
6393
6399
|
# header parameters
|
|
6394
6400
|
header_params = opts[:header_params] || {}
|
|
@@ -0,0 +1,304 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#UltraCart Rest API V2
|
|
3
|
+
|
|
4
|
+
#UltraCart REST API Version 2
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
Contact: support@ultracart.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module UltracartClient
|
|
17
|
+
class AutoOrderPaymentUpdateRequest
|
|
18
|
+
# Attempt to rebill the auto order immediately after the payment information is updated. Defaults to false.
|
|
19
|
+
attr_accessor :attempt_rebill
|
|
20
|
+
|
|
21
|
+
# Card expiration month (1-12)
|
|
22
|
+
attr_accessor :card_expiration_month
|
|
23
|
+
|
|
24
|
+
# Card expiration year (four digit)
|
|
25
|
+
attr_accessor :card_expiration_year
|
|
26
|
+
|
|
27
|
+
# Hosted field token for the credit card number. Tokens are valid for two hours.
|
|
28
|
+
attr_accessor :card_number_token
|
|
29
|
+
|
|
30
|
+
# Credit card type. Optional. When the hosted field token carries the card type, the token wins.
|
|
31
|
+
attr_accessor :card_type
|
|
32
|
+
|
|
33
|
+
# Hosted field token for the card verification number (CVV). Required when the order has a vaulted card that must be re-vaulted.
|
|
34
|
+
attr_accessor :card_verification_number_token
|
|
35
|
+
|
|
36
|
+
class EnumAttributeValidator
|
|
37
|
+
attr_reader :datatype
|
|
38
|
+
attr_reader :allowable_values
|
|
39
|
+
|
|
40
|
+
def initialize(datatype, allowable_values)
|
|
41
|
+
@allowable_values = allowable_values.map do |value|
|
|
42
|
+
case datatype.to_s
|
|
43
|
+
when /Integer/i
|
|
44
|
+
value.to_i
|
|
45
|
+
when /Float/i
|
|
46
|
+
value.to_f
|
|
47
|
+
else
|
|
48
|
+
value
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def valid?(value)
|
|
54
|
+
!value || allowable_values.include?(value)
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
59
|
+
def self.attribute_map
|
|
60
|
+
{
|
|
61
|
+
:'attempt_rebill' => :'attempt_rebill',
|
|
62
|
+
:'card_expiration_month' => :'card_expiration_month',
|
|
63
|
+
:'card_expiration_year' => :'card_expiration_year',
|
|
64
|
+
:'card_number_token' => :'card_number_token',
|
|
65
|
+
:'card_type' => :'card_type',
|
|
66
|
+
:'card_verification_number_token' => :'card_verification_number_token'
|
|
67
|
+
}
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
# Returns all the JSON keys this model knows about
|
|
71
|
+
def self.acceptable_attributes
|
|
72
|
+
attribute_map.values
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# Attribute type mapping.
|
|
76
|
+
def self.openapi_types
|
|
77
|
+
{
|
|
78
|
+
:'attempt_rebill' => :'Boolean',
|
|
79
|
+
:'card_expiration_month' => :'Integer',
|
|
80
|
+
:'card_expiration_year' => :'Integer',
|
|
81
|
+
:'card_number_token' => :'String',
|
|
82
|
+
:'card_type' => :'String',
|
|
83
|
+
:'card_verification_number_token' => :'String'
|
|
84
|
+
}
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# List of attributes with nullable: true
|
|
88
|
+
def self.openapi_nullable
|
|
89
|
+
Set.new([
|
|
90
|
+
])
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# Initializes the object
|
|
94
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
95
|
+
def initialize(attributes = {})
|
|
96
|
+
if (!attributes.is_a?(Hash))
|
|
97
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::AutoOrderPaymentUpdateRequest` initialize method"
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
101
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
102
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
103
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::AutoOrderPaymentUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
104
|
+
end
|
|
105
|
+
h[k.to_sym] = v
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
if attributes.key?(:'attempt_rebill')
|
|
109
|
+
self.attempt_rebill = attributes[:'attempt_rebill']
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
if attributes.key?(:'card_expiration_month')
|
|
113
|
+
self.card_expiration_month = attributes[:'card_expiration_month']
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
if attributes.key?(:'card_expiration_year')
|
|
117
|
+
self.card_expiration_year = attributes[:'card_expiration_year']
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
if attributes.key?(:'card_number_token')
|
|
121
|
+
self.card_number_token = attributes[:'card_number_token']
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
if attributes.key?(:'card_type')
|
|
125
|
+
self.card_type = attributes[:'card_type']
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
if attributes.key?(:'card_verification_number_token')
|
|
129
|
+
self.card_verification_number_token = attributes[:'card_verification_number_token']
|
|
130
|
+
end
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
134
|
+
# @return Array for valid properties with the reasons
|
|
135
|
+
def list_invalid_properties
|
|
136
|
+
invalid_properties = Array.new
|
|
137
|
+
invalid_properties
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
# Check to see if the all the properties in the model are valid
|
|
141
|
+
# @return true if the model is valid
|
|
142
|
+
def valid?
|
|
143
|
+
card_type_validator = EnumAttributeValidator.new('String', ["AMEX", "Diners Club", "Discover", "JCB", "MasterCard", "VISA"])
|
|
144
|
+
return false unless card_type_validator.valid?(@card_type)
|
|
145
|
+
true
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
149
|
+
# @param [Object] card_type Object to be assigned
|
|
150
|
+
def card_type=(card_type)
|
|
151
|
+
validator = EnumAttributeValidator.new('String', ["AMEX", "Diners Club", "Discover", "JCB", "MasterCard", "VISA"])
|
|
152
|
+
unless validator.valid?(card_type)
|
|
153
|
+
fail ArgumentError, "invalid value for \"card_type\", must be one of #{validator.allowable_values}."
|
|
154
|
+
end
|
|
155
|
+
@card_type = card_type
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Checks equality by comparing each attribute.
|
|
159
|
+
# @param [Object] Object to be compared
|
|
160
|
+
def ==(o)
|
|
161
|
+
return true if self.equal?(o)
|
|
162
|
+
self.class == o.class &&
|
|
163
|
+
attempt_rebill == o.attempt_rebill &&
|
|
164
|
+
card_expiration_month == o.card_expiration_month &&
|
|
165
|
+
card_expiration_year == o.card_expiration_year &&
|
|
166
|
+
card_number_token == o.card_number_token &&
|
|
167
|
+
card_type == o.card_type &&
|
|
168
|
+
card_verification_number_token == o.card_verification_number_token
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# @see the `==` method
|
|
172
|
+
# @param [Object] Object to be compared
|
|
173
|
+
def eql?(o)
|
|
174
|
+
self == o
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Calculates hash code according to all attributes.
|
|
178
|
+
# @return [Integer] Hash code
|
|
179
|
+
def hash
|
|
180
|
+
[attempt_rebill, card_expiration_month, card_expiration_year, card_number_token, card_type, card_verification_number_token].hash
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
# Builds the object from hash
|
|
184
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
185
|
+
# @return [Object] Returns the model itself
|
|
186
|
+
def self.build_from_hash(attributes)
|
|
187
|
+
new.build_from_hash(attributes)
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
# Builds the object from hash
|
|
191
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
192
|
+
# @return [Object] Returns the model itself
|
|
193
|
+
def build_from_hash(attributes)
|
|
194
|
+
return nil unless attributes.is_a?(Hash)
|
|
195
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
196
|
+
self.class.openapi_types.each_pair do |key, type|
|
|
197
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
198
|
+
self.send("#{key}=", nil)
|
|
199
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
200
|
+
# check to ensure the input is an array given that the attribute
|
|
201
|
+
# is documented as an array but the input is not
|
|
202
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
203
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
204
|
+
end
|
|
205
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
206
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
207
|
+
end
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
self
|
|
211
|
+
end
|
|
212
|
+
|
|
213
|
+
# Deserializes the data based on type
|
|
214
|
+
# @param string type Data type
|
|
215
|
+
# @param string value Value to be deserialized
|
|
216
|
+
# @return [Object] Deserialized data
|
|
217
|
+
def _deserialize(type, value)
|
|
218
|
+
case type.to_sym
|
|
219
|
+
when :Time
|
|
220
|
+
Time.parse(value)
|
|
221
|
+
when :Date
|
|
222
|
+
Date.parse(value)
|
|
223
|
+
when :String
|
|
224
|
+
value.to_s
|
|
225
|
+
when :Integer
|
|
226
|
+
value.to_i
|
|
227
|
+
when :Float
|
|
228
|
+
value.to_f
|
|
229
|
+
when :Boolean
|
|
230
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
231
|
+
true
|
|
232
|
+
else
|
|
233
|
+
false
|
|
234
|
+
end
|
|
235
|
+
when :Object
|
|
236
|
+
# generic object (usually a Hash), return directly
|
|
237
|
+
value
|
|
238
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
239
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
240
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
241
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
242
|
+
k_type = Regexp.last_match[:k_type]
|
|
243
|
+
v_type = Regexp.last_match[:v_type]
|
|
244
|
+
{}.tap do |hash|
|
|
245
|
+
value.each do |k, v|
|
|
246
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
247
|
+
end
|
|
248
|
+
end
|
|
249
|
+
else # model
|
|
250
|
+
# models (e.g. Pet) or oneOf
|
|
251
|
+
klass = UltracartClient.const_get(type)
|
|
252
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
253
|
+
end
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
# Returns the string representation of the object
|
|
257
|
+
# @return [String] String presentation of the object
|
|
258
|
+
def to_s
|
|
259
|
+
to_hash.to_s
|
|
260
|
+
end
|
|
261
|
+
|
|
262
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
263
|
+
# @return [Hash] Returns the object in the form of hash
|
|
264
|
+
def to_body
|
|
265
|
+
to_hash
|
|
266
|
+
end
|
|
267
|
+
|
|
268
|
+
# Returns the object in the form of hash
|
|
269
|
+
# @return [Hash] Returns the object in the form of hash
|
|
270
|
+
def to_hash
|
|
271
|
+
hash = {}
|
|
272
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
273
|
+
value = self.send(attr)
|
|
274
|
+
if value.nil?
|
|
275
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
276
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
277
|
+
end
|
|
278
|
+
|
|
279
|
+
hash[param] = _to_hash(value)
|
|
280
|
+
end
|
|
281
|
+
hash
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
# Outputs non-array value in the form of hash
|
|
285
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
286
|
+
# @param [Object] value Any valid value
|
|
287
|
+
# @return [Hash] Returns the value in the form of hash
|
|
288
|
+
def _to_hash(value)
|
|
289
|
+
if value.is_a?(Array)
|
|
290
|
+
value.compact.map { |v| _to_hash(v) }
|
|
291
|
+
elsif value.is_a?(Hash)
|
|
292
|
+
{}.tap do |hash|
|
|
293
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
294
|
+
end
|
|
295
|
+
elsif value.respond_to? :to_hash
|
|
296
|
+
value.to_hash
|
|
297
|
+
else
|
|
298
|
+
value
|
|
299
|
+
end
|
|
300
|
+
end
|
|
301
|
+
|
|
302
|
+
end
|
|
303
|
+
|
|
304
|
+
end
|
|
@@ -0,0 +1,296 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#UltraCart Rest API V2
|
|
3
|
+
|
|
4
|
+
#UltraCart REST API Version 2
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
Contact: support@ultracart.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module UltracartClient
|
|
17
|
+
class AutoOrderRebillResponse
|
|
18
|
+
attr_accessor :auto_order
|
|
19
|
+
|
|
20
|
+
attr_accessor :error
|
|
21
|
+
|
|
22
|
+
# Why the rebill attempt did not succeed
|
|
23
|
+
attr_accessor :failure_reason
|
|
24
|
+
|
|
25
|
+
attr_accessor :metadata
|
|
26
|
+
|
|
27
|
+
# True if a rebill was attempted during this call
|
|
28
|
+
attr_accessor :rebill_attempted
|
|
29
|
+
|
|
30
|
+
# The order id created by a successful rebill
|
|
31
|
+
attr_accessor :rebill_order_id
|
|
32
|
+
|
|
33
|
+
# True if the rebill attempt produced an order
|
|
34
|
+
attr_accessor :rebill_success
|
|
35
|
+
|
|
36
|
+
# Indicates if API call was successful
|
|
37
|
+
attr_accessor :success
|
|
38
|
+
|
|
39
|
+
attr_accessor :warning
|
|
40
|
+
|
|
41
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
42
|
+
def self.attribute_map
|
|
43
|
+
{
|
|
44
|
+
:'auto_order' => :'auto_order',
|
|
45
|
+
:'error' => :'error',
|
|
46
|
+
:'failure_reason' => :'failure_reason',
|
|
47
|
+
:'metadata' => :'metadata',
|
|
48
|
+
:'rebill_attempted' => :'rebill_attempted',
|
|
49
|
+
:'rebill_order_id' => :'rebill_order_id',
|
|
50
|
+
:'rebill_success' => :'rebill_success',
|
|
51
|
+
:'success' => :'success',
|
|
52
|
+
:'warning' => :'warning'
|
|
53
|
+
}
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
# Returns all the JSON keys this model knows about
|
|
57
|
+
def self.acceptable_attributes
|
|
58
|
+
attribute_map.values
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# Attribute type mapping.
|
|
62
|
+
def self.openapi_types
|
|
63
|
+
{
|
|
64
|
+
:'auto_order' => :'AutoOrder',
|
|
65
|
+
:'error' => :'Error',
|
|
66
|
+
:'failure_reason' => :'String',
|
|
67
|
+
:'metadata' => :'ResponseMetadata',
|
|
68
|
+
:'rebill_attempted' => :'Boolean',
|
|
69
|
+
:'rebill_order_id' => :'String',
|
|
70
|
+
:'rebill_success' => :'Boolean',
|
|
71
|
+
:'success' => :'Boolean',
|
|
72
|
+
:'warning' => :'Warning'
|
|
73
|
+
}
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# List of attributes with nullable: true
|
|
77
|
+
def self.openapi_nullable
|
|
78
|
+
Set.new([
|
|
79
|
+
])
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# Initializes the object
|
|
83
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
84
|
+
def initialize(attributes = {})
|
|
85
|
+
if (!attributes.is_a?(Hash))
|
|
86
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::AutoOrderRebillResponse` initialize method"
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
90
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
91
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
92
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::AutoOrderRebillResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
93
|
+
end
|
|
94
|
+
h[k.to_sym] = v
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
if attributes.key?(:'auto_order')
|
|
98
|
+
self.auto_order = attributes[:'auto_order']
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
if attributes.key?(:'error')
|
|
102
|
+
self.error = attributes[:'error']
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
if attributes.key?(:'failure_reason')
|
|
106
|
+
self.failure_reason = attributes[:'failure_reason']
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
if attributes.key?(:'metadata')
|
|
110
|
+
self.metadata = attributes[:'metadata']
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
if attributes.key?(:'rebill_attempted')
|
|
114
|
+
self.rebill_attempted = attributes[:'rebill_attempted']
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
if attributes.key?(:'rebill_order_id')
|
|
118
|
+
self.rebill_order_id = attributes[:'rebill_order_id']
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
if attributes.key?(:'rebill_success')
|
|
122
|
+
self.rebill_success = attributes[:'rebill_success']
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
if attributes.key?(:'success')
|
|
126
|
+
self.success = attributes[:'success']
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
if attributes.key?(:'warning')
|
|
130
|
+
self.warning = attributes[:'warning']
|
|
131
|
+
end
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
135
|
+
# @return Array for valid properties with the reasons
|
|
136
|
+
def list_invalid_properties
|
|
137
|
+
invalid_properties = Array.new
|
|
138
|
+
invalid_properties
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
# Check to see if the all the properties in the model are valid
|
|
142
|
+
# @return true if the model is valid
|
|
143
|
+
def valid?
|
|
144
|
+
true
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# Checks equality by comparing each attribute.
|
|
148
|
+
# @param [Object] Object to be compared
|
|
149
|
+
def ==(o)
|
|
150
|
+
return true if self.equal?(o)
|
|
151
|
+
self.class == o.class &&
|
|
152
|
+
auto_order == o.auto_order &&
|
|
153
|
+
error == o.error &&
|
|
154
|
+
failure_reason == o.failure_reason &&
|
|
155
|
+
metadata == o.metadata &&
|
|
156
|
+
rebill_attempted == o.rebill_attempted &&
|
|
157
|
+
rebill_order_id == o.rebill_order_id &&
|
|
158
|
+
rebill_success == o.rebill_success &&
|
|
159
|
+
success == o.success &&
|
|
160
|
+
warning == o.warning
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
# @see the `==` method
|
|
164
|
+
# @param [Object] Object to be compared
|
|
165
|
+
def eql?(o)
|
|
166
|
+
self == o
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
# Calculates hash code according to all attributes.
|
|
170
|
+
# @return [Integer] Hash code
|
|
171
|
+
def hash
|
|
172
|
+
[auto_order, error, failure_reason, metadata, rebill_attempted, rebill_order_id, rebill_success, success, warning].hash
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
# Builds the object from hash
|
|
176
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
177
|
+
# @return [Object] Returns the model itself
|
|
178
|
+
def self.build_from_hash(attributes)
|
|
179
|
+
new.build_from_hash(attributes)
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
# Builds the object from hash
|
|
183
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
184
|
+
# @return [Object] Returns the model itself
|
|
185
|
+
def build_from_hash(attributes)
|
|
186
|
+
return nil unless attributes.is_a?(Hash)
|
|
187
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
188
|
+
self.class.openapi_types.each_pair do |key, type|
|
|
189
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
190
|
+
self.send("#{key}=", nil)
|
|
191
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
192
|
+
# check to ensure the input is an array given that the attribute
|
|
193
|
+
# is documented as an array but the input is not
|
|
194
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
195
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
196
|
+
end
|
|
197
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
198
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
199
|
+
end
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
self
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
# Deserializes the data based on type
|
|
206
|
+
# @param string type Data type
|
|
207
|
+
# @param string value Value to be deserialized
|
|
208
|
+
# @return [Object] Deserialized data
|
|
209
|
+
def _deserialize(type, value)
|
|
210
|
+
case type.to_sym
|
|
211
|
+
when :Time
|
|
212
|
+
Time.parse(value)
|
|
213
|
+
when :Date
|
|
214
|
+
Date.parse(value)
|
|
215
|
+
when :String
|
|
216
|
+
value.to_s
|
|
217
|
+
when :Integer
|
|
218
|
+
value.to_i
|
|
219
|
+
when :Float
|
|
220
|
+
value.to_f
|
|
221
|
+
when :Boolean
|
|
222
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
223
|
+
true
|
|
224
|
+
else
|
|
225
|
+
false
|
|
226
|
+
end
|
|
227
|
+
when :Object
|
|
228
|
+
# generic object (usually a Hash), return directly
|
|
229
|
+
value
|
|
230
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
231
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
232
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
233
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
234
|
+
k_type = Regexp.last_match[:k_type]
|
|
235
|
+
v_type = Regexp.last_match[:v_type]
|
|
236
|
+
{}.tap do |hash|
|
|
237
|
+
value.each do |k, v|
|
|
238
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
239
|
+
end
|
|
240
|
+
end
|
|
241
|
+
else # model
|
|
242
|
+
# models (e.g. Pet) or oneOf
|
|
243
|
+
klass = UltracartClient.const_get(type)
|
|
244
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
245
|
+
end
|
|
246
|
+
end
|
|
247
|
+
|
|
248
|
+
# Returns the string representation of the object
|
|
249
|
+
# @return [String] String presentation of the object
|
|
250
|
+
def to_s
|
|
251
|
+
to_hash.to_s
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
255
|
+
# @return [Hash] Returns the object in the form of hash
|
|
256
|
+
def to_body
|
|
257
|
+
to_hash
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
# Returns the object in the form of hash
|
|
261
|
+
# @return [Hash] Returns the object in the form of hash
|
|
262
|
+
def to_hash
|
|
263
|
+
hash = {}
|
|
264
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
265
|
+
value = self.send(attr)
|
|
266
|
+
if value.nil?
|
|
267
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
268
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
269
|
+
end
|
|
270
|
+
|
|
271
|
+
hash[param] = _to_hash(value)
|
|
272
|
+
end
|
|
273
|
+
hash
|
|
274
|
+
end
|
|
275
|
+
|
|
276
|
+
# Outputs non-array value in the form of hash
|
|
277
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
278
|
+
# @param [Object] value Any valid value
|
|
279
|
+
# @return [Hash] Returns the value in the form of hash
|
|
280
|
+
def _to_hash(value)
|
|
281
|
+
if value.is_a?(Array)
|
|
282
|
+
value.compact.map { |v| _to_hash(v) }
|
|
283
|
+
elsif value.is_a?(Hash)
|
|
284
|
+
{}.tap do |hash|
|
|
285
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
286
|
+
end
|
|
287
|
+
elsif value.respond_to? :to_hash
|
|
288
|
+
value.to_hash
|
|
289
|
+
else
|
|
290
|
+
value
|
|
291
|
+
end
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
end
|
|
@@ -15,6 +15,9 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module UltracartClient
|
|
17
17
|
class EmailDispatchLog
|
|
18
|
+
# Dispatch detail text (free-form log of how the customer moved through the step)
|
|
19
|
+
attr_accessor :detail
|
|
20
|
+
|
|
18
21
|
# Customer email, resolved from the customer UUID for the page
|
|
19
22
|
attr_accessor :email
|
|
20
23
|
|
|
@@ -33,6 +36,7 @@ module UltracartClient
|
|
|
33
36
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
34
37
|
def self.attribute_map
|
|
35
38
|
{
|
|
39
|
+
:'detail' => :'detail',
|
|
36
40
|
:'email' => :'email',
|
|
37
41
|
:'esp_commseq_step_uuid' => :'esp_commseq_step_uuid',
|
|
38
42
|
:'esp_commseq_uuid' => :'esp_commseq_uuid',
|
|
@@ -49,6 +53,7 @@ module UltracartClient
|
|
|
49
53
|
# Attribute type mapping.
|
|
50
54
|
def self.openapi_types
|
|
51
55
|
{
|
|
56
|
+
:'detail' => :'String',
|
|
52
57
|
:'email' => :'String',
|
|
53
58
|
:'esp_commseq_step_uuid' => :'String',
|
|
54
59
|
:'esp_commseq_uuid' => :'String',
|
|
@@ -78,6 +83,10 @@ module UltracartClient
|
|
|
78
83
|
h[k.to_sym] = v
|
|
79
84
|
}
|
|
80
85
|
|
|
86
|
+
if attributes.key?(:'detail')
|
|
87
|
+
self.detail = attributes[:'detail']
|
|
88
|
+
end
|
|
89
|
+
|
|
81
90
|
if attributes.key?(:'email')
|
|
82
91
|
self.email = attributes[:'email']
|
|
83
92
|
end
|
|
@@ -117,6 +126,7 @@ module UltracartClient
|
|
|
117
126
|
def ==(o)
|
|
118
127
|
return true if self.equal?(o)
|
|
119
128
|
self.class == o.class &&
|
|
129
|
+
detail == o.detail &&
|
|
120
130
|
email == o.email &&
|
|
121
131
|
esp_commseq_step_uuid == o.esp_commseq_step_uuid &&
|
|
122
132
|
esp_commseq_uuid == o.esp_commseq_uuid &&
|
|
@@ -133,7 +143,7 @@ module UltracartClient
|
|
|
133
143
|
# Calculates hash code according to all attributes.
|
|
134
144
|
# @return [Integer] Hash code
|
|
135
145
|
def hash
|
|
136
|
-
[email, esp_commseq_step_uuid, esp_commseq_uuid, esp_customer_uuid, log_dts].hash
|
|
146
|
+
[detail, email, esp_commseq_step_uuid, esp_commseq_uuid, esp_customer_uuid, log_dts].hash
|
|
137
147
|
end
|
|
138
148
|
|
|
139
149
|
# Builds the object from hash
|
|
@@ -24,6 +24,9 @@ module UltracartClient
|
|
|
24
24
|
# Emails per month allowed
|
|
25
25
|
attr_accessor :emails_per_month
|
|
26
26
|
|
|
27
|
+
# If machine open should be ignored
|
|
28
|
+
attr_accessor :machine_open_ignore
|
|
29
|
+
|
|
27
30
|
attr_accessor :marketing_esp_domain_user
|
|
28
31
|
|
|
29
32
|
attr_accessor :marketing_esp_domain_uuid
|
|
@@ -64,6 +67,7 @@ module UltracartClient
|
|
|
64
67
|
:'emails_per_day' => :'emails_per_day',
|
|
65
68
|
:'emails_per_hour' => :'emails_per_hour',
|
|
66
69
|
:'emails_per_month' => :'emails_per_month',
|
|
70
|
+
:'machine_open_ignore' => :'machine_open_ignore',
|
|
67
71
|
:'marketing_esp_domain_user' => :'marketing_esp_domain_user',
|
|
68
72
|
:'marketing_esp_domain_uuid' => :'marketing_esp_domain_uuid',
|
|
69
73
|
:'marketing_esp_friendly_name' => :'marketing_esp_friendly_name',
|
|
@@ -94,6 +98,7 @@ module UltracartClient
|
|
|
94
98
|
:'emails_per_day' => :'Integer',
|
|
95
99
|
:'emails_per_hour' => :'Integer',
|
|
96
100
|
:'emails_per_month' => :'Integer',
|
|
101
|
+
:'machine_open_ignore' => :'Boolean',
|
|
97
102
|
:'marketing_esp_domain_user' => :'String',
|
|
98
103
|
:'marketing_esp_domain_uuid' => :'String',
|
|
99
104
|
:'marketing_esp_friendly_name' => :'String',
|
|
@@ -146,6 +151,10 @@ module UltracartClient
|
|
|
146
151
|
self.emails_per_month = attributes[:'emails_per_month']
|
|
147
152
|
end
|
|
148
153
|
|
|
154
|
+
if attributes.key?(:'machine_open_ignore')
|
|
155
|
+
self.machine_open_ignore = attributes[:'machine_open_ignore']
|
|
156
|
+
end
|
|
157
|
+
|
|
149
158
|
if attributes.key?(:'marketing_esp_domain_user')
|
|
150
159
|
self.marketing_esp_domain_user = attributes[:'marketing_esp_domain_user']
|
|
151
160
|
end
|
|
@@ -232,6 +241,7 @@ module UltracartClient
|
|
|
232
241
|
emails_per_day == o.emails_per_day &&
|
|
233
242
|
emails_per_hour == o.emails_per_hour &&
|
|
234
243
|
emails_per_month == o.emails_per_month &&
|
|
244
|
+
machine_open_ignore == o.machine_open_ignore &&
|
|
235
245
|
marketing_esp_domain_user == o.marketing_esp_domain_user &&
|
|
236
246
|
marketing_esp_domain_uuid == o.marketing_esp_domain_uuid &&
|
|
237
247
|
marketing_esp_friendly_name == o.marketing_esp_friendly_name &&
|
|
@@ -259,7 +269,7 @@ module UltracartClient
|
|
|
259
269
|
# Calculates hash code according to all attributes.
|
|
260
270
|
# @return [Integer] Hash code
|
|
261
271
|
def hash
|
|
262
|
-
[emails_per_day, emails_per_hour, emails_per_month, marketing_esp_domain_user, marketing_esp_domain_uuid, marketing_esp_friendly_name, postcard_from_address1, postcard_from_address2, postcard_from_city, postcard_from_name, postcard_from_postal_code, postcard_from_state, require_order_within_last, reviews_io_configured, sms_esp_twilio_uuid, sms_phone_number, transactional_esp_domain_user, transactional_esp_domain_uuid, transactional_esp_friendly_name].hash
|
|
272
|
+
[emails_per_day, emails_per_hour, emails_per_month, machine_open_ignore, marketing_esp_domain_user, marketing_esp_domain_uuid, marketing_esp_friendly_name, postcard_from_address1, postcard_from_address2, postcard_from_city, postcard_from_name, postcard_from_postal_code, postcard_from_state, require_order_within_last, reviews_io_configured, sms_esp_twilio_uuid, sms_phone_number, transactional_esp_domain_user, transactional_esp_domain_uuid, transactional_esp_friendly_name].hash
|
|
263
273
|
end
|
|
264
274
|
|
|
265
275
|
# Builds the object from hash
|
data/lib/ultracart_api.rb
CHANGED
|
@@ -64,10 +64,12 @@ require 'ultracart_api/models/auto_order_item_option'
|
|
|
64
64
|
require 'ultracart_api/models/auto_order_item_simple_schedule'
|
|
65
65
|
require 'ultracart_api/models/auto_order_log'
|
|
66
66
|
require 'ultracart_api/models/auto_order_management'
|
|
67
|
+
require 'ultracart_api/models/auto_order_payment_update_request'
|
|
67
68
|
require 'ultracart_api/models/auto_order_properties_update_request'
|
|
68
69
|
require 'ultracart_api/models/auto_order_property'
|
|
69
70
|
require 'ultracart_api/models/auto_order_query'
|
|
70
71
|
require 'ultracart_api/models/auto_order_query_batch'
|
|
72
|
+
require 'ultracart_api/models/auto_order_rebill_response'
|
|
71
73
|
require 'ultracart_api/models/auto_order_response'
|
|
72
74
|
require 'ultracart_api/models/auto_orders_request'
|
|
73
75
|
require 'ultracart_api/models/auto_orders_response'
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ultracart_api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.1.
|
|
4
|
+
version: 4.1.122
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-07-
|
|
11
|
+
date: 2026-07-29 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|
|
@@ -110,10 +110,12 @@ files:
|
|
|
110
110
|
- docs/AutoOrderItemSimpleSchedule.md
|
|
111
111
|
- docs/AutoOrderLog.md
|
|
112
112
|
- docs/AutoOrderManagement.md
|
|
113
|
+
- docs/AutoOrderPaymentUpdateRequest.md
|
|
113
114
|
- docs/AutoOrderPropertiesUpdateRequest.md
|
|
114
115
|
- docs/AutoOrderProperty.md
|
|
115
116
|
- docs/AutoOrderQuery.md
|
|
116
117
|
- docs/AutoOrderQueryBatch.md
|
|
118
|
+
- docs/AutoOrderRebillResponse.md
|
|
117
119
|
- docs/AutoOrderResponse.md
|
|
118
120
|
- docs/AutoOrdersRequest.md
|
|
119
121
|
- docs/AutoOrdersResponse.md
|
|
@@ -1190,10 +1192,12 @@ files:
|
|
|
1190
1192
|
- lib/ultracart_api/models/auto_order_item_simple_schedule.rb
|
|
1191
1193
|
- lib/ultracart_api/models/auto_order_log.rb
|
|
1192
1194
|
- lib/ultracart_api/models/auto_order_management.rb
|
|
1195
|
+
- lib/ultracart_api/models/auto_order_payment_update_request.rb
|
|
1193
1196
|
- lib/ultracart_api/models/auto_order_properties_update_request.rb
|
|
1194
1197
|
- lib/ultracart_api/models/auto_order_property.rb
|
|
1195
1198
|
- lib/ultracart_api/models/auto_order_query.rb
|
|
1196
1199
|
- lib/ultracart_api/models/auto_order_query_batch.rb
|
|
1200
|
+
- lib/ultracart_api/models/auto_order_rebill_response.rb
|
|
1197
1201
|
- lib/ultracart_api/models/auto_order_response.rb
|
|
1198
1202
|
- lib/ultracart_api/models/auto_orders_request.rb
|
|
1199
1203
|
- lib/ultracart_api/models/auto_orders_response.rb
|