ultracart_rest_api_v2_typescript 3.10.118 → 3.10.120
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.
- package/README.md +4 -2
- package/api.ts +92 -0
- package/dist/api.d.ts +91 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.10.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.10.120
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install ultracart_rest_api_v2_typescript@3.10.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.10.120 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.10.120 | 02/22/2023 | convo - customer initiated flag on engagement |
|
|
58
|
+
| 3.10.119 | 02/20/2023 | refund reasons |
|
|
57
59
|
| 3.10.118 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
|
|
58
60
|
| 3.10.117 | 02/15/2023 | added auto order sorting by next_shipment_dts |
|
|
59
61
|
| 3.10.116 | 02/10/2023 | convo - add storefront_host_name to search request |
|
package/api.ts
CHANGED
|
@@ -7304,6 +7304,12 @@ export interface ConversationEngagement {
|
|
|
7304
7304
|
* @memberof ConversationEngagement
|
|
7305
7305
|
*/
|
|
7306
7306
|
customer_greeting?: string;
|
|
7307
|
+
/**
|
|
7308
|
+
*
|
|
7309
|
+
* @type {boolean}
|
|
7310
|
+
* @memberof ConversationEngagement
|
|
7311
|
+
*/
|
|
7312
|
+
customer_initiated?: boolean;
|
|
7307
7313
|
/**
|
|
7308
7314
|
*
|
|
7309
7315
|
* @type {Array<number>}
|
|
@@ -28309,12 +28315,24 @@ export interface Order {
|
|
|
28309
28315
|
* @memberof Order
|
|
28310
28316
|
*/
|
|
28311
28317
|
refund_dts?: string;
|
|
28318
|
+
/**
|
|
28319
|
+
* Refund reason code. This can only be written during a refund operation otherwise this field is read only.
|
|
28320
|
+
* @type {string}
|
|
28321
|
+
* @memberof Order
|
|
28322
|
+
*/
|
|
28323
|
+
refund_reason?: string;
|
|
28312
28324
|
/**
|
|
28313
28325
|
* If the order was rejected, the date/time that the rejection occurred
|
|
28314
28326
|
* @type {string}
|
|
28315
28327
|
* @memberof Order
|
|
28316
28328
|
*/
|
|
28317
28329
|
reject_dts?: string;
|
|
28330
|
+
/**
|
|
28331
|
+
* Reject reason code. This can only be written during a reject operation otherwise this field is read only.
|
|
28332
|
+
* @type {string}
|
|
28333
|
+
* @memberof Order
|
|
28334
|
+
*/
|
|
28335
|
+
reject_reason?: string;
|
|
28318
28336
|
/**
|
|
28319
28337
|
*
|
|
28320
28338
|
* @type {OrderSalesforce}
|
|
@@ -29877,6 +29895,18 @@ export interface OrderItem {
|
|
|
29877
29895
|
* @memberof OrderItem
|
|
29878
29896
|
*/
|
|
29879
29897
|
quickbooks_class?: string;
|
|
29898
|
+
/**
|
|
29899
|
+
* Refund reason code. This can only be written during a refund operation otherwise this field is read only.
|
|
29900
|
+
* @type {string}
|
|
29901
|
+
* @memberof OrderItem
|
|
29902
|
+
*/
|
|
29903
|
+
refund_reason?: string;
|
|
29904
|
+
/**
|
|
29905
|
+
* Return reason code. This can only be written during a refund operation otherwise this field is read only.
|
|
29906
|
+
* @type {string}
|
|
29907
|
+
* @memberof OrderItem
|
|
29908
|
+
*/
|
|
29909
|
+
return_reason?: string;
|
|
29880
29910
|
/**
|
|
29881
29911
|
* True if this item ships in a separate box
|
|
29882
29912
|
* @type {boolean}
|
|
@@ -31241,6 +31271,32 @@ export interface OrderQuote {
|
|
|
31241
31271
|
quoted_dts?: string;
|
|
31242
31272
|
}
|
|
31243
31273
|
|
|
31274
|
+
/**
|
|
31275
|
+
*
|
|
31276
|
+
* @export
|
|
31277
|
+
* @interface OrderReason
|
|
31278
|
+
*/
|
|
31279
|
+
export interface OrderReason {
|
|
31280
|
+
/**
|
|
31281
|
+
* Default reason
|
|
31282
|
+
* @type {boolean}
|
|
31283
|
+
* @memberof OrderReason
|
|
31284
|
+
*/
|
|
31285
|
+
default_reason?: boolean;
|
|
31286
|
+
/**
|
|
31287
|
+
* Reason description. This is the friendly description of the reason that should be displayed to the user.
|
|
31288
|
+
* @type {string}
|
|
31289
|
+
* @memberof OrderReason
|
|
31290
|
+
*/
|
|
31291
|
+
description?: string;
|
|
31292
|
+
/**
|
|
31293
|
+
* Reason value. This is what should be submitted with a refund operation.
|
|
31294
|
+
* @type {string}
|
|
31295
|
+
* @memberof OrderReason
|
|
31296
|
+
*/
|
|
31297
|
+
value?: string;
|
|
31298
|
+
}
|
|
31299
|
+
|
|
31244
31300
|
/**
|
|
31245
31301
|
*
|
|
31246
31302
|
* @export
|
|
@@ -31253,12 +31309,48 @@ export interface OrderRefundableResponse {
|
|
|
31253
31309
|
* @memberof OrderRefundableResponse
|
|
31254
31310
|
*/
|
|
31255
31311
|
error?: ModelError;
|
|
31312
|
+
/**
|
|
31313
|
+
* True if the item level refund reason is required
|
|
31314
|
+
* @type {boolean}
|
|
31315
|
+
* @memberof OrderRefundableResponse
|
|
31316
|
+
*/
|
|
31317
|
+
item_level_refund_reason_required?: boolean;
|
|
31318
|
+
/**
|
|
31319
|
+
* Reason codes available at the item level.
|
|
31320
|
+
* @type {Array<OrderReason>}
|
|
31321
|
+
* @memberof OrderRefundableResponse
|
|
31322
|
+
*/
|
|
31323
|
+
item_level_refund_reasons?: Array<OrderReason>;
|
|
31324
|
+
/**
|
|
31325
|
+
* Return codes available at the item level.
|
|
31326
|
+
* @type {Array<OrderReason>}
|
|
31327
|
+
* @memberof OrderRefundableResponse
|
|
31328
|
+
*/
|
|
31329
|
+
item_level_return_reasons?: Array<OrderReason>;
|
|
31256
31330
|
/**
|
|
31257
31331
|
*
|
|
31258
31332
|
* @type {ResponseMetadata}
|
|
31259
31333
|
* @memberof OrderRefundableResponse
|
|
31260
31334
|
*/
|
|
31261
31335
|
metadata?: ResponseMetadata;
|
|
31336
|
+
/**
|
|
31337
|
+
* True if the order level refund reason is required
|
|
31338
|
+
* @type {boolean}
|
|
31339
|
+
* @memberof OrderRefundableResponse
|
|
31340
|
+
*/
|
|
31341
|
+
order_level_refund_reason_required?: boolean;
|
|
31342
|
+
/**
|
|
31343
|
+
* Reason codes available at the order level.
|
|
31344
|
+
* @type {Array<OrderReason>}
|
|
31345
|
+
* @memberof OrderRefundableResponse
|
|
31346
|
+
*/
|
|
31347
|
+
order_level_refund_reasons?: Array<OrderReason>;
|
|
31348
|
+
/**
|
|
31349
|
+
* Reject codes available at the order level.
|
|
31350
|
+
* @type {Array<OrderReason>}
|
|
31351
|
+
* @memberof OrderRefundableResponse
|
|
31352
|
+
*/
|
|
31353
|
+
order_level_reject_reasons?: Array<OrderReason>;
|
|
31262
31354
|
/**
|
|
31263
31355
|
* Whether the order is refundable or not. Null should be interpreted as false.
|
|
31264
31356
|
* @type {boolean}
|
package/dist/api.d.ts
CHANGED
|
@@ -7131,6 +7131,12 @@ export interface ConversationEngagement {
|
|
|
7131
7131
|
* @memberof ConversationEngagement
|
|
7132
7132
|
*/
|
|
7133
7133
|
customer_greeting?: string;
|
|
7134
|
+
/**
|
|
7135
|
+
*
|
|
7136
|
+
* @type {boolean}
|
|
7137
|
+
* @memberof ConversationEngagement
|
|
7138
|
+
*/
|
|
7139
|
+
customer_initiated?: boolean;
|
|
7134
7140
|
/**
|
|
7135
7141
|
*
|
|
7136
7142
|
* @type {Array<number>}
|
|
@@ -27705,12 +27711,24 @@ export interface Order {
|
|
|
27705
27711
|
* @memberof Order
|
|
27706
27712
|
*/
|
|
27707
27713
|
refund_dts?: string;
|
|
27714
|
+
/**
|
|
27715
|
+
* Refund reason code. This can only be written during a refund operation otherwise this field is read only.
|
|
27716
|
+
* @type {string}
|
|
27717
|
+
* @memberof Order
|
|
27718
|
+
*/
|
|
27719
|
+
refund_reason?: string;
|
|
27708
27720
|
/**
|
|
27709
27721
|
* If the order was rejected, the date/time that the rejection occurred
|
|
27710
27722
|
* @type {string}
|
|
27711
27723
|
* @memberof Order
|
|
27712
27724
|
*/
|
|
27713
27725
|
reject_dts?: string;
|
|
27726
|
+
/**
|
|
27727
|
+
* Reject reason code. This can only be written during a reject operation otherwise this field is read only.
|
|
27728
|
+
* @type {string}
|
|
27729
|
+
* @memberof Order
|
|
27730
|
+
*/
|
|
27731
|
+
reject_reason?: string;
|
|
27714
27732
|
/**
|
|
27715
27733
|
*
|
|
27716
27734
|
* @type {OrderSalesforce}
|
|
@@ -29248,6 +29266,18 @@ export interface OrderItem {
|
|
|
29248
29266
|
* @memberof OrderItem
|
|
29249
29267
|
*/
|
|
29250
29268
|
quickbooks_class?: string;
|
|
29269
|
+
/**
|
|
29270
|
+
* Refund reason code. This can only be written during a refund operation otherwise this field is read only.
|
|
29271
|
+
* @type {string}
|
|
29272
|
+
* @memberof OrderItem
|
|
29273
|
+
*/
|
|
29274
|
+
refund_reason?: string;
|
|
29275
|
+
/**
|
|
29276
|
+
* Return reason code. This can only be written during a refund operation otherwise this field is read only.
|
|
29277
|
+
* @type {string}
|
|
29278
|
+
* @memberof OrderItem
|
|
29279
|
+
*/
|
|
29280
|
+
return_reason?: string;
|
|
29251
29281
|
/**
|
|
29252
29282
|
* True if this item ships in a separate box
|
|
29253
29283
|
* @type {boolean}
|
|
@@ -30580,6 +30610,31 @@ export interface OrderQuote {
|
|
|
30580
30610
|
*/
|
|
30581
30611
|
quoted_dts?: string;
|
|
30582
30612
|
}
|
|
30613
|
+
/**
|
|
30614
|
+
*
|
|
30615
|
+
* @export
|
|
30616
|
+
* @interface OrderReason
|
|
30617
|
+
*/
|
|
30618
|
+
export interface OrderReason {
|
|
30619
|
+
/**
|
|
30620
|
+
* Default reason
|
|
30621
|
+
* @type {boolean}
|
|
30622
|
+
* @memberof OrderReason
|
|
30623
|
+
*/
|
|
30624
|
+
default_reason?: boolean;
|
|
30625
|
+
/**
|
|
30626
|
+
* Reason description. This is the friendly description of the reason that should be displayed to the user.
|
|
30627
|
+
* @type {string}
|
|
30628
|
+
* @memberof OrderReason
|
|
30629
|
+
*/
|
|
30630
|
+
description?: string;
|
|
30631
|
+
/**
|
|
30632
|
+
* Reason value. This is what should be submitted with a refund operation.
|
|
30633
|
+
* @type {string}
|
|
30634
|
+
* @memberof OrderReason
|
|
30635
|
+
*/
|
|
30636
|
+
value?: string;
|
|
30637
|
+
}
|
|
30583
30638
|
/**
|
|
30584
30639
|
*
|
|
30585
30640
|
* @export
|
|
@@ -30592,12 +30647,48 @@ export interface OrderRefundableResponse {
|
|
|
30592
30647
|
* @memberof OrderRefundableResponse
|
|
30593
30648
|
*/
|
|
30594
30649
|
error?: ModelError;
|
|
30650
|
+
/**
|
|
30651
|
+
* True if the item level refund reason is required
|
|
30652
|
+
* @type {boolean}
|
|
30653
|
+
* @memberof OrderRefundableResponse
|
|
30654
|
+
*/
|
|
30655
|
+
item_level_refund_reason_required?: boolean;
|
|
30656
|
+
/**
|
|
30657
|
+
* Reason codes available at the item level.
|
|
30658
|
+
* @type {Array<OrderReason>}
|
|
30659
|
+
* @memberof OrderRefundableResponse
|
|
30660
|
+
*/
|
|
30661
|
+
item_level_refund_reasons?: Array<OrderReason>;
|
|
30662
|
+
/**
|
|
30663
|
+
* Return codes available at the item level.
|
|
30664
|
+
* @type {Array<OrderReason>}
|
|
30665
|
+
* @memberof OrderRefundableResponse
|
|
30666
|
+
*/
|
|
30667
|
+
item_level_return_reasons?: Array<OrderReason>;
|
|
30595
30668
|
/**
|
|
30596
30669
|
*
|
|
30597
30670
|
* @type {ResponseMetadata}
|
|
30598
30671
|
* @memberof OrderRefundableResponse
|
|
30599
30672
|
*/
|
|
30600
30673
|
metadata?: ResponseMetadata;
|
|
30674
|
+
/**
|
|
30675
|
+
* True if the order level refund reason is required
|
|
30676
|
+
* @type {boolean}
|
|
30677
|
+
* @memberof OrderRefundableResponse
|
|
30678
|
+
*/
|
|
30679
|
+
order_level_refund_reason_required?: boolean;
|
|
30680
|
+
/**
|
|
30681
|
+
* Reason codes available at the order level.
|
|
30682
|
+
* @type {Array<OrderReason>}
|
|
30683
|
+
* @memberof OrderRefundableResponse
|
|
30684
|
+
*/
|
|
30685
|
+
order_level_refund_reasons?: Array<OrderReason>;
|
|
30686
|
+
/**
|
|
30687
|
+
* Reject codes available at the order level.
|
|
30688
|
+
* @type {Array<OrderReason>}
|
|
30689
|
+
* @memberof OrderRefundableResponse
|
|
30690
|
+
*/
|
|
30691
|
+
order_level_reject_reasons?: Array<OrderReason>;
|
|
30601
30692
|
/**
|
|
30602
30693
|
* Whether the order is refundable or not. Null should be interpreted as false.
|
|
30603
30694
|
* @type {boolean}
|