@commercelayer/sdk 6.42.0 → 6.44.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 +53 -47
- package/lib/index.d.ts +53 -47
- package/lib/index.js +1 -1
- package/lib/index.mjs +1 -1
- package/package.json +4 -4
package/lib/index.d.mts
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"```
|
@@ -1266,6 +1266,11 @@ interface AdyenPayment extends Resource {
|
|
1266
1266
|
* Indicates if the order current amount differs form the one of the associated authorization.
|
1267
1267
|
*/
|
1268
1268
|
mismatched_amounts?: boolean | null;
|
1269
|
+
/**
|
1270
|
+
* The balance remaining on a shopper's gift card, must be computed by using its related trigger attribute.
|
1271
|
+
* @example ```1000```
|
1272
|
+
*/
|
1273
|
+
balance?: number | null;
|
1269
1274
|
/**
|
1270
1275
|
* Information about the payment instrument used in the transaction.
|
1271
1276
|
* @example ```{"issuer":"cl bank","card_type":"visa"}```
|
@@ -1299,6 +1304,11 @@ interface AdyenPaymentUpdate extends ResourceUpdate {
|
|
1299
1304
|
* @example ```true```
|
1300
1305
|
*/
|
1301
1306
|
_details?: boolean | null;
|
1307
|
+
/**
|
1308
|
+
* Send this attribute if you want retrieve the balance remaining on a shopper's gift card.
|
1309
|
+
* @example ```true```
|
1310
|
+
*/
|
1311
|
+
_balance?: boolean | null;
|
1302
1312
|
order?: OrderRel$k | null;
|
1303
1313
|
}
|
1304
1314
|
declare class AdyenPayments extends ApiResource<AdyenPayment> {
|
@@ -1311,6 +1321,7 @@ declare class AdyenPayments extends ApiResource<AdyenPayment> {
|
|
1311
1321
|
versions(adyenPaymentId: string | AdyenPayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
1312
1322
|
_authorize(id: string | AdyenPayment, params?: QueryParamsRetrieve<AdyenPayment>, options?: ResourcesConfig): Promise<AdyenPayment>;
|
1313
1323
|
_details(id: string | AdyenPayment, params?: QueryParamsRetrieve<AdyenPayment>, options?: ResourcesConfig): Promise<AdyenPayment>;
|
1324
|
+
_balance(id: string | AdyenPayment, params?: QueryParamsRetrieve<AdyenPayment>, options?: ResourcesConfig): Promise<AdyenPayment>;
|
1314
1325
|
isAdyenPayment(resource: any): resource is AdyenPayment;
|
1315
1326
|
relationship(id: string | ResourceId | null): AdyenPaymentRel$3;
|
1316
1327
|
relationshipToMany(...ids: string[]): AdyenPaymentRel$3[];
|
@@ -1536,12 +1547,7 @@ interface CheckoutComPayment extends Resource {
|
|
1536
1547
|
*/
|
1537
1548
|
public_key?: string | null;
|
1538
1549
|
/**
|
1539
|
-
* The payment
|
1540
|
-
* @example ```"token"```
|
1541
|
-
*/
|
1542
|
-
payment_type: string;
|
1543
|
-
/**
|
1544
|
-
* The Checkout.com card or digital wallet token.
|
1550
|
+
* The Checkout.com payment or digital wallet token.
|
1545
1551
|
* @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
|
1546
1552
|
*/
|
1547
1553
|
token: string;
|
@@ -1595,12 +1601,7 @@ interface CheckoutComPayment extends Resource {
|
|
1595
1601
|
}
|
1596
1602
|
interface CheckoutComPaymentCreate extends ResourceCreate {
|
1597
1603
|
/**
|
1598
|
-
* The payment
|
1599
|
-
* @example ```"token"```
|
1600
|
-
*/
|
1601
|
-
payment_type: string;
|
1602
|
-
/**
|
1603
|
-
* The Checkout.com card or digital wallet token.
|
1604
|
+
* The Checkout.com payment or digital wallet token.
|
1604
1605
|
* @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
|
1605
1606
|
*/
|
1606
1607
|
token: string;
|
@@ -1618,12 +1619,7 @@ interface CheckoutComPaymentCreate extends ResourceCreate {
|
|
1618
1619
|
}
|
1619
1620
|
interface CheckoutComPaymentUpdate extends ResourceUpdate {
|
1620
1621
|
/**
|
1621
|
-
* The payment
|
1622
|
-
* @example ```"token"```
|
1623
|
-
*/
|
1624
|
-
payment_type?: string | null;
|
1625
|
-
/**
|
1626
|
-
* The Checkout.com card or digital wallet token.
|
1622
|
+
* The Checkout.com payment or digital wallet token.
|
1627
1623
|
* @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
|
1628
1624
|
*/
|
1629
1625
|
token?: string | null;
|
@@ -4305,6 +4301,11 @@ interface ShippingMethod extends Resource {
|
|
4305
4301
|
* @example ```5```
|
4306
4302
|
*/
|
4307
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;
|
4308
4309
|
market?: Market | null;
|
4309
4310
|
shipping_zone?: ShippingZone | null;
|
4310
4311
|
shipping_category?: ShippingCategory | null;
|
@@ -6507,16 +6508,16 @@ interface FlexPromotion extends Resource {
|
|
6507
6508
|
* @example ```{}```
|
6508
6509
|
*/
|
6509
6510
|
rules: Record<string, any>;
|
6511
|
+
/**
|
6512
|
+
* The rule outcomes.
|
6513
|
+
* @example ```[]```
|
6514
|
+
*/
|
6515
|
+
rule_outcomes?: Record<string, any> | null;
|
6510
6516
|
/**
|
6511
6517
|
* Time at which this resource was disabled.
|
6512
6518
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
6513
6519
|
*/
|
6514
6520
|
disabled_at?: string | null;
|
6515
|
-
/**
|
6516
|
-
* The rule outcomes.
|
6517
|
-
* @example ```{}```
|
6518
|
-
*/
|
6519
|
-
rule_outcomes?: Record<string, any> | null;
|
6520
6521
|
/**
|
6521
6522
|
* The payload used to evaluate the rules.
|
6522
6523
|
* @example ```{}```
|
@@ -8495,6 +8496,11 @@ interface LineItem extends Resource {
|
|
8495
8496
|
* @example ```"SUMMERDISCOUNT"```
|
8496
8497
|
*/
|
8497
8498
|
coupon_code?: string | null;
|
8499
|
+
/**
|
8500
|
+
* The rule outcomes.
|
8501
|
+
* @example ```[]```
|
8502
|
+
*/
|
8503
|
+
rule_outcomes?: Record<string, any> | null;
|
8498
8504
|
/**
|
8499
8505
|
* 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.
|
8500
8506
|
* @example ```"closed"```
|
@@ -9335,12 +9341,12 @@ interface CustomerUpdate extends ResourceUpdate {
|
|
9335
9341
|
*/
|
9336
9342
|
_remove_tags?: string | null;
|
9337
9343
|
/**
|
9338
|
-
* Send this attribute if you want to trigger anonymization.
|
9344
|
+
* Send this attribute if you want to trigger anonymization. Cannot be passed by sales channels.
|
9339
9345
|
* @example ```true```
|
9340
9346
|
*/
|
9341
9347
|
_request_anonymization?: boolean | null;
|
9342
9348
|
/**
|
9343
|
-
* Send this attribute if you want to trigger a cancellation of anonymization.
|
9349
|
+
* Send this attribute if you want to trigger a cancellation of anonymization. Cannot be passed by sales channels.
|
9344
9350
|
* @example ```true```
|
9345
9351
|
*/
|
9346
9352
|
_cancel_anonymization?: boolean | null;
|
@@ -9392,10 +9398,10 @@ interface PaymentOption extends Resource {
|
|
9392
9398
|
*/
|
9393
9399
|
name?: string | null;
|
9394
9400
|
/**
|
9395
|
-
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', '
|
9401
|
+
* 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'.
|
9396
9402
|
* @example ```"stripe_payments"```
|
9397
9403
|
*/
|
9398
|
-
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | '
|
9404
|
+
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
|
9399
9405
|
/**
|
9400
9406
|
* The payment options data to be added to the payment source payload. Check payment specific API for more details.
|
9401
9407
|
* @example ```{"application_fee_amount":1000,"on_behalf_of":"pm_xxx"}```
|
@@ -9411,10 +9417,10 @@ interface PaymentOptionCreate extends ResourceCreate {
|
|
9411
9417
|
*/
|
9412
9418
|
name?: string | null;
|
9413
9419
|
/**
|
9414
|
-
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', '
|
9420
|
+
* 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'.
|
9415
9421
|
* @example ```"stripe_payments"```
|
9416
9422
|
*/
|
9417
|
-
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | '
|
9423
|
+
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
|
9418
9424
|
/**
|
9419
9425
|
* The payment options data to be added to the payment source payload. Check payment specific API for more details.
|
9420
9426
|
* @example ```{"application_fee_amount":1000,"on_behalf_of":"pm_xxx"}```
|
@@ -12538,6 +12544,11 @@ interface Price extends Resource {
|
|
12538
12544
|
* @example ```"€130,00"```
|
12539
12545
|
*/
|
12540
12546
|
formatted_compare_at_amount?: string | null;
|
12547
|
+
/**
|
12548
|
+
* The rule outcomes.
|
12549
|
+
* @example ```[]```
|
12550
|
+
*/
|
12551
|
+
rule_outcomes?: Record<string, any> | null;
|
12541
12552
|
/**
|
12542
12553
|
* Time at which the resource was processed by API.
|
12543
12554
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -12548,11 +12559,6 @@ interface Price extends Resource {
|
|
12548
12559
|
* @example ```{}```
|
12549
12560
|
*/
|
12550
12561
|
rules?: Record<string, any> | null;
|
12551
|
-
/**
|
12552
|
-
* The rule outcomes.
|
12553
|
-
* @example ```{}```
|
12554
|
-
*/
|
12555
|
-
rule_outcomes?: Record<string, any> | null;
|
12556
12562
|
/**
|
12557
12563
|
* The payload used to evaluate the rules.
|
12558
12564
|
* @example ```{}```
|
@@ -12801,15 +12807,15 @@ interface PriceList extends Resource {
|
|
12801
12807
|
*/
|
12802
12808
|
tax_included?: boolean | null;
|
12803
12809
|
/**
|
12804
|
-
* The
|
12805
|
-
* @example ```
|
12810
|
+
* The rule outcomes.
|
12811
|
+
* @example ```[]```
|
12806
12812
|
*/
|
12807
|
-
|
12813
|
+
rule_outcomes?: Record<string, any> | null;
|
12808
12814
|
/**
|
12809
|
-
* The
|
12815
|
+
* The rules (using Rules Engine) to be applied.
|
12810
12816
|
* @example ```{}```
|
12811
12817
|
*/
|
12812
|
-
|
12818
|
+
rules?: Record<string, any> | null;
|
12813
12819
|
/**
|
12814
12820
|
* The payload used to evaluate the rules.
|
12815
12821
|
* @example ```{}```
|
@@ -14947,7 +14953,7 @@ interface Application extends Resource {
|
|
14947
14953
|
* The application's kind. One of 'sales_channel', 'integration', or 'webapp'.
|
14948
14954
|
* @example ```"sales-channel"```
|
14949
14955
|
*/
|
14950
|
-
kind?: 'dashboard' | 'user' | 'metrics' | 'contentful' | 'bundles' | 'customers' | 'datocms' | 'exports' | 'external' | 'gift_cards' | 'imports' | 'integration' | 'inventory' | 'orders' | 'price_lists' | 'promotions' | 'resources' | 'returns' | 'sales_channel' | 'sanity' | 'shipments' | 'skus' | 'sku_lists' | 'stock_transfers' | 'subscriptions' | 'tags' | 'webapp' | 'webhooks' | 'zapier' | null;
|
14956
|
+
kind?: 'dashboard' | 'user' | 'metrics' | 'contentful' | 'bundles' | 'customers' | 'datocms' | 'exports' | 'external' | 'generic' | 'gift_cards' | 'imports' | 'integration' | 'inventory' | 'orders' | 'price_lists' | 'promotions' | 'resources' | 'returns' | 'sales_channel' | 'sanity' | 'shipments' | 'skus' | 'sku_lists' | 'stock_transfers' | 'subscriptions' | 'tags' | 'webapp' | 'webhooks' | 'zapier' | null;
|
14951
14957
|
/**
|
14952
14958
|
* Indicates if the application has public access.
|
14953
14959
|
* @example ```true```
|
@@ -17174,7 +17180,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
17174
17180
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
17175
17181
|
declare class CommerceLayerClient {
|
17176
17182
|
#private;
|
17177
|
-
readonly openApiSchemaVersion = "7.
|
17183
|
+
readonly openApiSchemaVersion = "7.9.0";
|
17178
17184
|
constructor(config: CommerceLayerInitConfig);
|
17179
17185
|
get addresses(): Addresses;
|
17180
17186
|
get adjustments(): Adjustments;
|
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"```
|
@@ -1266,6 +1266,11 @@ interface AdyenPayment extends Resource {
|
|
1266
1266
|
* Indicates if the order current amount differs form the one of the associated authorization.
|
1267
1267
|
*/
|
1268
1268
|
mismatched_amounts?: boolean | null;
|
1269
|
+
/**
|
1270
|
+
* The balance remaining on a shopper's gift card, must be computed by using its related trigger attribute.
|
1271
|
+
* @example ```1000```
|
1272
|
+
*/
|
1273
|
+
balance?: number | null;
|
1269
1274
|
/**
|
1270
1275
|
* Information about the payment instrument used in the transaction.
|
1271
1276
|
* @example ```{"issuer":"cl bank","card_type":"visa"}```
|
@@ -1299,6 +1304,11 @@ interface AdyenPaymentUpdate extends ResourceUpdate {
|
|
1299
1304
|
* @example ```true```
|
1300
1305
|
*/
|
1301
1306
|
_details?: boolean | null;
|
1307
|
+
/**
|
1308
|
+
* Send this attribute if you want retrieve the balance remaining on a shopper's gift card.
|
1309
|
+
* @example ```true```
|
1310
|
+
*/
|
1311
|
+
_balance?: boolean | null;
|
1302
1312
|
order?: OrderRel$k | null;
|
1303
1313
|
}
|
1304
1314
|
declare class AdyenPayments extends ApiResource<AdyenPayment> {
|
@@ -1311,6 +1321,7 @@ declare class AdyenPayments extends ApiResource<AdyenPayment> {
|
|
1311
1321
|
versions(adyenPaymentId: string | AdyenPayment, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
1312
1322
|
_authorize(id: string | AdyenPayment, params?: QueryParamsRetrieve<AdyenPayment>, options?: ResourcesConfig): Promise<AdyenPayment>;
|
1313
1323
|
_details(id: string | AdyenPayment, params?: QueryParamsRetrieve<AdyenPayment>, options?: ResourcesConfig): Promise<AdyenPayment>;
|
1324
|
+
_balance(id: string | AdyenPayment, params?: QueryParamsRetrieve<AdyenPayment>, options?: ResourcesConfig): Promise<AdyenPayment>;
|
1314
1325
|
isAdyenPayment(resource: any): resource is AdyenPayment;
|
1315
1326
|
relationship(id: string | ResourceId | null): AdyenPaymentRel$3;
|
1316
1327
|
relationshipToMany(...ids: string[]): AdyenPaymentRel$3[];
|
@@ -1536,12 +1547,7 @@ interface CheckoutComPayment extends Resource {
|
|
1536
1547
|
*/
|
1537
1548
|
public_key?: string | null;
|
1538
1549
|
/**
|
1539
|
-
* The payment
|
1540
|
-
* @example ```"token"```
|
1541
|
-
*/
|
1542
|
-
payment_type: string;
|
1543
|
-
/**
|
1544
|
-
* The Checkout.com card or digital wallet token.
|
1550
|
+
* The Checkout.com payment or digital wallet token.
|
1545
1551
|
* @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
|
1546
1552
|
*/
|
1547
1553
|
token: string;
|
@@ -1595,12 +1601,7 @@ interface CheckoutComPayment extends Resource {
|
|
1595
1601
|
}
|
1596
1602
|
interface CheckoutComPaymentCreate extends ResourceCreate {
|
1597
1603
|
/**
|
1598
|
-
* The payment
|
1599
|
-
* @example ```"token"```
|
1600
|
-
*/
|
1601
|
-
payment_type: string;
|
1602
|
-
/**
|
1603
|
-
* The Checkout.com card or digital wallet token.
|
1604
|
+
* The Checkout.com payment or digital wallet token.
|
1604
1605
|
* @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
|
1605
1606
|
*/
|
1606
1607
|
token: string;
|
@@ -1618,12 +1619,7 @@ interface CheckoutComPaymentCreate extends ResourceCreate {
|
|
1618
1619
|
}
|
1619
1620
|
interface CheckoutComPaymentUpdate extends ResourceUpdate {
|
1620
1621
|
/**
|
1621
|
-
* The payment
|
1622
|
-
* @example ```"token"```
|
1623
|
-
*/
|
1624
|
-
payment_type?: string | null;
|
1625
|
-
/**
|
1626
|
-
* The Checkout.com card or digital wallet token.
|
1622
|
+
* The Checkout.com payment or digital wallet token.
|
1627
1623
|
* @example ```"tok_4gzeau5o2uqubbk6fufs3m7p54"```
|
1628
1624
|
*/
|
1629
1625
|
token?: string | null;
|
@@ -4305,6 +4301,11 @@ interface ShippingMethod extends Resource {
|
|
4305
4301
|
* @example ```5```
|
4306
4302
|
*/
|
4307
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;
|
4308
4309
|
market?: Market | null;
|
4309
4310
|
shipping_zone?: ShippingZone | null;
|
4310
4311
|
shipping_category?: ShippingCategory | null;
|
@@ -6507,16 +6508,16 @@ interface FlexPromotion extends Resource {
|
|
6507
6508
|
* @example ```{}```
|
6508
6509
|
*/
|
6509
6510
|
rules: Record<string, any>;
|
6511
|
+
/**
|
6512
|
+
* The rule outcomes.
|
6513
|
+
* @example ```[]```
|
6514
|
+
*/
|
6515
|
+
rule_outcomes?: Record<string, any> | null;
|
6510
6516
|
/**
|
6511
6517
|
* Time at which this resource was disabled.
|
6512
6518
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
6513
6519
|
*/
|
6514
6520
|
disabled_at?: string | null;
|
6515
|
-
/**
|
6516
|
-
* The rule outcomes.
|
6517
|
-
* @example ```{}```
|
6518
|
-
*/
|
6519
|
-
rule_outcomes?: Record<string, any> | null;
|
6520
6521
|
/**
|
6521
6522
|
* The payload used to evaluate the rules.
|
6522
6523
|
* @example ```{}```
|
@@ -8495,6 +8496,11 @@ interface LineItem extends Resource {
|
|
8495
8496
|
* @example ```"SUMMERDISCOUNT"```
|
8496
8497
|
*/
|
8497
8498
|
coupon_code?: string | null;
|
8499
|
+
/**
|
8500
|
+
* The rule outcomes.
|
8501
|
+
* @example ```[]```
|
8502
|
+
*/
|
8503
|
+
rule_outcomes?: Record<string, any> | null;
|
8498
8504
|
/**
|
8499
8505
|
* 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.
|
8500
8506
|
* @example ```"closed"```
|
@@ -9335,12 +9341,12 @@ interface CustomerUpdate extends ResourceUpdate {
|
|
9335
9341
|
*/
|
9336
9342
|
_remove_tags?: string | null;
|
9337
9343
|
/**
|
9338
|
-
* Send this attribute if you want to trigger anonymization.
|
9344
|
+
* Send this attribute if you want to trigger anonymization. Cannot be passed by sales channels.
|
9339
9345
|
* @example ```true```
|
9340
9346
|
*/
|
9341
9347
|
_request_anonymization?: boolean | null;
|
9342
9348
|
/**
|
9343
|
-
* Send this attribute if you want to trigger a cancellation of anonymization.
|
9349
|
+
* Send this attribute if you want to trigger a cancellation of anonymization. Cannot be passed by sales channels.
|
9344
9350
|
* @example ```true```
|
9345
9351
|
*/
|
9346
9352
|
_cancel_anonymization?: boolean | null;
|
@@ -9392,10 +9398,10 @@ interface PaymentOption extends Resource {
|
|
9392
9398
|
*/
|
9393
9399
|
name?: string | null;
|
9394
9400
|
/**
|
9395
|
-
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', '
|
9401
|
+
* 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'.
|
9396
9402
|
* @example ```"stripe_payments"```
|
9397
9403
|
*/
|
9398
|
-
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | '
|
9404
|
+
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
|
9399
9405
|
/**
|
9400
9406
|
* The payment options data to be added to the payment source payload. Check payment specific API for more details.
|
9401
9407
|
* @example ```{"application_fee_amount":1000,"on_behalf_of":"pm_xxx"}```
|
@@ -9411,10 +9417,10 @@ interface PaymentOptionCreate extends ResourceCreate {
|
|
9411
9417
|
*/
|
9412
9418
|
name?: string | null;
|
9413
9419
|
/**
|
9414
|
-
* The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', '
|
9420
|
+
* 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'.
|
9415
9421
|
* @example ```"stripe_payments"```
|
9416
9422
|
*/
|
9417
|
-
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | '
|
9423
|
+
payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
|
9418
9424
|
/**
|
9419
9425
|
* The payment options data to be added to the payment source payload. Check payment specific API for more details.
|
9420
9426
|
* @example ```{"application_fee_amount":1000,"on_behalf_of":"pm_xxx"}```
|
@@ -12538,6 +12544,11 @@ interface Price extends Resource {
|
|
12538
12544
|
* @example ```"€130,00"```
|
12539
12545
|
*/
|
12540
12546
|
formatted_compare_at_amount?: string | null;
|
12547
|
+
/**
|
12548
|
+
* The rule outcomes.
|
12549
|
+
* @example ```[]```
|
12550
|
+
*/
|
12551
|
+
rule_outcomes?: Record<string, any> | null;
|
12541
12552
|
/**
|
12542
12553
|
* Time at which the resource was processed by API.
|
12543
12554
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
@@ -12548,11 +12559,6 @@ interface Price extends Resource {
|
|
12548
12559
|
* @example ```{}```
|
12549
12560
|
*/
|
12550
12561
|
rules?: Record<string, any> | null;
|
12551
|
-
/**
|
12552
|
-
* The rule outcomes.
|
12553
|
-
* @example ```{}```
|
12554
|
-
*/
|
12555
|
-
rule_outcomes?: Record<string, any> | null;
|
12556
12562
|
/**
|
12557
12563
|
* The payload used to evaluate the rules.
|
12558
12564
|
* @example ```{}```
|
@@ -12801,15 +12807,15 @@ interface PriceList extends Resource {
|
|
12801
12807
|
*/
|
12802
12808
|
tax_included?: boolean | null;
|
12803
12809
|
/**
|
12804
|
-
* The
|
12805
|
-
* @example ```
|
12810
|
+
* The rule outcomes.
|
12811
|
+
* @example ```[]```
|
12806
12812
|
*/
|
12807
|
-
|
12813
|
+
rule_outcomes?: Record<string, any> | null;
|
12808
12814
|
/**
|
12809
|
-
* The
|
12815
|
+
* The rules (using Rules Engine) to be applied.
|
12810
12816
|
* @example ```{}```
|
12811
12817
|
*/
|
12812
|
-
|
12818
|
+
rules?: Record<string, any> | null;
|
12813
12819
|
/**
|
12814
12820
|
* The payload used to evaluate the rules.
|
12815
12821
|
* @example ```{}```
|
@@ -14947,7 +14953,7 @@ interface Application extends Resource {
|
|
14947
14953
|
* The application's kind. One of 'sales_channel', 'integration', or 'webapp'.
|
14948
14954
|
* @example ```"sales-channel"```
|
14949
14955
|
*/
|
14950
|
-
kind?: 'dashboard' | 'user' | 'metrics' | 'contentful' | 'bundles' | 'customers' | 'datocms' | 'exports' | 'external' | 'gift_cards' | 'imports' | 'integration' | 'inventory' | 'orders' | 'price_lists' | 'promotions' | 'resources' | 'returns' | 'sales_channel' | 'sanity' | 'shipments' | 'skus' | 'sku_lists' | 'stock_transfers' | 'subscriptions' | 'tags' | 'webapp' | 'webhooks' | 'zapier' | null;
|
14956
|
+
kind?: 'dashboard' | 'user' | 'metrics' | 'contentful' | 'bundles' | 'customers' | 'datocms' | 'exports' | 'external' | 'generic' | 'gift_cards' | 'imports' | 'integration' | 'inventory' | 'orders' | 'price_lists' | 'promotions' | 'resources' | 'returns' | 'sales_channel' | 'sanity' | 'shipments' | 'skus' | 'sku_lists' | 'stock_transfers' | 'subscriptions' | 'tags' | 'webapp' | 'webhooks' | 'zapier' | null;
|
14951
14957
|
/**
|
14952
14958
|
* Indicates if the application has public access.
|
14953
14959
|
* @example ```true```
|
@@ -17174,7 +17180,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
17174
17180
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
17175
17181
|
declare class CommerceLayerClient {
|
17176
17182
|
#private;
|
17177
|
-
readonly openApiSchemaVersion = "7.
|
17183
|
+
readonly openApiSchemaVersion = "7.9.0";
|
17178
17184
|
constructor(config: CommerceLayerInitConfig);
|
17179
17185
|
get addresses(): Addresses;
|
17180
17186
|
get adjustments(): Adjustments;
|