ultracart_rest_api_v2_typescript 3.10.165 → 3.10.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.
- package/README.md +4 -2
- package/api.ts +133 -2
- package/dist/api.d.ts +131 -2
- package/dist/api.js +1 -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.167
|
|
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.167 --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.167 | 10/30/2023 | cart/order fields for health benefit card values in summary expansion objects |
|
|
58
|
+
| 3.10.166 | 10/27/2023 | workflow task object model refinement |
|
|
57
59
|
| 3.10.165 | 10/23/2023 | workflow tasks api |
|
|
58
60
|
| 3.10.164 | 10/23/2023 | workflow tasks api |
|
|
59
61
|
| 3.10.163 | 10/16/2023 | CartSettingsPaymentCreditCard - add collect_credit_card_verification_number_minimum |
|
package/api.ts
CHANGED
|
@@ -4103,6 +4103,12 @@ export interface CartPayment {
|
|
|
4103
4103
|
* @memberof CartPayment
|
|
4104
4104
|
*/
|
|
4105
4105
|
credit_card?: CartPaymentCreditCard;
|
|
4106
|
+
/**
|
|
4107
|
+
*
|
|
4108
|
+
* @type {CartPaymentHealthBenefitCard}
|
|
4109
|
+
* @memberof CartPayment
|
|
4110
|
+
*/
|
|
4111
|
+
health_benefit_card?: CartPaymentHealthBenefitCard;
|
|
4106
4112
|
/**
|
|
4107
4113
|
* Payment method
|
|
4108
4114
|
* @type {string}
|
|
@@ -4227,6 +4233,50 @@ export interface CartPaymentCreditCard {
|
|
|
4227
4233
|
store_credit_card?: boolean;
|
|
4228
4234
|
}
|
|
4229
4235
|
|
|
4236
|
+
/**
|
|
4237
|
+
*
|
|
4238
|
+
* @export
|
|
4239
|
+
* @interface CartPaymentHealthBenefitCard
|
|
4240
|
+
*/
|
|
4241
|
+
export interface CartPaymentHealthBenefitCard {
|
|
4242
|
+
/**
|
|
4243
|
+
* Health benefit expiration month (1-12)
|
|
4244
|
+
* @type {number}
|
|
4245
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4246
|
+
*/
|
|
4247
|
+
health_benefit_card_expiration_month?: number;
|
|
4248
|
+
/**
|
|
4249
|
+
* Health benefit card expiration year (four digit year)
|
|
4250
|
+
* @type {number}
|
|
4251
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4252
|
+
*/
|
|
4253
|
+
health_benefit_card_expiration_year?: number;
|
|
4254
|
+
/**
|
|
4255
|
+
* Health benefit card number (masked to the last 4)
|
|
4256
|
+
* @type {string}
|
|
4257
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4258
|
+
*/
|
|
4259
|
+
health_benefit_card_number?: string;
|
|
4260
|
+
/**
|
|
4261
|
+
* Hosted field token for the card number
|
|
4262
|
+
* @type {string}
|
|
4263
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4264
|
+
*/
|
|
4265
|
+
health_benefit_card_number_token?: string;
|
|
4266
|
+
/**
|
|
4267
|
+
* Health benefit card verification number (masked)
|
|
4268
|
+
* @type {string}
|
|
4269
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4270
|
+
*/
|
|
4271
|
+
health_benefit_card_verification_number?: string;
|
|
4272
|
+
/**
|
|
4273
|
+
* Hosted field token for the health benefit card verification number
|
|
4274
|
+
* @type {string}
|
|
4275
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4276
|
+
*/
|
|
4277
|
+
health_benefit_card_verification_number_token?: string;
|
|
4278
|
+
}
|
|
4279
|
+
|
|
4230
4280
|
/**
|
|
4231
4281
|
*
|
|
4232
4282
|
* @export
|
|
@@ -5051,6 +5101,18 @@ export interface CartSummary {
|
|
|
5051
5101
|
* @memberof CartSummary
|
|
5052
5102
|
*/
|
|
5053
5103
|
arbitrary_taxable_subtotal?: Currency;
|
|
5104
|
+
/**
|
|
5105
|
+
*
|
|
5106
|
+
* @type {Currency}
|
|
5107
|
+
* @memberof CartSummary
|
|
5108
|
+
*/
|
|
5109
|
+
health_benefit_card_amount?: Currency;
|
|
5110
|
+
/**
|
|
5111
|
+
*
|
|
5112
|
+
* @type {Currency}
|
|
5113
|
+
* @memberof CartSummary
|
|
5114
|
+
*/
|
|
5115
|
+
internal_gift_certificate_amount?: Currency;
|
|
5054
5116
|
/**
|
|
5055
5117
|
*
|
|
5056
5118
|
* @type {Currency}
|
|
@@ -31166,6 +31228,12 @@ export interface OrderPayment {
|
|
|
31166
31228
|
* @memberof OrderPayment
|
|
31167
31229
|
*/
|
|
31168
31230
|
echeck?: OrderPaymentECheck;
|
|
31231
|
+
/**
|
|
31232
|
+
*
|
|
31233
|
+
* @type {OrderPaymentHealthBenefitCard}
|
|
31234
|
+
* @memberof OrderPayment
|
|
31235
|
+
*/
|
|
31236
|
+
health_benefit_card?: OrderPaymentHealthBenefitCard;
|
|
31169
31237
|
/**
|
|
31170
31238
|
* True if order has been held for fraud review
|
|
31171
31239
|
* @type {boolean}
|
|
@@ -31291,7 +31359,8 @@ export namespace OrderPayment {
|
|
|
31291
31359
|
Sezzle = <any> 'Sezzle',
|
|
31292
31360
|
Venmo = <any> 'Venmo',
|
|
31293
31361
|
ApplePay = <any> 'Apple Pay',
|
|
31294
|
-
GooglePay = <any> 'Google Pay'
|
|
31362
|
+
GooglePay = <any> 'Google Pay',
|
|
31363
|
+
HealthBenefitCard = <any> 'Health Benefit Card'
|
|
31295
31364
|
}
|
|
31296
31365
|
/**
|
|
31297
31366
|
* @export
|
|
@@ -31559,6 +31628,50 @@ export namespace OrderPaymentECheck {
|
|
|
31559
31628
|
}
|
|
31560
31629
|
}
|
|
31561
31630
|
|
|
31631
|
+
/**
|
|
31632
|
+
*
|
|
31633
|
+
* @export
|
|
31634
|
+
* @interface OrderPaymentHealthBenefitCard
|
|
31635
|
+
*/
|
|
31636
|
+
export interface OrderPaymentHealthBenefitCard {
|
|
31637
|
+
/**
|
|
31638
|
+
* Health benefit card expiration month (1-12)
|
|
31639
|
+
* @type {number}
|
|
31640
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
31641
|
+
*/
|
|
31642
|
+
health_benefit_card_expiration_month?: number;
|
|
31643
|
+
/**
|
|
31644
|
+
* Health benefit card expiration year (Four digit year)
|
|
31645
|
+
* @type {number}
|
|
31646
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
31647
|
+
*/
|
|
31648
|
+
health_benefit_card_expiration_year?: number;
|
|
31649
|
+
/**
|
|
31650
|
+
* Health benefit card number (masked to last 4)
|
|
31651
|
+
* @type {string}
|
|
31652
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
31653
|
+
*/
|
|
31654
|
+
health_benefit_card_number?: string;
|
|
31655
|
+
/**
|
|
31656
|
+
* Health benefit card number token from hosted fields used to update the health benefit card number
|
|
31657
|
+
* @type {string}
|
|
31658
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
31659
|
+
*/
|
|
31660
|
+
health_benefit_card_number_token?: string;
|
|
31661
|
+
/**
|
|
31662
|
+
* True if the health benefit card has been truncated
|
|
31663
|
+
* @type {boolean}
|
|
31664
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
31665
|
+
*/
|
|
31666
|
+
health_benefit_card_number_truncated?: boolean;
|
|
31667
|
+
/**
|
|
31668
|
+
* Health benefit card verification number token from hosted fields, only for import/insert of new orders, completely ignored for updates, and always null/empty for queries
|
|
31669
|
+
* @type {string}
|
|
31670
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
31671
|
+
*/
|
|
31672
|
+
health_benefit_card_verification_number_token?: string;
|
|
31673
|
+
}
|
|
31674
|
+
|
|
31562
31675
|
/**
|
|
31563
31676
|
*
|
|
31564
31677
|
* @export
|
|
@@ -32664,6 +32777,18 @@ export interface OrderSummary {
|
|
|
32664
32777
|
* @memberof OrderSummary
|
|
32665
32778
|
*/
|
|
32666
32779
|
arbitrary_shipping_handling_total?: Currency;
|
|
32780
|
+
/**
|
|
32781
|
+
*
|
|
32782
|
+
* @type {Currency}
|
|
32783
|
+
* @memberof OrderSummary
|
|
32784
|
+
*/
|
|
32785
|
+
health_benefit_card_amount?: Currency;
|
|
32786
|
+
/**
|
|
32787
|
+
*
|
|
32788
|
+
* @type {Currency}
|
|
32789
|
+
* @memberof OrderSummary
|
|
32790
|
+
*/
|
|
32791
|
+
health_benefit_card_refunded?: Currency;
|
|
32667
32792
|
/**
|
|
32668
32793
|
*
|
|
32669
32794
|
* @type {Currency}
|
|
@@ -41333,7 +41458,13 @@ export interface WorkflowTasksRequest {
|
|
|
41333
41458
|
* @type {string}
|
|
41334
41459
|
* @memberof WorkflowTasksRequest
|
|
41335
41460
|
*/
|
|
41336
|
-
|
|
41461
|
+
delay_until_dts_begin?: string;
|
|
41462
|
+
/**
|
|
41463
|
+
* Date/time that the workflow task should delay until
|
|
41464
|
+
* @type {string}
|
|
41465
|
+
* @memberof WorkflowTasksRequest
|
|
41466
|
+
*/
|
|
41467
|
+
delay_until_dts_end?: string;
|
|
41337
41468
|
/**
|
|
41338
41469
|
* Date/time that the workflow task is due
|
|
41339
41470
|
* @type {string}
|
package/dist/api.d.ts
CHANGED
|
@@ -4007,6 +4007,12 @@ export interface CartPayment {
|
|
|
4007
4007
|
* @memberof CartPayment
|
|
4008
4008
|
*/
|
|
4009
4009
|
credit_card?: CartPaymentCreditCard;
|
|
4010
|
+
/**
|
|
4011
|
+
*
|
|
4012
|
+
* @type {CartPaymentHealthBenefitCard}
|
|
4013
|
+
* @memberof CartPayment
|
|
4014
|
+
*/
|
|
4015
|
+
health_benefit_card?: CartPaymentHealthBenefitCard;
|
|
4010
4016
|
/**
|
|
4011
4017
|
* Payment method
|
|
4012
4018
|
* @type {string}
|
|
@@ -4126,6 +4132,49 @@ export interface CartPaymentCreditCard {
|
|
|
4126
4132
|
*/
|
|
4127
4133
|
store_credit_card?: boolean;
|
|
4128
4134
|
}
|
|
4135
|
+
/**
|
|
4136
|
+
*
|
|
4137
|
+
* @export
|
|
4138
|
+
* @interface CartPaymentHealthBenefitCard
|
|
4139
|
+
*/
|
|
4140
|
+
export interface CartPaymentHealthBenefitCard {
|
|
4141
|
+
/**
|
|
4142
|
+
* Health benefit expiration month (1-12)
|
|
4143
|
+
* @type {number}
|
|
4144
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4145
|
+
*/
|
|
4146
|
+
health_benefit_card_expiration_month?: number;
|
|
4147
|
+
/**
|
|
4148
|
+
* Health benefit card expiration year (four digit year)
|
|
4149
|
+
* @type {number}
|
|
4150
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4151
|
+
*/
|
|
4152
|
+
health_benefit_card_expiration_year?: number;
|
|
4153
|
+
/**
|
|
4154
|
+
* Health benefit card number (masked to the last 4)
|
|
4155
|
+
* @type {string}
|
|
4156
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4157
|
+
*/
|
|
4158
|
+
health_benefit_card_number?: string;
|
|
4159
|
+
/**
|
|
4160
|
+
* Hosted field token for the card number
|
|
4161
|
+
* @type {string}
|
|
4162
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4163
|
+
*/
|
|
4164
|
+
health_benefit_card_number_token?: string;
|
|
4165
|
+
/**
|
|
4166
|
+
* Health benefit card verification number (masked)
|
|
4167
|
+
* @type {string}
|
|
4168
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4169
|
+
*/
|
|
4170
|
+
health_benefit_card_verification_number?: string;
|
|
4171
|
+
/**
|
|
4172
|
+
* Hosted field token for the health benefit card verification number
|
|
4173
|
+
* @type {string}
|
|
4174
|
+
* @memberof CartPaymentHealthBenefitCard
|
|
4175
|
+
*/
|
|
4176
|
+
health_benefit_card_verification_number_token?: string;
|
|
4177
|
+
}
|
|
4129
4178
|
/**
|
|
4130
4179
|
*
|
|
4131
4180
|
* @export
|
|
@@ -4928,6 +4977,18 @@ export interface CartSummary {
|
|
|
4928
4977
|
* @memberof CartSummary
|
|
4929
4978
|
*/
|
|
4930
4979
|
arbitrary_taxable_subtotal?: Currency;
|
|
4980
|
+
/**
|
|
4981
|
+
*
|
|
4982
|
+
* @type {Currency}
|
|
4983
|
+
* @memberof CartSummary
|
|
4984
|
+
*/
|
|
4985
|
+
health_benefit_card_amount?: Currency;
|
|
4986
|
+
/**
|
|
4987
|
+
*
|
|
4988
|
+
* @type {Currency}
|
|
4989
|
+
* @memberof CartSummary
|
|
4990
|
+
*/
|
|
4991
|
+
internal_gift_certificate_amount?: Currency;
|
|
4931
4992
|
/**
|
|
4932
4993
|
*
|
|
4933
4994
|
* @type {Currency}
|
|
@@ -30510,6 +30571,12 @@ export interface OrderPayment {
|
|
|
30510
30571
|
* @memberof OrderPayment
|
|
30511
30572
|
*/
|
|
30512
30573
|
echeck?: OrderPaymentECheck;
|
|
30574
|
+
/**
|
|
30575
|
+
*
|
|
30576
|
+
* @type {OrderPaymentHealthBenefitCard}
|
|
30577
|
+
* @memberof OrderPayment
|
|
30578
|
+
*/
|
|
30579
|
+
health_benefit_card?: OrderPaymentHealthBenefitCard;
|
|
30513
30580
|
/**
|
|
30514
30581
|
* True if order has been held for fraud review
|
|
30515
30582
|
* @type {boolean}
|
|
@@ -30634,7 +30701,8 @@ export declare namespace OrderPayment {
|
|
|
30634
30701
|
Sezzle,
|
|
30635
30702
|
Venmo,
|
|
30636
30703
|
ApplePay,
|
|
30637
|
-
GooglePay
|
|
30704
|
+
GooglePay,
|
|
30705
|
+
HealthBenefitCard
|
|
30638
30706
|
}
|
|
30639
30707
|
/**
|
|
30640
30708
|
* @export
|
|
@@ -30894,6 +30962,49 @@ export declare namespace OrderPaymentECheck {
|
|
|
30894
30962
|
Business
|
|
30895
30963
|
}
|
|
30896
30964
|
}
|
|
30965
|
+
/**
|
|
30966
|
+
*
|
|
30967
|
+
* @export
|
|
30968
|
+
* @interface OrderPaymentHealthBenefitCard
|
|
30969
|
+
*/
|
|
30970
|
+
export interface OrderPaymentHealthBenefitCard {
|
|
30971
|
+
/**
|
|
30972
|
+
* Health benefit card expiration month (1-12)
|
|
30973
|
+
* @type {number}
|
|
30974
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
30975
|
+
*/
|
|
30976
|
+
health_benefit_card_expiration_month?: number;
|
|
30977
|
+
/**
|
|
30978
|
+
* Health benefit card expiration year (Four digit year)
|
|
30979
|
+
* @type {number}
|
|
30980
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
30981
|
+
*/
|
|
30982
|
+
health_benefit_card_expiration_year?: number;
|
|
30983
|
+
/**
|
|
30984
|
+
* Health benefit card number (masked to last 4)
|
|
30985
|
+
* @type {string}
|
|
30986
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
30987
|
+
*/
|
|
30988
|
+
health_benefit_card_number?: string;
|
|
30989
|
+
/**
|
|
30990
|
+
* Health benefit card number token from hosted fields used to update the health benefit card number
|
|
30991
|
+
* @type {string}
|
|
30992
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
30993
|
+
*/
|
|
30994
|
+
health_benefit_card_number_token?: string;
|
|
30995
|
+
/**
|
|
30996
|
+
* True if the health benefit card has been truncated
|
|
30997
|
+
* @type {boolean}
|
|
30998
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
30999
|
+
*/
|
|
31000
|
+
health_benefit_card_number_truncated?: boolean;
|
|
31001
|
+
/**
|
|
31002
|
+
* Health benefit card verification number token from hosted fields, only for import/insert of new orders, completely ignored for updates, and always null/empty for queries
|
|
31003
|
+
* @type {string}
|
|
31004
|
+
* @memberof OrderPaymentHealthBenefitCard
|
|
31005
|
+
*/
|
|
31006
|
+
health_benefit_card_verification_number_token?: string;
|
|
31007
|
+
}
|
|
30897
31008
|
/**
|
|
30898
31009
|
*
|
|
30899
31010
|
* @export
|
|
@@ -31979,6 +32090,18 @@ export interface OrderSummary {
|
|
|
31979
32090
|
* @memberof OrderSummary
|
|
31980
32091
|
*/
|
|
31981
32092
|
arbitrary_shipping_handling_total?: Currency;
|
|
32093
|
+
/**
|
|
32094
|
+
*
|
|
32095
|
+
* @type {Currency}
|
|
32096
|
+
* @memberof OrderSummary
|
|
32097
|
+
*/
|
|
32098
|
+
health_benefit_card_amount?: Currency;
|
|
32099
|
+
/**
|
|
32100
|
+
*
|
|
32101
|
+
* @type {Currency}
|
|
32102
|
+
* @memberof OrderSummary
|
|
32103
|
+
*/
|
|
32104
|
+
health_benefit_card_refunded?: Currency;
|
|
31982
32105
|
/**
|
|
31983
32106
|
*
|
|
31984
32107
|
* @type {Currency}
|
|
@@ -40455,7 +40578,13 @@ export interface WorkflowTasksRequest {
|
|
|
40455
40578
|
* @type {string}
|
|
40456
40579
|
* @memberof WorkflowTasksRequest
|
|
40457
40580
|
*/
|
|
40458
|
-
|
|
40581
|
+
delay_until_dts_begin?: string;
|
|
40582
|
+
/**
|
|
40583
|
+
* Date/time that the workflow task should delay until
|
|
40584
|
+
* @type {string}
|
|
40585
|
+
* @memberof WorkflowTasksRequest
|
|
40586
|
+
*/
|
|
40587
|
+
delay_until_dts_end?: string;
|
|
40459
40588
|
/**
|
|
40460
40589
|
* Date/time that the workflow task is due
|
|
40461
40590
|
* @type {string}
|
package/dist/api.js
CHANGED
|
@@ -1193,6 +1193,7 @@ var OrderPayment;
|
|
|
1193
1193
|
PaymentMethodEnum[PaymentMethodEnum["Venmo"] = 'Venmo'] = "Venmo";
|
|
1194
1194
|
PaymentMethodEnum[PaymentMethodEnum["ApplePay"] = 'Apple Pay'] = "ApplePay";
|
|
1195
1195
|
PaymentMethodEnum[PaymentMethodEnum["GooglePay"] = 'Google Pay'] = "GooglePay";
|
|
1196
|
+
PaymentMethodEnum[PaymentMethodEnum["HealthBenefitCard"] = 'Health Benefit Card'] = "HealthBenefitCard";
|
|
1196
1197
|
})(PaymentMethodEnum = OrderPayment.PaymentMethodEnum || (OrderPayment.PaymentMethodEnum = {}));
|
|
1197
1198
|
/**
|
|
1198
1199
|
* @export
|