@commercelayer/sdk 6.43.0 → 6.45.0
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/lib/index.d.mts +98 -45
- package/lib/index.d.ts +98 -45
- package/lib/index.js +1 -1
- package/lib/index.mjs +1 -1
- package/package.json +6 -6
package/lib/index.d.ts
CHANGED
@@ -1033,10 +1033,10 @@ interface PaymentMethod extends Resource {
|
|
1033
1033
|
*/
|
1034
1034
|
name?: string | null;
|
1035
1035
|
/**
|
1036
|
-
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', '
|
1036
|
+
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
|
1037
1037
|
* @example ```"stripe_payments"```
|
1038
1038
|
*/
|
1039
|
-
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | '
|
1039
|
+
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
|
1040
1040
|
/**
|
1041
1041
|
* The international 3-letter currency code as defined by the ISO 4217 standard.
|
1042
1042
|
* @example ```"EUR"```
|
@@ -1104,10 +1104,10 @@ interface PaymentMethodCreate extends ResourceCreate {
|
|
1104
1104
|
*/
|
1105
1105
|
name?: string | null;
|
1106
1106
|
/**
|
1107
|
-
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', '
|
1107
|
+
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
|
1108
1108
|
* @example ```"stripe_payments"```
|
1109
1109
|
*/
|
1110
|
-
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | '
|
1110
|
+
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
|
1111
1111
|
/**
|
1112
1112
|
* The international 3-letter currency code as defined by the ISO 4217 standard.
|
1113
1113
|
* @example ```"EUR"```
|
@@ -1160,10 +1160,10 @@ interface PaymentMethodUpdate extends ResourceUpdate {
|
|
1160
1160
|
*/
|
1161
1161
|
name?: string | null;
|
1162
1162
|
/**
|
1163
|
-
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', '
|
1163
|
+
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
|
1164
1164
|
* @example ```"stripe_payments"```
|
1165
1165
|
*/
|
1166
|
-
payment_source_type?: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | '
|
1166
|
+
payment_source_type?: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers' | null;
|
1167
1167
|
/**
|
1168
1168
|
* The international 3-letter currency code as defined by the ISO 4217 standard.
|
1169
1169
|
* @example ```"EUR"```
|
@@ -1547,12 +1547,7 @@ interface CheckoutComPayment extends Resource {
|
|
1547
1547
|
*/
|
1548
1548
|
public_key?: string | null;
|
1549
1549
|
/**
|
1550
|
-
* The payment
|
1551
|
-
* @example ```"token"```
|
1552
|
-
*/
|
1553
|
-
payment_type: string;
|
1554
|
-
/**
|
1555
|
-
* The Checkout.com card or digital wallet token.
|
1550
|
+
* The Checkout.com payment or digital wallet token.
|
1556
1551
|
* @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
|
1557
1552
|
*/
|
1558
1553
|
token: string;
|
@@ -1606,12 +1601,7 @@ interface CheckoutComPayment extends Resource {
|
|
1606
1601
|
}
|
1607
1602
|
interface CheckoutComPaymentCreate extends ResourceCreate {
|
1608
1603
|
/**
|
1609
|
-
* The payment
|
1610
|
-
* @example ```"token"```
|
1611
|
-
*/
|
1612
|
-
payment_type: string;
|
1613
|
-
/**
|
1614
|
-
* The Checkout.com card or digital wallet token.
|
1604
|
+
* The Checkout.com payment or digital wallet token.
|
1615
1605
|
* @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
|
1616
1606
|
*/
|
1617
1607
|
token: string;
|
@@ -1629,12 +1619,7 @@ interface CheckoutComPaymentCreate extends ResourceCreate {
|
|
1629
1619
|
}
|
1630
1620
|
interface CheckoutComPaymentUpdate extends ResourceUpdate {
|
1631
1621
|
/**
|
1632
|
-
* The payment
|
1633
|
-
* @example ```"token"```
|
1634
|
-
*/
|
1635
|
-
payment_type?: string | null;
|
1636
|
-
/**
|
1637
|
-
* The Checkout.com card or digital wallet token.
|
1622
|
+
* The Checkout.com payment or digital wallet token.
|
1638
1623
|
* @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
|
1639
1624
|
*/
|
1640
1625
|
token?: string | null;
|
@@ -4316,6 +4301,11 @@ interface ShippingMethod extends Resource {
|
|
4316
4301
|
* @example ```5```
|
4317
4302
|
*/
|
4318
4303
|
circuit_failure_count?: number | null;
|
4304
|
+
/**
|
4305
|
+
* The shared secret used to sign the external request payload.
|
4306
|
+
* @example ```"1c0994cc4e996e8c6ee56a2198f66f3c"```
|
4307
|
+
*/
|
4308
|
+
shared_secret: string;
|
4319
4309
|
market?: Market | null;
|
4320
4310
|
shipping_zone?: ShippingZone | null;
|
4321
4311
|
shipping_category?: ShippingCategory | null;
|
@@ -5992,6 +5982,11 @@ interface ExternalPromotion extends Resource {
|
|
5992
5982
|
* @example ```"pending"```
|
5993
5983
|
*/
|
5994
5984
|
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
5985
|
+
/**
|
5986
|
+
* The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
|
5987
|
+
* @example ```112```
|
5988
|
+
*/
|
5989
|
+
weight?: number | null;
|
5995
5990
|
/**
|
5996
5991
|
* Time at which this resource was disabled.
|
5997
5992
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -6268,6 +6263,11 @@ interface FixedAmountPromotion extends Resource {
|
|
6268
6263
|
* @example ```"pending"```
|
6269
6264
|
*/
|
6270
6265
|
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
6266
|
+
/**
|
6267
|
+
* The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
|
6268
|
+
* @example ```112```
|
6269
|
+
*/
|
6270
|
+
weight?: number | null;
|
6271
6271
|
/**
|
6272
6272
|
* Time at which this resource was disabled.
|
6273
6273
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -6518,16 +6518,16 @@ interface FlexPromotion extends Resource {
|
|
6518
6518
|
* @example ```{}```
|
6519
6519
|
*/
|
6520
6520
|
rules: Record<string, any>;
|
6521
|
+
/**
|
6522
|
+
* The rule outcomes.
|
6523
|
+
* @example ```[]```
|
6524
|
+
*/
|
6525
|
+
rule_outcomes?: Record<string, any> | null;
|
6521
6526
|
/**
|
6522
6527
|
* Time at which this resource was disabled.
|
6523
6528
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
6524
6529
|
*/
|
6525
6530
|
disabled_at?: string | null;
|
6526
|
-
/**
|
6527
|
-
* The rule outcomes.
|
6528
|
-
* @example ```{}```
|
6529
|
-
*/
|
6530
|
-
rule_outcomes?: Record<string, any> | null;
|
6531
6531
|
/**
|
6532
6532
|
* The payload used to evaluate the rules.
|
6533
6533
|
* @example ```{}```
|
@@ -6764,6 +6764,11 @@ interface FixedPricePromotion extends Resource {
|
|
6764
6764
|
* @example ```"pending"```
|
6765
6765
|
*/
|
6766
6766
|
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
6767
|
+
/**
|
6768
|
+
* The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
|
6769
|
+
* @example ```112```
|
6770
|
+
*/
|
6771
|
+
weight?: number | null;
|
6767
6772
|
/**
|
6768
6773
|
* Time at which this resource was disabled.
|
6769
6774
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -7096,6 +7101,11 @@ interface FreeGiftPromotion extends Resource {
|
|
7096
7101
|
* @example ```"pending"```
|
7097
7102
|
*/
|
7098
7103
|
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
7104
|
+
/**
|
7105
|
+
* The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
|
7106
|
+
* @example ```112```
|
7107
|
+
*/
|
7108
|
+
weight?: number | null;
|
7099
7109
|
/**
|
7100
7110
|
* Time at which this resource was disabled.
|
7101
7111
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -7410,6 +7420,11 @@ interface BuyXPayYPromotion extends Resource {
|
|
7410
7420
|
* @example ```"pending"```
|
7411
7421
|
*/
|
7412
7422
|
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
7423
|
+
/**
|
7424
|
+
* The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
|
7425
|
+
* @example ```112```
|
7426
|
+
*/
|
7427
|
+
weight?: number | null;
|
7413
7428
|
/**
|
7414
7429
|
* Time at which this resource was disabled.
|
7415
7430
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -7786,6 +7801,11 @@ interface FreeShippingPromotion extends Resource {
|
|
7786
7801
|
* @example ```"pending"```
|
7787
7802
|
*/
|
7788
7803
|
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
7804
|
+
/**
|
7805
|
+
* The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
|
7806
|
+
* @example ```112```
|
7807
|
+
*/
|
7808
|
+
weight?: number | null;
|
7789
7809
|
/**
|
7790
7810
|
* Time at which this resource was disabled.
|
7791
7811
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -8116,6 +8136,11 @@ interface PercentageDiscountPromotion extends Resource {
|
|
8116
8136
|
* @example ```"pending"```
|
8117
8137
|
*/
|
8118
8138
|
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
8139
|
+
/**
|
8140
|
+
* The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
|
8141
|
+
* @example ```112```
|
8142
|
+
*/
|
8143
|
+
weight?: number | null;
|
8119
8144
|
/**
|
8120
8145
|
* Time at which this resource was disabled.
|
8121
8146
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -8506,6 +8531,11 @@ interface LineItem extends Resource {
|
|
8506
8531
|
* @example ```"SUMMERDISCOUNT"```
|
8507
8532
|
*/
|
8508
8533
|
coupon_code?: string | null;
|
8534
|
+
/**
|
8535
|
+
* The rule outcomes.
|
8536
|
+
* @example ```[]```
|
8537
|
+
*/
|
8538
|
+
rule_outcomes?: Record<string, any> | null;
|
8509
8539
|
/**
|
8510
8540
|
* The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.
|
8511
8541
|
* @example ```"closed"```
|
@@ -9403,10 +9433,10 @@ interface PaymentOption extends Resource {
|
|
9403
9433
|
*/
|
9404
9434
|
name?: string | null;
|
9405
9435
|
/**
|
9406
|
-
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', '
|
9436
|
+
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
|
9407
9437
|
* @example ```"stripe_payments"```
|
9408
9438
|
*/
|
9409
|
-
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | '
|
9439
|
+
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
|
9410
9440
|
/**
|
9411
9441
|
* The payment options data to be added to the payment source payload. Check payment specific API for more details.
|
9412
9442
|
* @example ```{"application_fee_amount":1000,"on_behalf_of":"pm_xxx"}```
|
@@ -9422,10 +9452,10 @@ interface PaymentOptionCreate extends ResourceCreate {
|
|
9422
9452
|
*/
|
9423
9453
|
name?: string | null;
|
9424
9454
|
/**
|
9425
|
-
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', '
|
9455
|
+
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.
|
9426
9456
|
* @example ```"stripe_payments"```
|
9427
9457
|
*/
|
9428
|
-
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | '
|
9458
|
+
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
|
9429
9459
|
/**
|
9430
9460
|
* The payment options data to be added to the payment source payload. Check payment specific API for more details.
|
9431
9461
|
* @example ```{"application_fee_amount":1000,"on_behalf_of":"pm_xxx"}```
|
@@ -12549,6 +12579,11 @@ interface Price extends Resource {
|
|
12549
12579
|
* @example ```"€130,00"```
|
12550
12580
|
*/
|
12551
12581
|
formatted_compare_at_amount?: string | null;
|
12582
|
+
/**
|
12583
|
+
* The rule outcomes.
|
12584
|
+
* @example ```[]```
|
12585
|
+
*/
|
12586
|
+
rule_outcomes?: Record<string, any> | null;
|
12552
12587
|
/**
|
12553
12588
|
* Time at which the resource was processed by API.
|
12554
12589
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -12559,11 +12594,6 @@ interface Price extends Resource {
|
|
12559
12594
|
* @example ```{}```
|
12560
12595
|
*/
|
12561
12596
|
rules?: Record<string, any> | null;
|
12562
|
-
/**
|
12563
|
-
* The rule outcomes.
|
12564
|
-
* @example ```{}```
|
12565
|
-
*/
|
12566
|
-
rule_outcomes?: Record<string, any> | null;
|
12567
12597
|
/**
|
12568
12598
|
* The payload used to evaluate the rules.
|
12569
12599
|
* @example ```{}```
|
@@ -12812,15 +12842,15 @@ interface PriceList extends Resource {
|
|
12812
12842
|
*/
|
12813
12843
|
tax_included?: boolean | null;
|
12814
12844
|
/**
|
12815
|
-
* The
|
12816
|
-
* @example ```
|
12845
|
+
* The rule outcomes.
|
12846
|
+
* @example ```[]```
|
12817
12847
|
*/
|
12818
|
-
|
12848
|
+
rule_outcomes?: Record<string, any> | null;
|
12819
12849
|
/**
|
12820
|
-
* The
|
12850
|
+
* The rules (using Rules Engine) to be applied.
|
12821
12851
|
* @example ```{}```
|
12822
12852
|
*/
|
12823
|
-
|
12853
|
+
rules?: Record<string, any> | null;
|
12824
12854
|
/**
|
12825
12855
|
* The payload used to evaluate the rules.
|
12826
12856
|
* @example ```{}```
|
@@ -13036,6 +13066,11 @@ interface Promotion extends Resource {
|
|
13036
13066
|
* @example ```"pending"```
|
13037
13067
|
*/
|
13038
13068
|
status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
|
13069
|
+
/**
|
13070
|
+
* The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
|
13071
|
+
* @example ```112```
|
13072
|
+
*/
|
13073
|
+
weight?: number | null;
|
13039
13074
|
/**
|
13040
13075
|
* Time at which this resource was disabled.
|
13041
13076
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -16369,7 +16404,11 @@ interface Organization extends Resource {
|
|
16369
16404
|
*/
|
16370
16405
|
addresses_phone_required?: boolean | null;
|
16371
16406
|
/**
|
16372
|
-
* The minimum lapse in fraction of seconds to be observed between two consecutive
|
16407
|
+
* The minimum lapse in fraction of seconds to be observed between two consecutive shipments rebuilt. If shipments rebuilt is triggered within the minimum lapse, the update is performed, but no rebuilt is done.
|
16408
|
+
*/
|
16409
|
+
orders_min_rebuild_shipments_lapse?: number | null;
|
16410
|
+
/**
|
16411
|
+
* The minimum lapse in fraction of seconds to be observed between two consecutive order refreshes. If refresh is triggered within the minimum lapse, the update is performed, but no order refresh is done.
|
16373
16412
|
*/
|
16374
16413
|
orders_min_refresh_lapse?: number | null;
|
16375
16414
|
/**
|
@@ -16400,6 +16439,11 @@ interface Organization extends Resource {
|
|
16400
16439
|
* @example ```true```
|
16401
16440
|
*/
|
16402
16441
|
orders_invalid_coupon_errors?: boolean | null;
|
16442
|
+
/**
|
16443
|
+
* Enables raising of API errors in case the provided gift card code is invalid, default is true.
|
16444
|
+
* @example ```true```
|
16445
|
+
*/
|
16446
|
+
orders_invalid_gift_card_errors?: boolean | null;
|
16403
16447
|
/**
|
16404
16448
|
* The maximum number of SKUs allowed for bundles, default is 10.
|
16405
16449
|
* @example ```10```
|
@@ -16415,6 +16459,10 @@ interface Organization extends Resource {
|
|
16415
16459
|
* @example ```40```
|
16416
16460
|
*/
|
16417
16461
|
coupons_max_code_length?: number | null;
|
16462
|
+
/**
|
16463
|
+
* Enables matching the gift card code by its exact value, instead of by its first charachters, default is false.
|
16464
|
+
*/
|
16465
|
+
gift_cards_exact_code_matching?: boolean | null;
|
16418
16466
|
/**
|
16419
16467
|
* The minimum length for gift card code, default is 8.
|
16420
16468
|
* @example ```8```
|
@@ -16449,6 +16497,11 @@ interface Organization extends Resource {
|
|
16449
16497
|
* Disables the interruption of the import in case its errors exceeds the 10% threshold, default is false.
|
16450
16498
|
*/
|
16451
16499
|
imports_skip_errors?: boolean | null;
|
16500
|
+
/**
|
16501
|
+
* The maximum number for stock locations cutoff, default is 10.
|
16502
|
+
* @example ```10```
|
16503
|
+
*/
|
16504
|
+
inventory_models_max_stock_locations_cutoff?: number | null;
|
16452
16505
|
/**
|
16453
16506
|
* The maximum number of active concurrent promotions allowed for your organization, default is 10.
|
16454
16507
|
* @example ```10```
|
@@ -17185,7 +17238,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
17185
17238
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
17186
17239
|
declare class CommerceLayerClient {
|
17187
17240
|
#private;
|
17188
|
-
readonly openApiSchemaVersion = "7.
|
17241
|
+
readonly openApiSchemaVersion = "7.9.3";
|
17189
17242
|
constructor(config: CommerceLayerInitConfig);
|
17190
17243
|
get addresses(): Addresses;
|
17191
17244
|
get adjustments(): Adjustments;
|