ultracart_api 4.0.240 → 4.0.242
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 +9 -6
- data/docs/ChannelPartnerOrder.md +2 -0
- data/docs/CustomerAttachment.md +1 -1
- data/docs/FulfillmentApi.md +5 -5
- data/docs/ItemPaymentProcessing.md +2 -0
- data/docs/ItemReview.md +2 -0
- data/docs/OauthApi.md +2 -2
- data/docs/Order.md +2 -0
- data/docs/OrderCurrentStageHistory.md +22 -0
- data/docs/OrderItem.md +2 -0
- data/docs/OrderSummary.md +8 -0
- data/docs/WebhookApi.md +4 -4
- data/docs/WebhookReflow.md +20 -0
- data/docs/{WebhookSampleRequestResponse.md → WebhookReflowResponse.md} +5 -5
- data/lib/ultracart_api/api/fulfillment_api.rb +5 -5
- data/lib/ultracart_api/api/oauth_api.rb +2 -2
- data/lib/ultracart_api/api/webhook_api.rb +3 -3
- data/lib/ultracart_api/models/channel_partner_order.rb +11 -1
- data/lib/ultracart_api/models/customer_attachment.rb +1 -1
- data/lib/ultracart_api/models/item_payment_processing.rb +11 -1
- data/lib/ultracart_api/models/item_review.rb +26 -1
- data/lib/ultracart_api/models/order.rb +13 -1
- data/lib/ultracart_api/models/order_current_stage_history.rb +286 -0
- data/lib/ultracart_api/models/order_item.rb +10 -1
- data/lib/ultracart_api/models/order_summary.rb +39 -1
- data/lib/ultracart_api/models/{webhook_sample_request.rb → webhook_reflow.rb} +16 -40
- data/lib/ultracart_api/models/{webhook_sample_request_response.rb → webhook_reflow_response.rb} +16 -16
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +3 -2
- metadata +8 -6
- data/docs/WebhookSampleRequest.md +0 -24
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5937da8b7043237dc6f7c5913a0864b1c41fb627d189c44b70037a049843d2db
|
4
|
+
data.tar.gz: f71efd1442fa48f5f7eec5cfd8093ea5d41e071f9befc4e7a950bdedec91237a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e9c8249d4eb031486f3514c79d6db699e6ba2bad37445e55c9d80413c2d958d65394e712e15f98a2e81c2efd3626a50c2e4d303fe712db2695f523f9f92f7748
|
7
|
+
data.tar.gz: dbbb92986bfdb55ce98e9894ab67df2c16ca5877200aba6f849e762de2f7e5731e4f484112a09f92b003481713bea9201d46cd2d696635f5b52edbd242960d2b
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
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.0.
|
10
|
+
- Package version: 4.0.242
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-4.0.
|
27
|
+
gem install ./ultracart_api-4.0.242.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.242.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
36
|
+
gem 'ultracart_api', '~> 4.0.242'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -1211,6 +1211,7 @@ Class | Method | HTTP request | Description
|
|
1211
1211
|
- [UltracartClient::OrderChannelPartner](docs/OrderChannelPartner.md)
|
1212
1212
|
- [UltracartClient::OrderCheckout](docs/OrderCheckout.md)
|
1213
1213
|
- [UltracartClient::OrderCoupon](docs/OrderCoupon.md)
|
1214
|
+
- [UltracartClient::OrderCurrentStageHistory](docs/OrderCurrentStageHistory.md)
|
1214
1215
|
- [UltracartClient::OrderDigitalItem](docs/OrderDigitalItem.md)
|
1215
1216
|
- [UltracartClient::OrderDigitalOrder](docs/OrderDigitalOrder.md)
|
1216
1217
|
- [UltracartClient::OrderEdi](docs/OrderEdi.md)
|
@@ -1425,9 +1426,9 @@ Class | Method | HTTP request | Description
|
|
1425
1426
|
- [UltracartClient::WebhookLogResponse](docs/WebhookLogResponse.md)
|
1426
1427
|
- [UltracartClient::WebhookLogSummariesResponse](docs/WebhookLogSummariesResponse.md)
|
1427
1428
|
- [UltracartClient::WebhookLogSummary](docs/WebhookLogSummary.md)
|
1429
|
+
- [UltracartClient::WebhookReflow](docs/WebhookReflow.md)
|
1430
|
+
- [UltracartClient::WebhookReflowResponse](docs/WebhookReflowResponse.md)
|
1428
1431
|
- [UltracartClient::WebhookResponse](docs/WebhookResponse.md)
|
1429
|
-
- [UltracartClient::WebhookSampleRequest](docs/WebhookSampleRequest.md)
|
1430
|
-
- [UltracartClient::WebhookSampleRequestResponse](docs/WebhookSampleRequestResponse.md)
|
1431
1432
|
- [UltracartClient::WebhooksResponse](docs/WebhooksResponse.md)
|
1432
1433
|
- [UltracartClient::Weight](docs/Weight.md)
|
1433
1434
|
- [UltracartClient::WorkflowAgentAuth](docs/WorkflowAgentAuth.md)
|
@@ -1523,6 +1524,8 @@ Not every change is committed to every SDK.
|
|
1523
1524
|
|
1524
1525
|
| Version | Date | Comments |
|
1525
1526
|
| --: | :-: | --- |
|
1527
|
+
| 4.0.242 | 02/18/2025 | small bug fixes for incorrect return types on several methods |
|
1528
|
+
| 4.0.241 | 02/06/2025 | added storefront_host_name to channel partner order object |
|
1526
1529
|
| 4.0.240 | 01/09/2025 | fix for broken 4.0.39 due to incorrect query sig on getCustomers |
|
1527
1530
|
| 4.0.239 | 01/09/2025 | added emails parameter to customer queries, refundOrder added to Channel partner |
|
1528
1531
|
| 4.0.238 | 12/13/2024 | added user and group ids to conversation agent auth object |
|
data/docs/ChannelPartnerOrder.md
CHANGED
@@ -91,6 +91,7 @@
|
|
91
91
|
| **special_instructions** | **String** | Special instructions from the customer regarding shipping | [optional] |
|
92
92
|
| **store_completed** | **Boolean** | If true the order bypasses shipping and is marked completed | [optional] |
|
93
93
|
| **store_if_payment_declines** | **Boolean** | If true any failed payments are placed into Accounts Receivable. If false any failed payments result in a rejected order resulting in errors thrown during the insert routine | [optional] |
|
94
|
+
| **storefront_host_name** | **String** | StoreFront host name associated with the order | [optional] |
|
94
95
|
| **tax_county** | **String** | The optional shipping county used to determine exact taxes | [optional] |
|
95
96
|
| **tax_exempt** | **Boolean** | If true this order is marked as being tax exempt | [optional] |
|
96
97
|
| **transaction** | [**ChannelPartnerOrderTransaction**](ChannelPartnerOrderTransaction.md) | | [optional] |
|
@@ -189,6 +190,7 @@ instance = UltracartClient::ChannelPartnerOrder.new(
|
|
189
190
|
special_instructions: null,
|
190
191
|
store_completed: null,
|
191
192
|
store_if_payment_declines: null,
|
193
|
+
storefront_host_name: null,
|
192
194
|
tax_county: null,
|
193
195
|
tax_exempt: null,
|
194
196
|
transaction: null,
|
data/docs/CustomerAttachment.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| **customer_profile_attachment_oid** | **Integer** | Attachment identifier | [optional] |
|
8
8
|
| **description** | **String** | Description | [optional] |
|
9
9
|
| **file_name** | **String** | File name | [optional] |
|
10
|
-
| **mime_type** | **String** | Mime
|
10
|
+
| **mime_type** | **String** | Mime type | [optional] |
|
11
11
|
| **upload_dts** | **String** | Upload date/time | [optional] |
|
12
12
|
|
13
13
|
## Example
|
data/docs/FulfillmentApi.md
CHANGED
@@ -86,7 +86,7 @@ nil (empty response body)
|
|
86
86
|
|
87
87
|
## generate_packing_slip
|
88
88
|
|
89
|
-
> <
|
89
|
+
> <OrderPackingSlipResponse> generate_packing_slip(distribution_center_code, order_id)
|
90
90
|
|
91
91
|
Generate a packing slip for this order for the given distribution center.
|
92
92
|
|
@@ -122,7 +122,7 @@ end
|
|
122
122
|
|
123
123
|
This returns an Array which contains the response data, status code and headers.
|
124
124
|
|
125
|
-
> <Array(<
|
125
|
+
> <Array(<OrderPackingSlipResponse>, Integer, Hash)> generate_packing_slip_with_http_info(distribution_center_code, order_id)
|
126
126
|
|
127
127
|
```ruby
|
128
128
|
begin
|
@@ -130,7 +130,7 @@ begin
|
|
130
130
|
data, status_code, headers = api_instance.generate_packing_slip_with_http_info(distribution_center_code, order_id)
|
131
131
|
p status_code # => 2xx
|
132
132
|
p headers # => { ... }
|
133
|
-
p data # => <
|
133
|
+
p data # => <OrderPackingSlipResponse>
|
134
134
|
rescue UltracartClient::ApiError => e
|
135
135
|
puts "Error when calling FulfillmentApi->generate_packing_slip_with_http_info: #{e}"
|
136
136
|
end
|
@@ -145,7 +145,7 @@ end
|
|
145
145
|
|
146
146
|
### Return type
|
147
147
|
|
148
|
-
[**
|
148
|
+
[**OrderPackingSlipResponse**](OrderPackingSlipResponse.md)
|
149
149
|
|
150
150
|
### Authorization
|
151
151
|
|
@@ -163,7 +163,7 @@ end
|
|
163
163
|
|
164
164
|
Retrieve orders queued up for this distribution center.
|
165
165
|
|
166
|
-
Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing,
|
166
|
+
Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
|
167
167
|
|
168
168
|
### Examples
|
169
169
|
|
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **block_prepaid** | **Boolean** | True if prepaid cards should be blocked from buying this item | [optional] |
|
8
|
+
| **block_refunds** | **Boolean** | True if this item should block any refund attempts | [optional] |
|
8
9
|
| **credit_card_transaction_type** | **String** | Credit card transaction type | [optional] |
|
9
10
|
| **no_realtime_charge** | **Boolean** | True if no real-time charge should be performed on this item. | [optional] |
|
10
11
|
| **payment_method_validity** | **Array<String>** | Payment method validity | [optional] |
|
@@ -17,6 +18,7 @@ require 'ultracart_api'
|
|
17
18
|
|
18
19
|
instance = UltracartClient::ItemPaymentProcessing.new(
|
19
20
|
block_prepaid: null,
|
21
|
+
block_refunds: null,
|
20
22
|
credit_card_transaction_type: null,
|
21
23
|
no_realtime_charge: null,
|
22
24
|
payment_method_validity: null,
|
data/docs/ItemReview.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
| **featured** | **Boolean** | | [optional] |
|
9
9
|
| **helperful_no_votes** | **Integer** | | [optional] |
|
10
10
|
| **helpful_yes_votes** | **Integer** | | [optional] |
|
11
|
+
| **merchant_reply** | **String** | Merchant Reply (set to an empty string to remove) | [optional] |
|
11
12
|
| **order_id** | **String** | | [optional] |
|
12
13
|
| **overall** | **Float** | | [optional] |
|
13
14
|
| **rating_name1** | **String** | Rating Name 1 | [optional] |
|
@@ -52,6 +53,7 @@ instance = UltracartClient::ItemReview.new(
|
|
52
53
|
featured: null,
|
53
54
|
helperful_no_votes: null,
|
54
55
|
helpful_yes_votes: null,
|
56
|
+
merchant_reply: null,
|
55
57
|
order_id: null,
|
56
58
|
overall: null,
|
57
59
|
rating_name1: null,
|
data/docs/OauthApi.md
CHANGED
@@ -34,7 +34,7 @@ client_id = 'client_id_example' # String | The OAuth application client_id.
|
|
34
34
|
grant_type = 'grant_type_example' # String | Type of grant
|
35
35
|
opts = {
|
36
36
|
code: 'code_example', # String | Authorization code received back from the browser redirect
|
37
|
-
redirect_uri: 'redirect_uri_example', # String | The URI that you redirect the browser to
|
37
|
+
redirect_uri: 'redirect_uri_example', # String | The URI that you redirect the browser to start the authorization process
|
38
38
|
refresh_token: 'refresh_token_example' # String | The refresh token received during the original grant_type=authorization_code that can be used to return a new access token
|
39
39
|
}
|
40
40
|
|
@@ -72,7 +72,7 @@ end
|
|
72
72
|
| **client_id** | **String** | The OAuth application client_id. | |
|
73
73
|
| **grant_type** | **String** | Type of grant | |
|
74
74
|
| **code** | **String** | Authorization code received back from the browser redirect | [optional] |
|
75
|
-
| **redirect_uri** | **String** | The URI that you redirect the browser to
|
75
|
+
| **redirect_uri** | **String** | The URI that you redirect the browser to start the authorization process | [optional] |
|
76
76
|
| **refresh_token** | **String** | The refresh token received during the original grant_type=authorization_code that can be used to return a new access token | [optional] |
|
77
77
|
|
78
78
|
### Return type
|
data/docs/Order.md
CHANGED
@@ -14,6 +14,7 @@
|
|
14
14
|
| **creation_dts** | **String** | Date/time that the order was created | [optional] |
|
15
15
|
| **currency_code** | **String** | Currency code that the customer used if different than the merchant's base currency code | [optional] |
|
16
16
|
| **current_stage** | **String** | Current stage that the order is in. | [optional] |
|
17
|
+
| **current_stage_histories** | [**Array<OrderCurrentStageHistory>**](OrderCurrentStageHistory.md) | History of the changes to the current_stage field | [optional] |
|
17
18
|
| **customer_profile** | [**Customer**](Customer.md) | | [optional] |
|
18
19
|
| **digital_order** | [**OrderDigitalOrder**](OrderDigitalOrder.md) | | [optional] |
|
19
20
|
| **edi** | [**OrderEdi**](OrderEdi.md) | | [optional] |
|
@@ -59,6 +60,7 @@ instance = UltracartClient::Order.new(
|
|
59
60
|
creation_dts: null,
|
60
61
|
currency_code: null,
|
61
62
|
current_stage: null,
|
63
|
+
current_stage_histories: null,
|
62
64
|
customer_profile: null,
|
63
65
|
digital_order: null,
|
64
66
|
edi: null,
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# UltracartClient::OrderCurrentStageHistory
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **after_stage** | **String** | New stage that the order is in. | [optional] |
|
8
|
+
| **before_stage** | **String** | Previous stage that the order was in. | [optional] |
|
9
|
+
| **transition_dts** | **String** | Date/time that the stage transitioned | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ultracart_api'
|
15
|
+
|
16
|
+
instance = UltracartClient::OrderCurrentStageHistory.new(
|
17
|
+
after_stage: null,
|
18
|
+
before_stage: null,
|
19
|
+
transition_dts: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/OrderItem.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **accounting_code** | **String** | QuickBooks code | [optional] |
|
8
8
|
| **activation_codes** | **Array<String>** | Activation codes assigned to this item | [optional] |
|
9
|
+
| **actual_cogs** | [**Currency**](Currency.md) | | [optional] |
|
9
10
|
| **arbitrary_unit_cost** | [**Currency**](Currency.md) | | [optional] |
|
10
11
|
| **auto_order_last_rebill_dts** | **String** | Date/time of the last rebill, used only during order insert to help project future rebills | [optional] |
|
11
12
|
| **auto_order_schedule** | **String** | Auto order schedule, used only during inserts supplying the recurring schedule | [optional] |
|
@@ -78,6 +79,7 @@ require 'ultracart_api'
|
|
78
79
|
instance = UltracartClient::OrderItem.new(
|
79
80
|
accounting_code: null,
|
80
81
|
activation_codes: null,
|
82
|
+
actual_cogs: null,
|
81
83
|
arbitrary_unit_cost: null,
|
82
84
|
auto_order_last_rebill_dts: null,
|
83
85
|
auto_order_schedule: null,
|
data/docs/OrderSummary.md
CHANGED
@@ -5,7 +5,11 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **actual_fulfillment** | [**Currency**](Currency.md) | | [optional] |
|
8
|
+
| **actual_other_cost** | [**Currency**](Currency.md) | | [optional] |
|
8
9
|
| **actual_payment_processing** | [**Currency**](Currency.md) | | [optional] |
|
10
|
+
| **actual_profit** | [**Currency**](Currency.md) | | [optional] |
|
11
|
+
| **actual_profit_analyzed** | **Boolean** | Actual profit has been analyzed | [optional] |
|
12
|
+
| **actual_profit_review** | **Boolean** | Actual profit needs review | [optional] |
|
9
13
|
| **actual_shipping** | [**Currency**](Currency.md) | | [optional] |
|
10
14
|
| **arbitrary_shipping_handling_total** | [**Currency**](Currency.md) | | [optional] |
|
11
15
|
| **health_benefit_card_amount** | [**Currency**](Currency.md) | | [optional] |
|
@@ -34,7 +38,11 @@ require 'ultracart_api'
|
|
34
38
|
|
35
39
|
instance = UltracartClient::OrderSummary.new(
|
36
40
|
actual_fulfillment: null,
|
41
|
+
actual_other_cost: null,
|
37
42
|
actual_payment_processing: null,
|
43
|
+
actual_profit: null,
|
44
|
+
actual_profit_analyzed: null,
|
45
|
+
actual_profit_review: null,
|
38
46
|
actual_shipping: null,
|
39
47
|
arbitrary_shipping_handling_total: null,
|
40
48
|
health_benefit_card_amount: null,
|
data/docs/WebhookApi.md
CHANGED
@@ -463,7 +463,7 @@ end
|
|
463
463
|
|
464
464
|
## resend_event
|
465
465
|
|
466
|
-
> <
|
466
|
+
> <WebhookReflowResponse> resend_event(webhook_oid, event_name)
|
467
467
|
|
468
468
|
Resend events to the webhook endpoint.
|
469
469
|
|
@@ -499,7 +499,7 @@ end
|
|
499
499
|
|
500
500
|
This returns an Array which contains the response data, status code and headers.
|
501
501
|
|
502
|
-
> <Array(<
|
502
|
+
> <Array(<WebhookReflowResponse>, Integer, Hash)> resend_event_with_http_info(webhook_oid, event_name)
|
503
503
|
|
504
504
|
```ruby
|
505
505
|
begin
|
@@ -507,7 +507,7 @@ begin
|
|
507
507
|
data, status_code, headers = api_instance.resend_event_with_http_info(webhook_oid, event_name)
|
508
508
|
p status_code # => 2xx
|
509
509
|
p headers # => { ... }
|
510
|
-
p data # => <
|
510
|
+
p data # => <WebhookReflowResponse>
|
511
511
|
rescue UltracartClient::ApiError => e
|
512
512
|
puts "Error when calling WebhookApi->resend_event_with_http_info: #{e}"
|
513
513
|
end
|
@@ -522,7 +522,7 @@ end
|
|
522
522
|
|
523
523
|
### Return type
|
524
524
|
|
525
|
-
[**
|
525
|
+
[**WebhookReflowResponse**](WebhookReflowResponse.md)
|
526
526
|
|
527
527
|
### Authorization
|
528
528
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::WebhookReflow
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **event_name** | **String** | | [optional] |
|
8
|
+
| **queued** | **Boolean** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::WebhookReflow.new(
|
16
|
+
event_name: null,
|
17
|
+
queued: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# UltracartClient::
|
1
|
+
# UltracartClient::WebhookReflowResponse
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
@@ -6,21 +6,21 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **error** | [**Error**](Error.md) | | [optional] |
|
8
8
|
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **reflow** | [**WebhookReflow**](WebhookReflow.md) | | [optional] |
|
9
10
|
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
10
11
|
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
11
|
-
| **webhook_sample_request** | [**WebhookSampleRequest**](WebhookSampleRequest.md) | | [optional] |
|
12
12
|
|
13
13
|
## Example
|
14
14
|
|
15
15
|
```ruby
|
16
16
|
require 'ultracart_api'
|
17
17
|
|
18
|
-
instance = UltracartClient::
|
18
|
+
instance = UltracartClient::WebhookReflowResponse.new(
|
19
19
|
error: null,
|
20
20
|
metadata: null,
|
21
|
+
reflow: null,
|
21
22
|
success: null,
|
22
|
-
warning: null
|
23
|
-
webhook_sample_request: null
|
23
|
+
warning: null
|
24
24
|
)
|
25
25
|
```
|
26
26
|
|
@@ -112,7 +112,7 @@ module UltracartClient
|
|
112
112
|
# @param distribution_center_code [String] Distribution center code
|
113
113
|
# @param order_id [String] Order ID
|
114
114
|
# @param [Hash] opts the optional parameters
|
115
|
-
# @return [
|
115
|
+
# @return [OrderPackingSlipResponse]
|
116
116
|
def generate_packing_slip(distribution_center_code, order_id, opts = {})
|
117
117
|
data, _status_code, _headers = generate_packing_slip_with_http_info(distribution_center_code, order_id, opts)
|
118
118
|
data
|
@@ -123,7 +123,7 @@ module UltracartClient
|
|
123
123
|
# @param distribution_center_code [String] Distribution center code
|
124
124
|
# @param order_id [String] Order ID
|
125
125
|
# @param [Hash] opts the optional parameters
|
126
|
-
# @return [Array<(
|
126
|
+
# @return [Array<(OrderPackingSlipResponse, Integer, Hash)>] OrderPackingSlipResponse data, response status code and response headers
|
127
127
|
def generate_packing_slip_with_http_info(distribution_center_code, order_id, opts = {})
|
128
128
|
if @api_client.config.debugging
|
129
129
|
@api_client.config.logger.debug 'Calling API: FulfillmentApi.generate_packing_slip ...'
|
@@ -155,7 +155,7 @@ module UltracartClient
|
|
155
155
|
post_body = opts[:debug_body]
|
156
156
|
|
157
157
|
# return_type
|
158
|
-
return_type = opts[:debug_return_type] || '
|
158
|
+
return_type = opts[:debug_return_type] || 'OrderPackingSlipResponse'
|
159
159
|
|
160
160
|
# auth_names
|
161
161
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
@@ -178,7 +178,7 @@ module UltracartClient
|
|
178
178
|
end
|
179
179
|
|
180
180
|
# Retrieve orders queued up for this distribution center.
|
181
|
-
# Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing,
|
181
|
+
# Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
|
182
182
|
# @param distribution_center_code [String] Distribution center code
|
183
183
|
# @param [Hash] opts the optional parameters
|
184
184
|
# @return [OrdersResponse]
|
@@ -188,7 +188,7 @@ module UltracartClient
|
|
188
188
|
end
|
189
189
|
|
190
190
|
# Retrieve orders queued up for this distribution center.
|
191
|
-
# Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing,
|
191
|
+
# Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
|
192
192
|
# @param distribution_center_code [String] Distribution center code
|
193
193
|
# @param [Hash] opts the optional parameters
|
194
194
|
# @return [Array<(OrdersResponse, Integer, Hash)>] OrdersResponse data, response status code and response headers
|
@@ -38,7 +38,7 @@ module UltracartClient
|
|
38
38
|
# @param grant_type [String] Type of grant
|
39
39
|
# @param [Hash] opts the optional parameters
|
40
40
|
# @option opts [String] :code Authorization code received back from the browser redirect
|
41
|
-
# @option opts [String] :redirect_uri The URI that you redirect the browser to
|
41
|
+
# @option opts [String] :redirect_uri The URI that you redirect the browser to start the authorization process
|
42
42
|
# @option opts [String] :refresh_token The refresh token received during the original grant_type=authorization_code that can be used to return a new access token
|
43
43
|
# @return [OauthTokenResponse]
|
44
44
|
def oauth_access_token(client_id, grant_type, opts = {})
|
@@ -52,7 +52,7 @@ module UltracartClient
|
|
52
52
|
# @param grant_type [String] Type of grant
|
53
53
|
# @param [Hash] opts the optional parameters
|
54
54
|
# @option opts [String] :code Authorization code received back from the browser redirect
|
55
|
-
# @option opts [String] :redirect_uri The URI that you redirect the browser to
|
55
|
+
# @option opts [String] :redirect_uri The URI that you redirect the browser to start the authorization process
|
56
56
|
# @option opts [String] :refresh_token The refresh token received during the original grant_type=authorization_code that can be used to return a new access token
|
57
57
|
# @return [Array<(OauthTokenResponse, Integer, Hash)>] OauthTokenResponse data, response status code and response headers
|
58
58
|
def oauth_access_token_with_http_info(client_id, grant_type, opts = {})
|
@@ -455,7 +455,7 @@ module UltracartClient
|
|
455
455
|
# @param webhook_oid [Integer] The webhook oid that is receiving the reflowed events.
|
456
456
|
# @param event_name [String] The event to reflow.
|
457
457
|
# @param [Hash] opts the optional parameters
|
458
|
-
# @return [
|
458
|
+
# @return [WebhookReflowResponse]
|
459
459
|
def resend_event(webhook_oid, event_name, opts = {})
|
460
460
|
data, _status_code, _headers = resend_event_with_http_info(webhook_oid, event_name, opts)
|
461
461
|
data
|
@@ -466,7 +466,7 @@ module UltracartClient
|
|
466
466
|
# @param webhook_oid [Integer] The webhook oid that is receiving the reflowed events.
|
467
467
|
# @param event_name [String] The event to reflow.
|
468
468
|
# @param [Hash] opts the optional parameters
|
469
|
-
# @return [Array<(
|
469
|
+
# @return [Array<(WebhookReflowResponse, Integer, Hash)>] WebhookReflowResponse data, response status code and response headers
|
470
470
|
def resend_event_with_http_info(webhook_oid, event_name, opts = {})
|
471
471
|
if @api_client.config.debugging
|
472
472
|
@api_client.config.logger.debug 'Calling API: WebhookApi.resend_event ...'
|
@@ -498,7 +498,7 @@ module UltracartClient
|
|
498
498
|
post_body = opts[:debug_body]
|
499
499
|
|
500
500
|
# return_type
|
501
|
-
return_type = opts[:debug_return_type] || '
|
501
|
+
return_type = opts[:debug_return_type] || 'WebhookReflowResponse'
|
502
502
|
|
503
503
|
# auth_names
|
504
504
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
@@ -276,6 +276,9 @@ module UltracartClient
|
|
276
276
|
# If true any failed payments are placed into Accounts Receivable. If false any failed payments result in a rejected order resulting in errors thrown during the insert routine
|
277
277
|
attr_accessor :store_if_payment_declines
|
278
278
|
|
279
|
+
# StoreFront host name associated with the order
|
280
|
+
attr_accessor :storefront_host_name
|
281
|
+
|
279
282
|
# The optional shipping county used to determine exact taxes
|
280
283
|
attr_accessor :tax_county
|
281
284
|
|
@@ -399,6 +402,7 @@ module UltracartClient
|
|
399
402
|
:'special_instructions' => :'special_instructions',
|
400
403
|
:'store_completed' => :'store_completed',
|
401
404
|
:'store_if_payment_declines' => :'store_if_payment_declines',
|
405
|
+
:'storefront_host_name' => :'storefront_host_name',
|
402
406
|
:'tax_county' => :'tax_county',
|
403
407
|
:'tax_exempt' => :'tax_exempt',
|
404
408
|
:'transaction' => :'transaction',
|
@@ -501,6 +505,7 @@ module UltracartClient
|
|
501
505
|
:'special_instructions' => :'String',
|
502
506
|
:'store_completed' => :'Boolean',
|
503
507
|
:'store_if_payment_declines' => :'Boolean',
|
508
|
+
:'storefront_host_name' => :'String',
|
504
509
|
:'tax_county' => :'String',
|
505
510
|
:'tax_exempt' => :'Boolean',
|
506
511
|
:'transaction' => :'ChannelPartnerOrderTransaction',
|
@@ -883,6 +888,10 @@ module UltracartClient
|
|
883
888
|
self.store_if_payment_declines = attributes[:'store_if_payment_declines']
|
884
889
|
end
|
885
890
|
|
891
|
+
if attributes.key?(:'storefront_host_name')
|
892
|
+
self.storefront_host_name = attributes[:'storefront_host_name']
|
893
|
+
end
|
894
|
+
|
886
895
|
if attributes.key?(:'tax_county')
|
887
896
|
self.tax_county = attributes[:'tax_county']
|
888
897
|
end
|
@@ -1596,6 +1605,7 @@ module UltracartClient
|
|
1596
1605
|
special_instructions == o.special_instructions &&
|
1597
1606
|
store_completed == o.store_completed &&
|
1598
1607
|
store_if_payment_declines == o.store_if_payment_declines &&
|
1608
|
+
storefront_host_name == o.storefront_host_name &&
|
1599
1609
|
tax_county == o.tax_county &&
|
1600
1610
|
tax_exempt == o.tax_exempt &&
|
1601
1611
|
transaction == o.transaction &&
|
@@ -1611,7 +1621,7 @@ module UltracartClient
|
|
1611
1621
|
# Calculates hash code according to all attributes.
|
1612
1622
|
# @return [Integer] Hash code
|
1613
1623
|
def hash
|
1614
|
-
[advertising_source, affiliate_id, affiliate_sub_id, arbitrary_shipping_handling_total, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, associate_with_customer_profile_if_present, auto_approve_purchase_order, billto_address1, billto_address2, billto_city, billto_company, billto_country_code, billto_day_phone, billto_evening_phone, billto_first_name, billto_last_name, billto_postal_code, billto_state_region, billto_title, cc_email, channel_partner_order_id, consider_recurring, coupons, credit_card_authorization_amount, credit_card_authorization_dts, credit_card_authorization_number, credit_card_expiration_month, credit_card_expiration_year, credit_card_type, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, delivery_date, echeck_bank_aba_code, echeck_bank_account_name, echeck_bank_account_number, echeck_bank_account_type, echeck_bank_name, echeck_bank_owner_type, echeck_customer_tax_id, echeck_drivers_license_dob, echeck_drivers_license_number, echeck_drivers_license_state, email, gift, gift_email, gift_message, hosted_fields_card_token, hosted_fields_cvv_token, insurance_application_id, insurance_claim_id, ip_address, items, least_cost_route, least_cost_route_shipping_methods, mailing_list_opt_in, no_realtime_payment_processing, payment_method, purchase_order_number, rotating_transaction_gateway_code, sales_rep_code, screen_branding_theme_code, ship_on_date, ship_to_residential, shipping_method, shipto_address1, shipto_address2, shipto_city, shipto_company, shipto_country_code, shipto_day_phone, shipto_evening_phone, shipto_first_name, shipto_last_name, shipto_postal_code, shipto_state_region, shipto_title, skip_payment_processing, special_instructions, store_completed, store_if_payment_declines, tax_county, tax_exempt, transaction, treat_warnings_as_errors].hash
|
1624
|
+
[advertising_source, affiliate_id, affiliate_sub_id, arbitrary_shipping_handling_total, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, associate_with_customer_profile_if_present, auto_approve_purchase_order, billto_address1, billto_address2, billto_city, billto_company, billto_country_code, billto_day_phone, billto_evening_phone, billto_first_name, billto_last_name, billto_postal_code, billto_state_region, billto_title, cc_email, channel_partner_order_id, consider_recurring, coupons, credit_card_authorization_amount, credit_card_authorization_dts, credit_card_authorization_number, credit_card_expiration_month, credit_card_expiration_year, credit_card_type, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, delivery_date, echeck_bank_aba_code, echeck_bank_account_name, echeck_bank_account_number, echeck_bank_account_type, echeck_bank_name, echeck_bank_owner_type, echeck_customer_tax_id, echeck_drivers_license_dob, echeck_drivers_license_number, echeck_drivers_license_state, email, gift, gift_email, gift_message, hosted_fields_card_token, hosted_fields_cvv_token, insurance_application_id, insurance_claim_id, ip_address, items, least_cost_route, least_cost_route_shipping_methods, mailing_list_opt_in, no_realtime_payment_processing, payment_method, purchase_order_number, rotating_transaction_gateway_code, sales_rep_code, screen_branding_theme_code, ship_on_date, ship_to_residential, shipping_method, shipto_address1, shipto_address2, shipto_city, shipto_company, shipto_country_code, shipto_day_phone, shipto_evening_phone, shipto_first_name, shipto_last_name, shipto_postal_code, shipto_state_region, shipto_title, skip_payment_processing, special_instructions, store_completed, store_if_payment_declines, storefront_host_name, tax_county, tax_exempt, transaction, treat_warnings_as_errors].hash
|
1615
1625
|
end
|
1616
1626
|
|
1617
1627
|
# Builds the object from hash
|
@@ -18,6 +18,9 @@ module UltracartClient
|
|
18
18
|
# True if prepaid cards should be blocked from buying this item
|
19
19
|
attr_accessor :block_prepaid
|
20
20
|
|
21
|
+
# True if this item should block any refund attempts
|
22
|
+
attr_accessor :block_refunds
|
23
|
+
|
21
24
|
# Credit card transaction type
|
22
25
|
attr_accessor :credit_card_transaction_type
|
23
26
|
|
@@ -34,6 +37,7 @@ module UltracartClient
|
|
34
37
|
def self.attribute_map
|
35
38
|
{
|
36
39
|
:'block_prepaid' => :'block_prepaid',
|
40
|
+
:'block_refunds' => :'block_refunds',
|
37
41
|
:'credit_card_transaction_type' => :'credit_card_transaction_type',
|
38
42
|
:'no_realtime_charge' => :'no_realtime_charge',
|
39
43
|
:'payment_method_validity' => :'payment_method_validity',
|
@@ -50,6 +54,7 @@ module UltracartClient
|
|
50
54
|
def self.openapi_types
|
51
55
|
{
|
52
56
|
:'block_prepaid' => :'Boolean',
|
57
|
+
:'block_refunds' => :'Boolean',
|
53
58
|
:'credit_card_transaction_type' => :'String',
|
54
59
|
:'no_realtime_charge' => :'Boolean',
|
55
60
|
:'payment_method_validity' => :'Array<String>',
|
@@ -82,6 +87,10 @@ module UltracartClient
|
|
82
87
|
self.block_prepaid = attributes[:'block_prepaid']
|
83
88
|
end
|
84
89
|
|
90
|
+
if attributes.key?(:'block_refunds')
|
91
|
+
self.block_refunds = attributes[:'block_refunds']
|
92
|
+
end
|
93
|
+
|
85
94
|
if attributes.key?(:'credit_card_transaction_type')
|
86
95
|
self.credit_card_transaction_type = attributes[:'credit_card_transaction_type']
|
87
96
|
end
|
@@ -122,6 +131,7 @@ module UltracartClient
|
|
122
131
|
return true if self.equal?(o)
|
123
132
|
self.class == o.class &&
|
124
133
|
block_prepaid == o.block_prepaid &&
|
134
|
+
block_refunds == o.block_refunds &&
|
125
135
|
credit_card_transaction_type == o.credit_card_transaction_type &&
|
126
136
|
no_realtime_charge == o.no_realtime_charge &&
|
127
137
|
payment_method_validity == o.payment_method_validity &&
|
@@ -137,7 +147,7 @@ module UltracartClient
|
|
137
147
|
# Calculates hash code according to all attributes.
|
138
148
|
# @return [Integer] Hash code
|
139
149
|
def hash
|
140
|
-
[block_prepaid, credit_card_transaction_type, no_realtime_charge, payment_method_validity, rotating_transaction_gateway_codes].hash
|
150
|
+
[block_prepaid, block_refunds, credit_card_transaction_type, no_realtime_charge, payment_method_validity, rotating_transaction_gateway_codes].hash
|
141
151
|
end
|
142
152
|
|
143
153
|
# Builds the object from hash
|