ultracart_api 4.1.164 → 4.1.167
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 +12 -2
- data/docs/AutoOrderApi.md +79 -23
- data/docs/ChannelPartnerApi.md +12 -12
- data/docs/CheckoutApi.md +17 -16
- data/docs/CouponApi.md +22 -22
- data/docs/CustomerApi.md +3 -3
- data/docs/EmailCommseqEmailReviewStatus.md +32 -0
- data/docs/EmailCommseqEmailReviewStatusResponse.md +26 -0
- data/docs/EmailCommseqEmailReviewStatusesRequest.md +18 -0
- data/docs/EmailCommseqEmailReviewStatusesResponse.md +26 -0
- data/docs/FraudApi.md +210 -9
- data/docs/GiftCertificateApi.md +2 -4
- data/docs/OrderApi.md +140 -13
- data/docs/StorefrontApi.md +112 -2
- data/lib/ultracart_api/api/storefront_api.rb +143 -0
- data/lib/ultracart_api/models/email_commseq_email_review_status.rb +324 -0
- data/lib/ultracart_api/models/email_commseq_email_review_status_response.rb +256 -0
- data/lib/ultracart_api/models/email_commseq_email_review_statuses_request.rb +222 -0
- data/lib/ultracart_api/models/email_commseq_email_review_statuses_response.rb +258 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +9 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0144d3f0a09b5e78e9e692bb7e8a76b17f63a03ba39ca5c7257fb35d082fd101
|
|
4
|
+
data.tar.gz: 879d6e798a966bf72271a5ebd741cd91991b22de46ca319a7e5f733bd129b48a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2c5af2e57042918564b683913e66768b12c564ebdaa328ef7d52b9e15638edd38779bcba97d51984a0fd06a714b7d7e51263eb5d9f15e8f83bd906f4d84f8d5c
|
|
7
|
+
data.tar.gz: 5e68e25499c4befb0452ad911f689e2b2d74d7da68d967a757aff4518589f057ef4916457182f1ebe75f76b94b1899e61ffd411c0e9314eae6b8f60c5c709374
|
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.167
|
|
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.167'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -628,6 +628,8 @@ Class | Method | HTTP request | Description
|
|
|
628
628
|
*UltracartClient::StorefrontApi* | [**get_email_postcard**](docs/StorefrontApi.md#get_email_postcard) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Get email postcard
|
|
629
629
|
*UltracartClient::StorefrontApi* | [**get_email_postcards**](docs/StorefrontApi.md#get_email_postcards) | **GET** /storefront/{storefront_oid}/email/postcards | Get email postcards
|
|
630
630
|
*UltracartClient::StorefrontApi* | [**get_email_postcards_multiple**](docs/StorefrontApi.md#get_email_postcards_multiple) | **POST** /storefront/{storefront_oid}/email/postcards/multiple | Get email postcards multiple
|
|
631
|
+
*UltracartClient::StorefrontApi* | [**get_email_review_status**](docs/StorefrontApi.md#get_email_review_status) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review_status | Get the review status of an email
|
|
632
|
+
*UltracartClient::StorefrontApi* | [**get_email_review_statuses_multiple**](docs/StorefrontApi.md#get_email_review_statuses_multiple) | **POST** /storefront/{storefront_oid}/email/emails/review_status/multiple | Get the review status of multiple emails
|
|
631
633
|
*UltracartClient::StorefrontApi* | [**get_email_segment**](docs/StorefrontApi.md#get_email_segment) | **GET** /storefront/{storefront_oid}/email/segments/{email_segment_uuid} | Get email segment
|
|
632
634
|
*UltracartClient::StorefrontApi* | [**get_email_segment_customer_editor_url**](docs/StorefrontApi.md#get_email_segment_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers/{email_customer_uuid}/editor_url | Get email segment customers editor URL
|
|
633
635
|
*UltracartClient::StorefrontApi* | [**get_email_segment_customers**](docs/StorefrontApi.md#get_email_segment_customers) | **GET** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers | Get email segment customers
|
|
@@ -1289,6 +1291,10 @@ Class | Method | HTTP request | Description
|
|
|
1289
1291
|
- [UltracartClient::EmailCommseq](docs/EmailCommseq.md)
|
|
1290
1292
|
- [UltracartClient::EmailCommseqEmail](docs/EmailCommseqEmail.md)
|
|
1291
1293
|
- [UltracartClient::EmailCommseqEmailResponse](docs/EmailCommseqEmailResponse.md)
|
|
1294
|
+
- [UltracartClient::EmailCommseqEmailReviewStatus](docs/EmailCommseqEmailReviewStatus.md)
|
|
1295
|
+
- [UltracartClient::EmailCommseqEmailReviewStatusResponse](docs/EmailCommseqEmailReviewStatusResponse.md)
|
|
1296
|
+
- [UltracartClient::EmailCommseqEmailReviewStatusesRequest](docs/EmailCommseqEmailReviewStatusesRequest.md)
|
|
1297
|
+
- [UltracartClient::EmailCommseqEmailReviewStatusesResponse](docs/EmailCommseqEmailReviewStatusesResponse.md)
|
|
1292
1298
|
- [UltracartClient::EmailCommseqEmailSendTestRequest](docs/EmailCommseqEmailSendTestRequest.md)
|
|
1293
1299
|
- [UltracartClient::EmailCommseqEmailSendTestResponse](docs/EmailCommseqEmailSendTestResponse.md)
|
|
1294
1300
|
- [UltracartClient::EmailCommseqEmailsRequest](docs/EmailCommseqEmailsRequest.md)
|
|
@@ -2009,11 +2015,15 @@ Class | Method | HTTP request | Description
|
|
|
2009
2015
|
|
|
2010
2016
|
|
|
2011
2017
|
|
|
2018
|
+
|
|
2019
|
+
|
|
2012
2020
|
# CHANGE LOG
|
|
2013
2021
|
Not every change is committed to every SDK.
|
|
2014
2022
|
|
|
2015
2023
|
| Version | Date | Comments |
|
|
2016
2024
|
| --: | :-: | --- |
|
|
2025
|
+
| 4.1.167 | 09/21/2026 | automation test |
|
|
2026
|
+
| 4.1.165 | 09/21/2026 | automation testing |
|
|
2017
2027
|
| 4.1.164 | 09/20/2026 | automation testing |
|
|
2018
2028
|
| 4.1.163 | 09/20/2026 | automation testing |
|
|
2019
2029
|
| 4.1.162 | 09/18/2026 | sdk automation testing |
|
data/docs/AutoOrderApi.md
CHANGED
|
@@ -90,8 +90,28 @@ Cancels a single item on an auto order identified by the original order id and t
|
|
|
90
90
|
|
|
91
91
|
### Examples
|
|
92
92
|
|
|
93
|
+
```ruby
|
|
94
|
+
# Cancel a single item on an auto order, identified by the reference (original) order id
|
|
95
|
+
# that placed the auto order and the original item id on that order. This is useful when
|
|
96
|
+
# you know the original UltraCart order id rather than the auto_order_oid.
|
|
93
97
|
|
|
94
|
-
|
|
98
|
+
require_relative '../constants'
|
|
99
|
+
require 'ultracart_api'
|
|
100
|
+
|
|
101
|
+
auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY)
|
|
102
|
+
|
|
103
|
+
reference_order_id = "DEMO-12345678" # the UltraCart order id that placed the auto order
|
|
104
|
+
original_item_id = "ITEM001" # the merchant item id on that original order
|
|
105
|
+
expand = "items" # see https://www.ultracart.com/api/#resource_auto_order.html for list
|
|
106
|
+
|
|
107
|
+
response = auto_order_api.cancel_auto_order_item_by_reference_order_id(
|
|
108
|
+
reference_order_id,
|
|
109
|
+
original_item_id,
|
|
110
|
+
{ _expand: expand }
|
|
111
|
+
)
|
|
112
|
+
auto_order = response.auto_order
|
|
113
|
+
puts auto_order.inspect
|
|
114
|
+
```
|
|
95
115
|
|
|
96
116
|
|
|
97
117
|
#### Using the cancel_auto_order_item_by_reference_order_id_with_http_info variant
|
|
@@ -163,7 +183,7 @@ target_auto_order_oid = 123456789 # set getAutoOrdersByQuery for retrieving auto
|
|
|
163
183
|
consolidate_request = UltracartClient::AutoOrderConsolidate.new
|
|
164
184
|
consolidate_request.source_auto_order_oids = [23456789, 3456789] # these are the autoorder_oids you wish to consolidate into the target.
|
|
165
185
|
|
|
166
|
-
api_response = auto_order_api.consolidate_auto_orders(target_auto_order_oid, consolidate_request, { '_expand' => expand })
|
|
186
|
+
api_response = auto_order_api.consolidate_auto_orders(target_auto_order_oid, consolidate_request, { :'_expand' => expand })
|
|
167
187
|
|
|
168
188
|
consolidated_auto_order = api_response.auto_order
|
|
169
189
|
|
|
@@ -237,7 +257,7 @@ auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_
|
|
|
237
257
|
expand = "items,items.future_schedules,original_order,rebill_orders"
|
|
238
258
|
|
|
239
259
|
original_order_id = "DEMO-123457"
|
|
240
|
-
api_response = auto_order_api.establish_auto_order_by_reference_order_id(original_order_id, { '_expand' => expand })
|
|
260
|
+
api_response = auto_order_api.establish_auto_order_by_reference_order_id(original_order_id, { :'_expand' => expand })
|
|
241
261
|
|
|
242
262
|
empty_auto_order = api_response.auto_order
|
|
243
263
|
auto_order_oid = empty_auto_order.auto_order_oid
|
|
@@ -255,7 +275,7 @@ items << item
|
|
|
255
275
|
empty_auto_order.items = items
|
|
256
276
|
|
|
257
277
|
validate_original_order = 'No'
|
|
258
|
-
api_response = auto_order_api.update_auto_order(auto_order_oid, empty_auto_order, { '_expand' => expand, validate_original_order
|
|
278
|
+
api_response = auto_order_api.update_auto_order(auto_order_oid, empty_auto_order, { :'_expand' => expand, :'validate_original_order' => validate_original_order })
|
|
259
279
|
updated_auto_order = api_response.auto_order
|
|
260
280
|
puts updated_auto_order.inspect
|
|
261
281
|
```
|
|
@@ -322,7 +342,7 @@ auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_
|
|
|
322
342
|
# see https://www.ultracart.com/api/#resource_auto_order.html for list
|
|
323
343
|
expand = "items,items.future_schedules,original_order,rebill_orders"
|
|
324
344
|
auto_order_oid = 123456789 # If you don't know the oid, use getAutoOrdersByQuery for retrieving auto orders
|
|
325
|
-
api_response = auto_order_api.get_auto_order(auto_order_oid, { '_expand' => expand })
|
|
345
|
+
api_response = auto_order_api.get_auto_order(auto_order_oid, { :'_expand' => expand })
|
|
326
346
|
auto_order = api_response.auto_order
|
|
327
347
|
puts auto_order.inspect
|
|
328
348
|
```
|
|
@@ -451,7 +471,7 @@ auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_
|
|
|
451
471
|
|
|
452
472
|
expand = "items,items.future_schedules,original_order,rebill_orders" # contact us if you're unsure what you need
|
|
453
473
|
code = "RT2A9CBSX9"
|
|
454
|
-
api_response = auto_order_api.get_auto_order_by_code(code, { '_expand' => expand })
|
|
474
|
+
api_response = auto_order_api.get_auto_order_by_code(code, { :'_expand' => expand })
|
|
455
475
|
auto_order = api_response.auto_order
|
|
456
476
|
|
|
457
477
|
# this will be verbose...
|
|
@@ -577,7 +597,7 @@ auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_
|
|
|
577
597
|
|
|
578
598
|
expand = "items,items.future_schedules,original_order,rebill_orders" # contact us if you're unsure what you need
|
|
579
599
|
original_order_id = "DEMO-12345678"
|
|
580
|
-
api_response = auto_order_api.get_auto_order_by_reference_order_id(original_order_id, { '_expand' => expand })
|
|
600
|
+
api_response = auto_order_api.get_auto_order_by_reference_order_id(original_order_id, { :'_expand' => expand })
|
|
581
601
|
auto_order = api_response.auto_order
|
|
582
602
|
|
|
583
603
|
# this will be verbose...
|
|
@@ -635,8 +655,23 @@ Retrieves auto order cancel reasons.
|
|
|
635
655
|
|
|
636
656
|
### Examples
|
|
637
657
|
|
|
658
|
+
```ruby
|
|
659
|
+
require 'ultracart_api'
|
|
660
|
+
require_relative '../constants'
|
|
638
661
|
|
|
639
|
-
|
|
662
|
+
# Retrieves the list of cancel reasons that can be presented to customers when
|
|
663
|
+
# cancelling an auto order (e.g., in MyAccount). Each reason includes the reason
|
|
664
|
+
# text, an optional MyAccount alternate description, and whether the reason is
|
|
665
|
+
# visible in MyAccount.
|
|
666
|
+
|
|
667
|
+
auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY)
|
|
668
|
+
|
|
669
|
+
api_response = auto_order_api.get_auto_order_cancel_reasons
|
|
670
|
+
|
|
671
|
+
api_response.cancel_reasons.each do |cancel_reason|
|
|
672
|
+
puts cancel_reason.inspect
|
|
673
|
+
end
|
|
674
|
+
```
|
|
640
675
|
|
|
641
676
|
|
|
642
677
|
#### Using the get_auto_order_cancel_reasons_with_http_info variant
|
|
@@ -797,10 +832,31 @@ def get_auto_order_chunk(auto_order_api, offset, limit)
|
|
|
797
832
|
sort = nil
|
|
798
833
|
|
|
799
834
|
# see all these parameters? that is why you should use getAutoOrdersByQuery() instead of getAutoOrders()
|
|
800
|
-
api_response = auto_order_api.get_auto_orders(
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
835
|
+
api_response = auto_order_api.get_auto_orders(
|
|
836
|
+
{
|
|
837
|
+
:'auto_order_code' => auto_order_code,
|
|
838
|
+
:'original_order_id' => original_order_id,
|
|
839
|
+
:'first_name' => first_name,
|
|
840
|
+
:'last_name' => last_name,
|
|
841
|
+
:'company' => company,
|
|
842
|
+
:'city' => city,
|
|
843
|
+
:'state' => state,
|
|
844
|
+
:'postal_code' => postal_code,
|
|
845
|
+
:'country_code' => country_code,
|
|
846
|
+
:'phone' => phone,
|
|
847
|
+
:'email' => email,
|
|
848
|
+
:'original_order_date_begin' => original_order_date_begin,
|
|
849
|
+
:'original_order_date_end' => original_order_date_end,
|
|
850
|
+
:'next_shipment_date_begin' => next_shipment_date_begin,
|
|
851
|
+
:'next_shipment_date_end' => next_shipment_date_end,
|
|
852
|
+
:'card_type' => card_type,
|
|
853
|
+
:'item_id' => item_id,
|
|
854
|
+
:'status' => status,
|
|
855
|
+
:'_limit' => limit,
|
|
856
|
+
:'_offset' => offset,
|
|
857
|
+
:'_since' => since,
|
|
858
|
+
:'_sort' => sort,
|
|
859
|
+
:'_expand' => expand })
|
|
804
860
|
|
|
805
861
|
api_response.auto_orders || []
|
|
806
862
|
end
|
|
@@ -954,7 +1010,7 @@ expand = "items,items.future_schedules,original_order,rebill_orders" # contact u
|
|
|
954
1010
|
auto_order_oids = [123456, 234567, 345678, 456789]
|
|
955
1011
|
batch_request = UltracartClient::AutoOrderQueryBatch.new
|
|
956
1012
|
batch_request.auto_order_oids = auto_order_oids
|
|
957
|
-
api_response = auto_order_api.get_auto_orders_batch(batch_request, { '_expand' => expand })
|
|
1013
|
+
api_response = auto_order_api.get_auto_orders_batch(batch_request, { :'_expand' => expand })
|
|
958
1014
|
auto_orders = api_response.auto_orders
|
|
959
1015
|
|
|
960
1016
|
# this will be verbose...
|
|
@@ -1112,10 +1168,10 @@ def get_auto_order_chunk(auto_order_api, offset, limit)
|
|
|
1112
1168
|
query.email = "support@ultracart.com"
|
|
1113
1169
|
|
|
1114
1170
|
opts = {
|
|
1115
|
-
_limit
|
|
1116
|
-
_offset
|
|
1117
|
-
_sort
|
|
1118
|
-
_expand
|
|
1171
|
+
:'_limit' => limit,
|
|
1172
|
+
:'_offset' => offset,
|
|
1173
|
+
:'_sort' => "next_shipment_dts",
|
|
1174
|
+
:'_expand' => expand
|
|
1119
1175
|
}
|
|
1120
1176
|
|
|
1121
1177
|
api_response = auto_order_api.get_auto_orders_by_query(query, opts)
|
|
@@ -1225,7 +1281,7 @@ auto_order_api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_
|
|
|
1225
1281
|
|
|
1226
1282
|
expand = "items" # see https://www.ultracart.com/api/#resource_auto_order.html for list
|
|
1227
1283
|
auto_order_oid = 123456789 # get an auto order and update it. There are many ways to retrieve an auto order.
|
|
1228
|
-
get_response = auto_order_api.get_auto_order(auto_order_oid, {_expand
|
|
1284
|
+
get_response = auto_order_api.get_auto_order(auto_order_oid, {:'_expand' => expand})
|
|
1229
1285
|
auto_order = get_response.auto_order
|
|
1230
1286
|
|
|
1231
1287
|
pause_response = auto_order_api.pause_auto_order(auto_order_oid, auto_order)
|
|
@@ -1309,7 +1365,7 @@ email = 'test@test.com'
|
|
|
1309
1365
|
query = UltracartClient::AutoOrderQuery.new
|
|
1310
1366
|
query.email = email
|
|
1311
1367
|
expansion = 'items,items.future_schedules,items.simple_schedule,rebill_orders'
|
|
1312
|
-
ao_response = ao_api.get_auto_orders_by_query(query, { _expand
|
|
1368
|
+
ao_response = ao_api.get_auto_orders_by_query(query, { :'_expand' => expansion })
|
|
1313
1369
|
|
|
1314
1370
|
# there should only be one auto order for a customer. that's typical.
|
|
1315
1371
|
# If you are marketing more than one, than you must loop through the result set
|
|
@@ -1325,7 +1381,7 @@ auto_order.items.each do |auto_order_item|
|
|
|
1325
1381
|
end
|
|
1326
1382
|
|
|
1327
1383
|
# save the auto order with the updated item.
|
|
1328
|
-
ao_api.update_auto_order(auto_order, auto_order.auto_order_oid, { _expand
|
|
1384
|
+
ao_api.update_auto_order(auto_order, auto_order.auto_order_oid, { :'_expand' => expansion })
|
|
1329
1385
|
|
|
1330
1386
|
|
|
1331
1387
|
|
|
@@ -1640,9 +1696,9 @@ auto_orders_request = UltracartClient::AutoOrdersRequest.new
|
|
|
1640
1696
|
auto_orders_request.auto_orders = auto_orders
|
|
1641
1697
|
|
|
1642
1698
|
opts = {
|
|
1643
|
-
_expand
|
|
1644
|
-
_placeholders
|
|
1645
|
-
_async
|
|
1699
|
+
:'_expand' => expand,
|
|
1700
|
+
:'_placeholders' => placeholders,
|
|
1701
|
+
:'_async' => async
|
|
1646
1702
|
}
|
|
1647
1703
|
|
|
1648
1704
|
api_response = auto_order_api.update_auto_orders_batch(auto_orders_request, opts)
|
data/docs/ChannelPartnerApi.md
CHANGED
|
@@ -592,7 +592,7 @@ _expand = "item,summary,shipping"
|
|
|
592
592
|
|
|
593
593
|
# This order MUST be an order associated with this channel partner or you will receive a 400 Bad Request.
|
|
594
594
|
order_id = 'DEMO-0009110366'
|
|
595
|
-
api_response = channel_partner_api.get_channel_partner_order(order_id, { '_expand' => _expand })
|
|
595
|
+
api_response = channel_partner_api.get_channel_partner_order(order_id, { :'_expand' => _expand })
|
|
596
596
|
|
|
597
597
|
if api_response.error
|
|
598
598
|
STDERR.puts api_response.error.developer_message
|
|
@@ -690,7 +690,7 @@ _expand = "item,summary,shipping"
|
|
|
690
690
|
|
|
691
691
|
# This order MUST be an order associated with this channel partner or you will receive a 400 Bad Request.
|
|
692
692
|
channel_partner_order_id = 'MY-CALL-CENTER-BLAH-BLAH'
|
|
693
|
-
api_response = channel_partner_api.get_channel_partner_order_by_channel_partner_order_id(channel_partner_order_id, { '_expand' => _expand })
|
|
693
|
+
api_response = channel_partner_api.get_channel_partner_order_by_channel_partner_order_id(channel_partner_order_id, { :'_expand' => _expand })
|
|
694
694
|
|
|
695
695
|
if api_response.error
|
|
696
696
|
STDERR.puts api_response.error.developer_message
|
|
@@ -1482,7 +1482,7 @@ expansion = "item,summary,shipping"
|
|
|
1482
1482
|
|
|
1483
1483
|
# This order MUST be an order associated with this channel partner, or you will receive a 400 Bad Request.
|
|
1484
1484
|
order_id = 'DEMO-0009106820'
|
|
1485
|
-
api_response = channel_partner_api.get_channel_partner_order(order_id, _expand
|
|
1485
|
+
api_response = channel_partner_api.get_channel_partner_order(order_id, {:'_expand' => expansion})
|
|
1486
1486
|
|
|
1487
1487
|
if api_response.error
|
|
1488
1488
|
STDERR.puts api_response.error.developer_message
|
|
@@ -1517,15 +1517,15 @@ reverse_affiliate_transactions = true # for a full refund, the affiliate should
|
|
|
1517
1517
|
issue_store_credit = false # if true, the customer would receive store credit instead of a return on their credit card.
|
|
1518
1518
|
auto_order_cancel_reason = nil
|
|
1519
1519
|
|
|
1520
|
-
api_response = channel_partner_api.refund_channel_partner_order(order_id, order,
|
|
1521
|
-
reject_after_refund
|
|
1522
|
-
skip_customer_notifications
|
|
1523
|
-
auto_order_cancel
|
|
1524
|
-
manual_refund
|
|
1525
|
-
reverse_affiliate_transactions
|
|
1526
|
-
issue_store_credit
|
|
1527
|
-
auto_order_cancel_reason
|
|
1528
|
-
_expand
|
|
1520
|
+
api_response = channel_partner_api.refund_channel_partner_order(order_id, order, {
|
|
1521
|
+
:'reject_after_refund' => reject_after_refund,
|
|
1522
|
+
:'skip_customer_notifications' => skip_customer_notifications,
|
|
1523
|
+
:'auto_order_cancel' => auto_order_cancel,
|
|
1524
|
+
:'manual_refund' => manual_refund,
|
|
1525
|
+
:'reverse_affiliate_transactions' => reverse_affiliate_transactions,
|
|
1526
|
+
:'issue_store_credit' => issue_store_credit,
|
|
1527
|
+
:'auto_order_cancel_reason' => auto_order_cancel_reason,
|
|
1528
|
+
:'_expand' => expansion })
|
|
1529
1529
|
|
|
1530
1530
|
error = api_response.error
|
|
1531
1531
|
updated_order = api_response.order
|
data/docs/CheckoutApi.md
CHANGED
|
@@ -136,7 +136,7 @@ cart_id = cookies[Constants::CART_ID_COOKIE_NAME] if cookies[Constants::CART_ID_
|
|
|
136
136
|
|
|
137
137
|
cart = nil
|
|
138
138
|
if cart_id.nil?
|
|
139
|
-
api_response = checkout_api.get_cart(_expand
|
|
139
|
+
api_response = checkout_api.get_cart({:'_expand' => expansion})
|
|
140
140
|
else
|
|
141
141
|
api_response = checkout_api.get_cart_by_cart_id(cart_id, _expand: expansion)
|
|
142
142
|
end
|
|
@@ -537,7 +537,7 @@ expansion = "items,billing,shipping,coupons,checkout,payment,summary,taxes"
|
|
|
537
537
|
# summary upsell_after
|
|
538
538
|
|
|
539
539
|
return_code = '1234567890' # usually retrieved from a query parameter
|
|
540
|
-
api_response = checkout_api.get_cart_by_return_code(return_code, _expand
|
|
540
|
+
api_response = checkout_api.get_cart_by_return_code(return_code, {:'_expand' => expansion})
|
|
541
541
|
cart = api_response.cart
|
|
542
542
|
|
|
543
543
|
# TODO: set or re-set the cart cookie if this is part of a multi-page process. two weeks is a generous cart id time.
|
|
@@ -622,7 +622,7 @@ expansion = "items,billing,shipping,coupons,checkout,payment,summary,taxes"
|
|
|
622
622
|
# summary upsell_after
|
|
623
623
|
|
|
624
624
|
cart_token = '1234567890' # usually retrieved from a query parameter
|
|
625
|
-
api_response = checkout_api.get_cart_by_return_token(cart_token, _expand
|
|
625
|
+
api_response = checkout_api.get_cart_by_return_token({:'return_token' => cart_token, :'_expand' => expansion})
|
|
626
626
|
cart = api_response.cart
|
|
627
627
|
|
|
628
628
|
# TODO: set or re-set the cart cookie if this is part of a multi-page process. two weeks is a generous cart id time.
|
|
@@ -1220,9 +1220,9 @@ expansion = 'customer_profile,items,billing,shipping,coupons,checkout,payment,su
|
|
|
1220
1220
|
cart_id = ENV['HTTP_ULTRACARTSHOPPINGCARTID']
|
|
1221
1221
|
|
|
1222
1222
|
cart = if cart_id.nil?
|
|
1223
|
-
checkout_api.get_cart({_expand
|
|
1223
|
+
checkout_api.get_cart({:'_expand' => expansion}).cart
|
|
1224
1224
|
else
|
|
1225
|
-
checkout_api.get_cart_by_cart_id(cart_id, {_expand
|
|
1225
|
+
checkout_api.get_cart_by_cart_id(cart_id, {:'_expand' => expansion}).cart
|
|
1226
1226
|
end
|
|
1227
1227
|
|
|
1228
1228
|
# TODO - add some items to the cart and update.
|
|
@@ -1235,7 +1235,7 @@ items << cart_item
|
|
|
1235
1235
|
cart.items = items
|
|
1236
1236
|
|
|
1237
1237
|
# Update the cart
|
|
1238
|
-
cart = checkout_api.update_cart(cart, { '_expand' => expansion }).cart
|
|
1238
|
+
cart = checkout_api.update_cart(cart, { :'_expand' => expansion }).cart
|
|
1239
1239
|
|
|
1240
1240
|
api_response = checkout_api.related_items_for_cart(cart)
|
|
1241
1241
|
related_items = api_response.items
|
|
@@ -1310,9 +1310,9 @@ expansion = 'customer_profile,items,billing,shipping,coupons,checkout,payment,su
|
|
|
1310
1310
|
cart_id = ENV['HTTP_ULTRACARTSHOPPINGCARTID']
|
|
1311
1311
|
|
|
1312
1312
|
cart = if cart_id.nil?
|
|
1313
|
-
checkout_api.get_cart({_expand
|
|
1313
|
+
checkout_api.get_cart({:'_expand' => expansion}).cart
|
|
1314
1314
|
else
|
|
1315
|
-
checkout_api.get_cart_by_cart_id(cart_id, {_expand
|
|
1315
|
+
checkout_api.get_cart_by_cart_id(cart_id, {:'_expand' => expansion}).cart
|
|
1316
1316
|
end
|
|
1317
1317
|
|
|
1318
1318
|
# TODO - add some items to the cart and update.
|
|
@@ -1325,11 +1325,11 @@ items << cart_item
|
|
|
1325
1325
|
cart.items = items
|
|
1326
1326
|
|
|
1327
1327
|
# Update the cart
|
|
1328
|
-
cart = checkout_api.update_cart(cart, {
|
|
1328
|
+
cart = checkout_api.update_cart(cart, {:'_expand' => expansion }).cart
|
|
1329
1329
|
|
|
1330
1330
|
another_item_id = 'ITEM_ZZZ'
|
|
1331
1331
|
|
|
1332
|
-
api_response = checkout_api.related_items_for_item(another_item_id, cart, {
|
|
1332
|
+
api_response = checkout_api.related_items_for_item(another_item_id, cart, {:'_expand' => expansion })
|
|
1333
1333
|
related_items = api_response.items
|
|
1334
1334
|
|
|
1335
1335
|
puts related_items.inspect
|
|
@@ -1466,11 +1466,11 @@ expansion = 'items' # For this example, we're just getting a cart to insert some
|
|
|
1466
1466
|
|
|
1467
1467
|
cart_id = nil
|
|
1468
1468
|
cart_id = ENV['HTTP_COOKIE'].to_s[/#{Constants::CART_ID_COOKIE_NAME}=([^;]+)/, 1] if ENV['HTTP_COOKIE']
|
|
1469
|
-
|
|
1469
|
+
opts = { :'_expand' => expansion }
|
|
1470
1470
|
cart = if cart_id.nil?
|
|
1471
|
-
checkout_api.get_cart(
|
|
1471
|
+
checkout_api.get_cart(opts).cart
|
|
1472
1472
|
else
|
|
1473
|
-
checkout_api.get_cart_by_cart_id(cart_id,
|
|
1473
|
+
checkout_api.get_cart_by_cart_id(cart_id, opts).cart
|
|
1474
1474
|
end
|
|
1475
1475
|
|
|
1476
1476
|
# Get the items array on the cart, creating it if it doesn't exist.
|
|
@@ -1492,7 +1492,7 @@ items << item
|
|
|
1492
1492
|
cart.items = items
|
|
1493
1493
|
|
|
1494
1494
|
# Push the cart up to save the item
|
|
1495
|
-
cart_response = checkout_api.update_cart(cart,
|
|
1495
|
+
cart_response = checkout_api.update_cart(cart, opts)
|
|
1496
1496
|
|
|
1497
1497
|
# Extract the updated cart from the response
|
|
1498
1498
|
cart = cart_response.cart
|
|
@@ -1565,8 +1565,9 @@ checkout_api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY
|
|
|
1565
1565
|
cart_id = '123456789123456789123456789123456789' # Usually this would be retrieved from a session variable or cookie.
|
|
1566
1566
|
|
|
1567
1567
|
expansion = 'items,billing,shipping,coupons,checkout,payment,summary,taxes'
|
|
1568
|
+
opts = {:'_expand' => expansion}
|
|
1568
1569
|
|
|
1569
|
-
cart = checkout_api.get_cart_by_cart_id(cart_id,
|
|
1570
|
+
cart = checkout_api.get_cart_by_cart_id(cart_id, opts).cart
|
|
1570
1571
|
|
|
1571
1572
|
validation_request = UltracartClient::CartValidationRequest.new
|
|
1572
1573
|
validation_request.cart = cart
|
|
@@ -1574,7 +1575,7 @@ validation_request.cart = cart
|
|
|
1574
1575
|
# Possible Checks (you can set these as needed, or leave as default):
|
|
1575
1576
|
# validation_request.set_checks(["All", "Item Quantity Valid", "Payment Information Validate"])
|
|
1576
1577
|
|
|
1577
|
-
api_response = checkout_api.validate_cart(validation_request,
|
|
1578
|
+
api_response = checkout_api.validate_cart(validation_request, opts)
|
|
1578
1579
|
cart = api_response.cart
|
|
1579
1580
|
|
|
1580
1581
|
puts "Validation Errors:"
|
data/docs/CouponApi.md
CHANGED
|
@@ -499,7 +499,7 @@ coupon_api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY)
|
|
|
499
499
|
coupon_oid = 123456789
|
|
500
500
|
|
|
501
501
|
# coupons do not have expansions
|
|
502
|
-
api_response = coupon_api.get_coupon(coupon_oid, {
|
|
502
|
+
api_response = coupon_api.get_coupon(coupon_oid, {})
|
|
503
503
|
|
|
504
504
|
puts api_response.inspect
|
|
505
505
|
```
|
|
@@ -646,19 +646,19 @@ def get_coupons_chunk(coupon_api, offset = 0, limit = 200)
|
|
|
646
646
|
|
|
647
647
|
# getCoupons doesn't have any expansions. full record is always returned.
|
|
648
648
|
opts = {
|
|
649
|
-
merchant_code
|
|
650
|
-
description
|
|
651
|
-
coupon_type
|
|
652
|
-
start_date_begin
|
|
653
|
-
start_date_end
|
|
654
|
-
expiration_date_begin
|
|
655
|
-
expiration_date_end
|
|
656
|
-
affiliate_oid
|
|
657
|
-
exclude_expired
|
|
658
|
-
_limit
|
|
659
|
-
_offset
|
|
660
|
-
_sort
|
|
661
|
-
_expand
|
|
649
|
+
:'merchant_code' => merchant_code,
|
|
650
|
+
:'description' => description,
|
|
651
|
+
:'coupon_type' => coupon_type,
|
|
652
|
+
:'start_date_begin' => start_date_begin,
|
|
653
|
+
:'start_date_end' => start_date_end,
|
|
654
|
+
:'expiration_date_begin' => expiration_date_begin,
|
|
655
|
+
:'expiration_date_end' => expiration_date_end,
|
|
656
|
+
:'affiliate_oid' => affiliate_oid,
|
|
657
|
+
:'exclude_expired' => exclude_expired,
|
|
658
|
+
:'_limit' => limit,
|
|
659
|
+
:'_offset' => offset,
|
|
660
|
+
:'_sort' => nil,
|
|
661
|
+
:'_expand' => nil
|
|
662
662
|
}
|
|
663
663
|
|
|
664
664
|
get_response = coupon_api.get_coupons(opts)
|
|
@@ -834,8 +834,8 @@ def get_coupon_chunk(coupon_api, offset, limit)
|
|
|
834
834
|
# coupons do not have expansions
|
|
835
835
|
# Possible sorts: "coupon_type", "merchant_code", "description", "start_dts", "expiration_dts", "quickbooks_code"
|
|
836
836
|
opts = {
|
|
837
|
-
_expand
|
|
838
|
-
_sort
|
|
837
|
+
:'_expand' => nil,
|
|
838
|
+
:'_sort' => 'merchant_code'
|
|
839
839
|
}
|
|
840
840
|
|
|
841
841
|
api_response = coupon_api.get_coupons_by_query(query, limit, offset, opts)
|
|
@@ -1042,7 +1042,7 @@ coupon.amount_off_subtotal.discount_amount = 11
|
|
|
1042
1042
|
#CouponTierQuantityPercent
|
|
1043
1043
|
|
|
1044
1044
|
# coupons do not have expansions
|
|
1045
|
-
api_response = coupon_api.insert_coupon(coupon, {
|
|
1045
|
+
api_response = coupon_api.insert_coupon(coupon, {})
|
|
1046
1046
|
puts api_response
|
|
1047
1047
|
```
|
|
1048
1048
|
|
|
@@ -1113,7 +1113,7 @@ coupons = []
|
|
|
1113
1113
|
coupons_request.coupons = coupons
|
|
1114
1114
|
|
|
1115
1115
|
# coupons do not have expansions or placeholders
|
|
1116
|
-
api_response = coupon_api.insert_coupons(coupons_request, {
|
|
1116
|
+
api_response = coupon_api.insert_coupons(coupons_request, {})
|
|
1117
1117
|
puts api_response
|
|
1118
1118
|
```
|
|
1119
1119
|
|
|
@@ -1316,13 +1316,13 @@ coupon_api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY)
|
|
|
1316
1316
|
coupon_oid = 123456789
|
|
1317
1317
|
|
|
1318
1318
|
# coupons do not have expansions
|
|
1319
|
-
api_response = coupon_api.get_coupon(coupon_oid, {
|
|
1319
|
+
api_response = coupon_api.get_coupon(coupon_oid, {})
|
|
1320
1320
|
coupon = api_response.coupon
|
|
1321
1321
|
|
|
1322
1322
|
# update the coupon. this can be difficult given the complexity of coupons. see insertCoupon sample for details.
|
|
1323
1323
|
coupon.expiration_dts = (Date.today + 90).strftime('%Y-%m-%d') + 'T00:00:00+00:00'
|
|
1324
1324
|
|
|
1325
|
-
api_response = coupon_api.update_coupon(coupon_oid, coupon, {
|
|
1325
|
+
api_response = coupon_api.update_coupon(coupon_oid, coupon, {})
|
|
1326
1326
|
updated_coupon = api_response.coupon
|
|
1327
1327
|
puts updated_coupon
|
|
1328
1328
|
```
|
|
@@ -1388,7 +1388,7 @@ coupon_api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY)
|
|
|
1388
1388
|
coupon_oid = 123456789
|
|
1389
1389
|
|
|
1390
1390
|
# coupons do not have expansions or placeholders
|
|
1391
|
-
api_response = coupon_api.get_coupon(coupon_oid, {
|
|
1391
|
+
api_response = coupon_api.get_coupon(coupon_oid, {})
|
|
1392
1392
|
coupon = api_response.coupon
|
|
1393
1393
|
|
|
1394
1394
|
# update the coupon. this can be difficult given the complexity of coupons. see insertCoupon sample for details.
|
|
@@ -1398,7 +1398,7 @@ coupon.expiration_dts = (Date.today + 90).strftime('%Y-%m-%d') + 'T00:00:00+00:0
|
|
|
1398
1398
|
coupons_request = UltracartClient::CouponsRequest.new
|
|
1399
1399
|
coupons_request.coupons = [coupon]
|
|
1400
1400
|
|
|
1401
|
-
api_response = coupon_api.update_coupons(coupons_request, {
|
|
1401
|
+
api_response = coupon_api.update_coupons(coupons_request, {})
|
|
1402
1402
|
updated_coupons = api_response.coupons
|
|
1403
1403
|
puts updated_coupons
|
|
1404
1404
|
```
|
data/docs/CustomerApi.md
CHANGED
|
@@ -555,7 +555,7 @@ begin
|
|
|
555
555
|
api_response = customer_api.get_customer(
|
|
556
556
|
customer_oid,
|
|
557
557
|
opts: {
|
|
558
|
-
'_expand' => 'billing,shipping'
|
|
558
|
+
:'_expand' => 'billing,shipping'
|
|
559
559
|
}
|
|
560
560
|
)
|
|
561
561
|
|
|
@@ -653,7 +653,7 @@ begin
|
|
|
653
653
|
api_response = customer_api.get_customer_by_email(
|
|
654
654
|
email,
|
|
655
655
|
opts: {
|
|
656
|
-
'_expand' => 'billing,shipping'
|
|
656
|
+
:'_expand' => 'billing,shipping'
|
|
657
657
|
}
|
|
658
658
|
)
|
|
659
659
|
|
|
@@ -1991,7 +1991,7 @@ customer.billing = [billing] # notice this is an array of one shipping address (
|
|
|
1991
1991
|
# tags
|
|
1992
1992
|
# loyalty
|
|
1993
1993
|
|
|
1994
|
-
opts = {_expand
|
|
1994
|
+
opts = {:'_expand' => 'shipping,billing'}
|
|
1995
1995
|
begin
|
|
1996
1996
|
customer_response = customer_api.insert_customer(customer, opts)
|
|
1997
1997
|
puts customer_response.to_json
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::EmailCommseqEmailReviewStatus
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **decided_dts** | **String** | Date the review was approved or rejected | [optional] |
|
|
8
|
+
| **esp_commseq_email_review_uuid** | **String** | Review UUID | [optional] |
|
|
9
|
+
| **esp_commseq_email_uuid** | **String** | Email communication sequence email UUID | [optional] |
|
|
10
|
+
| **esp_commseq_uuid** | **String** | Email communication sequence UUID | [optional] |
|
|
11
|
+
| **rejection_reason** | **String** | Why the email was rejected, and what to change. Only present when the state is rejected. | [optional] |
|
|
12
|
+
| **requested_dts** | **String** | Date the review was requested | [optional] |
|
|
13
|
+
| **state** | **String** | State of the review | [optional] |
|
|
14
|
+
| **subject** | **String** | Subject of the email as it was reviewed | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::EmailCommseqEmailReviewStatus.new(
|
|
22
|
+
decided_dts: null,
|
|
23
|
+
esp_commseq_email_review_uuid: null,
|
|
24
|
+
esp_commseq_email_uuid: null,
|
|
25
|
+
esp_commseq_uuid: null,
|
|
26
|
+
rejection_reason: null,
|
|
27
|
+
requested_dts: null,
|
|
28
|
+
state: null,
|
|
29
|
+
subject: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::EmailCommseqEmailReviewStatusResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
9
|
+
| **review_status** | [**EmailCommseqEmailReviewStatus**](EmailCommseqEmailReviewStatus.md) | | [optional] |
|
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::EmailCommseqEmailReviewStatusResponse.new(
|
|
19
|
+
error: null,
|
|
20
|
+
metadata: null,
|
|
21
|
+
review_status: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::EmailCommseqEmailReviewStatusesRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **esp_commseq_email_uuids** | **Array<String>** | Email communication sequence email UUIDs to return the review status of | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::EmailCommseqEmailReviewStatusesRequest.new(
|
|
15
|
+
esp_commseq_email_uuids: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|