@commercelayer/sdk 6.37.0 → 6.39.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 +54 -10
- package/lib/index.d.ts +54 -10
- package/lib/index.js +1 -1
- package/lib/index.mjs +1 -1
- package/package.json +4 -4
package/lib/index.d.mts
CHANGED
@@ -1094,7 +1094,6 @@ interface PaymentMethod extends Resource {
|
|
1094
1094
|
market?: Market | null;
|
1095
1095
|
payment_gateway?: PaymentGateway | null;
|
1096
1096
|
store?: Store | null;
|
1097
|
-
orders?: Order[] | null;
|
1098
1097
|
attachments?: Attachment[] | null;
|
1099
1098
|
versions?: Version[] | null;
|
1100
1099
|
}
|
@@ -1218,7 +1217,6 @@ declare class PaymentMethods extends ApiResource<PaymentMethod> {
|
|
1218
1217
|
market(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<Market>, options?: ResourcesConfig): Promise<Market>;
|
1219
1218
|
payment_gateway(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
1220
1219
|
store(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<Store>, options?: ResourcesConfig): Promise<Store>;
|
1221
|
-
orders(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Order>, options?: ResourcesConfig): Promise<ListResponse<Order>>;
|
1222
1220
|
attachments(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
1223
1221
|
versions(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
1224
1222
|
_disable(id: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
|
@@ -2030,6 +2028,11 @@ interface StripePayment extends Resource {
|
|
2030
2028
|
* @example ```"pi_1234XXX_secret_5678YYY"```
|
2031
2029
|
*/
|
2032
2030
|
client_secret?: string | null;
|
2031
|
+
/**
|
2032
|
+
* The account (if any) for which the funds of the PaymentIntent are intended.
|
2033
|
+
* @example ```"acct_xxxx-yyyy-zzzz"```
|
2034
|
+
*/
|
2035
|
+
connected_account?: string | null;
|
2033
2036
|
/**
|
2034
2037
|
* The Stripe charge ID. Identifies money movement upon the payment intent confirmation.
|
2035
2038
|
* @example ```"ch_1234XXX"```
|
@@ -5649,7 +5652,7 @@ declare class Adjustments extends ApiResource<Adjustment> {
|
|
5649
5652
|
}
|
5650
5653
|
|
5651
5654
|
type DiscountEngineType = 'discount_engines';
|
5652
|
-
type DiscountEngineRel$
|
5655
|
+
type DiscountEngineRel$2 = ResourceRel & {
|
5653
5656
|
type: DiscountEngineType;
|
5654
5657
|
};
|
5655
5658
|
type DiscountEngineSort = Pick<DiscountEngine, 'id' | 'name'> & ResourceSort;
|
@@ -5676,8 +5679,8 @@ declare class DiscountEngines extends ApiResource<DiscountEngine> {
|
|
5676
5679
|
attachments(discountEngineId: string | DiscountEngine, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
5677
5680
|
versions(discountEngineId: string | DiscountEngine, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
5678
5681
|
isDiscountEngine(resource: any): resource is DiscountEngine;
|
5679
|
-
relationship(id: string | ResourceId | null): DiscountEngineRel$
|
5680
|
-
relationshipToMany(...ids: string[]): DiscountEngineRel$
|
5682
|
+
relationship(id: string | ResourceId | null): DiscountEngineRel$2;
|
5683
|
+
relationshipToMany(...ids: string[]): DiscountEngineRel$2[];
|
5681
5684
|
type(): DiscountEngineType;
|
5682
5685
|
}
|
5683
5686
|
|
@@ -9258,6 +9261,16 @@ interface Customer extends Resource {
|
|
9258
9261
|
* @example ```"xxx-yyy-zzz"```
|
9259
9262
|
*/
|
9260
9263
|
tax_exemption_code?: string | null;
|
9264
|
+
/**
|
9265
|
+
* The custom_claim attached to the current JWT (if any).
|
9266
|
+
* @example ```{}```
|
9267
|
+
*/
|
9268
|
+
jwt_custom_claim?: Record<string, any> | null;
|
9269
|
+
/**
|
9270
|
+
* The anonymization info object.
|
9271
|
+
* @example ```{"status":"requested","requested_at":"2025-03-15 11:39:21 UTC","requester":{"id":"fdgt56hh","first_name":"Travis","last_name":"Muller","email":"test@labadie.test"}}```
|
9272
|
+
*/
|
9273
|
+
anonymization_info?: Record<string, any> | null;
|
9261
9274
|
customer_group?: CustomerGroup | null;
|
9262
9275
|
customer_addresses?: CustomerAddress[] | null;
|
9263
9276
|
customer_payment_sources?: CustomerPaymentSource[] | null;
|
@@ -9269,6 +9282,9 @@ interface Customer extends Resource {
|
|
9269
9282
|
attachments?: Attachment[] | null;
|
9270
9283
|
events?: Event[] | null;
|
9271
9284
|
tags?: Tag[] | null;
|
9285
|
+
jwt_customer?: Customer | null;
|
9286
|
+
jwt_markets?: Market[] | null;
|
9287
|
+
jwt_stock_locations?: StockLocation[] | null;
|
9272
9288
|
}
|
9273
9289
|
interface CustomerCreate extends ResourceCreate {
|
9274
9290
|
/**
|
@@ -9333,6 +9349,16 @@ interface CustomerUpdate extends ResourceUpdate {
|
|
9333
9349
|
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
9334
9350
|
*/
|
9335
9351
|
_remove_tags?: string | null;
|
9352
|
+
/**
|
9353
|
+
* Send this attribute if you want to trigger anonymization.
|
9354
|
+
* @example ```true```
|
9355
|
+
*/
|
9356
|
+
_request_anonymization?: boolean | null;
|
9357
|
+
/**
|
9358
|
+
* Send this attribute if you want to trigger a cancellation of anonymization.
|
9359
|
+
* @example ```true```
|
9360
|
+
*/
|
9361
|
+
_cancel_anonymization?: boolean | null;
|
9336
9362
|
customer_group?: CustomerGroupRel$2 | null;
|
9337
9363
|
tags?: TagRel$4[] | null;
|
9338
9364
|
}
|
@@ -9352,8 +9378,13 @@ declare class Customers extends ApiResource<Customer> {
|
|
9352
9378
|
attachments(customerId: string | Customer, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
9353
9379
|
events(customerId: string | Customer, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
9354
9380
|
tags(customerId: string | Customer, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
9381
|
+
jwt_customer(customerId: string | Customer, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9382
|
+
jwt_markets(customerId: string | Customer, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
9383
|
+
jwt_stock_locations(customerId: string | Customer, params?: QueryParamsList<StockLocation>, options?: ResourcesConfig): Promise<ListResponse<StockLocation>>;
|
9355
9384
|
_add_tags(id: string | Customer, triggerValue: string, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9356
9385
|
_remove_tags(id: string | Customer, triggerValue: string, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9386
|
+
_request_anonymization(id: string | Customer, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9387
|
+
_cancel_anonymization(id: string | Customer, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9357
9388
|
isCustomer(resource: any): resource is Customer;
|
9358
9389
|
relationship(id: string | ResourceId | null): CustomerRel$3;
|
9359
9390
|
relationshipToMany(...ids: string[]): CustomerRel$3[];
|
@@ -10118,7 +10149,7 @@ interface Order extends Resource {
|
|
10118
10149
|
*/
|
10119
10150
|
fulfillment_updated_at?: string | null;
|
10120
10151
|
/**
|
10121
|
-
* Last time at which
|
10152
|
+
* Last time at which the order was refreshed.
|
10122
10153
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
10123
10154
|
*/
|
10124
10155
|
refreshed_at?: string | null;
|
@@ -10155,6 +10186,7 @@ interface Order extends Resource {
|
|
10155
10186
|
available_free_bundles?: Bundle[] | null;
|
10156
10187
|
payment_method?: PaymentMethod | null;
|
10157
10188
|
payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
|
10189
|
+
discount_engine_item?: DiscountEngineItem | null;
|
10158
10190
|
line_items?: LineItem[] | null;
|
10159
10191
|
line_item_options?: LineItemOption[] | null;
|
10160
10192
|
stock_reservations?: StockReservation[] | null;
|
@@ -10568,6 +10600,7 @@ declare class Orders extends ApiResource<Order> {
|
|
10568
10600
|
available_free_skus(orderId: string | Order, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
10569
10601
|
available_free_bundles(orderId: string | Order, params?: QueryParamsList<Bundle>, options?: ResourcesConfig): Promise<ListResponse<Bundle>>;
|
10570
10602
|
payment_method(orderId: string | Order, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
|
10603
|
+
discount_engine_item(orderId: string | Order, params?: QueryParamsRetrieve<DiscountEngineItem>, options?: ResourcesConfig): Promise<DiscountEngineItem>;
|
10571
10604
|
line_items(orderId: string | Order, params?: QueryParamsList<LineItem>, options?: ResourcesConfig): Promise<ListResponse<LineItem>>;
|
10572
10605
|
line_item_options(orderId: string | Order, params?: QueryParamsList<LineItemOption>, options?: ResourcesConfig): Promise<ListResponse<LineItemOption>>;
|
10573
10606
|
stock_reservations(orderId: string | Order, params?: QueryParamsList<StockReservation>, options?: ResourcesConfig): Promise<ListResponse<StockReservation>>;
|
@@ -13958,7 +13991,7 @@ type DeliveryLeadTimeRel = ResourceRel & {
|
|
13958
13991
|
type ShippingMethodRel$1 = ResourceRel & {
|
13959
13992
|
type: ShippingMethodType;
|
13960
13993
|
};
|
13961
|
-
type DiscountEngineRel = ResourceRel & {
|
13994
|
+
type DiscountEngineRel$1 = ResourceRel & {
|
13962
13995
|
type: DiscountEngineType;
|
13963
13996
|
};
|
13964
13997
|
type ShipmentRel$1 = ResourceRel & {
|
@@ -14042,7 +14075,7 @@ interface AttachmentCreate extends ResourceCreate {
|
|
14042
14075
|
* @example ```"https://s3.yourdomain.com/attachment.pdf"```
|
14043
14076
|
*/
|
14044
14077
|
url?: string | null;
|
14045
|
-
attachable: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | DiscountEngineRel | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel;
|
14078
|
+
attachable: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | DiscountEngineRel$1 | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel;
|
14046
14079
|
}
|
14047
14080
|
interface AttachmentUpdate extends ResourceUpdate {
|
14048
14081
|
/**
|
@@ -14060,7 +14093,7 @@ interface AttachmentUpdate extends ResourceUpdate {
|
|
14060
14093
|
* @example ```"https://s3.yourdomain.com/attachment.pdf"```
|
14061
14094
|
*/
|
14062
14095
|
url?: string | null;
|
14063
|
-
attachable?: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | DiscountEngineRel | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel | null;
|
14096
|
+
attachable?: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | DiscountEngineRel$1 | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel | null;
|
14064
14097
|
}
|
14065
14098
|
declare class Attachments extends ApiResource<Attachment> {
|
14066
14099
|
static readonly TYPE: AttachmentType;
|
@@ -14138,6 +14171,9 @@ type InventoryModelRel = ResourceRel & {
|
|
14138
14171
|
type SubscriptionModelRel = ResourceRel & {
|
14139
14172
|
type: SubscriptionModelType;
|
14140
14173
|
};
|
14174
|
+
type DiscountEngineRel = ResourceRel & {
|
14175
|
+
type: DiscountEngineType;
|
14176
|
+
};
|
14141
14177
|
type AvalaraAccountRel = ResourceRel & {
|
14142
14178
|
type: AvalaraAccountType;
|
14143
14179
|
};
|
@@ -14231,6 +14267,7 @@ interface Market extends Resource {
|
|
14231
14267
|
base_price_list?: PriceList | null;
|
14232
14268
|
inventory_model?: InventoryModel | null;
|
14233
14269
|
subscription_model?: SubscriptionModel | null;
|
14270
|
+
discount_engine?: DiscountEngine | null;
|
14234
14271
|
tax_calculator?: AvalaraAccount | StripeTaxAccount | VertexAccount | TaxjarAccount | ManualTaxCalculator | ExternalTaxCalculator | null;
|
14235
14272
|
customer_group?: CustomerGroup | null;
|
14236
14273
|
geocoder?: Geocoder | null;
|
@@ -14291,6 +14328,7 @@ interface MarketCreate extends ResourceCreate {
|
|
14291
14328
|
price_list: PriceListRel;
|
14292
14329
|
inventory_model: InventoryModelRel;
|
14293
14330
|
subscription_model?: SubscriptionModelRel | null;
|
14331
|
+
discount_engine?: DiscountEngineRel | null;
|
14294
14332
|
tax_calculator?: AvalaraAccountRel | StripeTaxAccountRel | VertexAccountRel | TaxjarAccountRel | ManualTaxCalculatorRel | ExternalTaxCalculatorRel | null;
|
14295
14333
|
customer_group?: CustomerGroupRel | null;
|
14296
14334
|
geocoder?: GeocoderRel$2 | null;
|
@@ -14347,6 +14385,7 @@ interface MarketUpdate extends ResourceUpdate {
|
|
14347
14385
|
price_list?: PriceListRel | null;
|
14348
14386
|
inventory_model?: InventoryModelRel | null;
|
14349
14387
|
subscription_model?: SubscriptionModelRel | null;
|
14388
|
+
discount_engine?: DiscountEngineRel | null;
|
14350
14389
|
tax_calculator?: AvalaraAccountRel | StripeTaxAccountRel | VertexAccountRel | TaxjarAccountRel | ManualTaxCalculatorRel | ExternalTaxCalculatorRel | null;
|
14351
14390
|
customer_group?: CustomerGroupRel | null;
|
14352
14391
|
geocoder?: GeocoderRel$2 | null;
|
@@ -14363,6 +14402,7 @@ declare class Markets extends ApiResource<Market> {
|
|
14363
14402
|
base_price_list(marketId: string | Market, params?: QueryParamsRetrieve<PriceList>, options?: ResourcesConfig): Promise<PriceList>;
|
14364
14403
|
inventory_model(marketId: string | Market, params?: QueryParamsRetrieve<InventoryModel>, options?: ResourcesConfig): Promise<InventoryModel>;
|
14365
14404
|
subscription_model(marketId: string | Market, params?: QueryParamsRetrieve<SubscriptionModel>, options?: ResourcesConfig): Promise<SubscriptionModel>;
|
14405
|
+
discount_engine(marketId: string | Market, params?: QueryParamsRetrieve<DiscountEngine>, options?: ResourcesConfig): Promise<DiscountEngine>;
|
14366
14406
|
tax_calculator(marketId: string | Market, params?: QueryParamsRetrieve<TaxCalculator>, options?: ResourcesConfig): Promise<TaxCalculator>;
|
14367
14407
|
customer_group(marketId: string | Market, params?: QueryParamsRetrieve<CustomerGroup>, options?: ResourcesConfig): Promise<CustomerGroup>;
|
14368
14408
|
geocoder(marketId: string | Market, params?: QueryParamsRetrieve<Geocoder>, options?: ResourcesConfig): Promise<Geocoder>;
|
@@ -16332,6 +16372,10 @@ interface Organization extends Resource {
|
|
16332
16372
|
* @example ```true```
|
16333
16373
|
*/
|
16334
16374
|
addresses_phone_required?: boolean | null;
|
16375
|
+
/**
|
16376
|
+
* 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, until the lapse is observed.
|
16377
|
+
*/
|
16378
|
+
orders_min_refresh_lapse?: number | null;
|
16335
16379
|
/**
|
16336
16380
|
* The maximum number line items allowed for a test order before disabling the autorefresh option.
|
16337
16381
|
* @example ```50```
|
@@ -17137,7 +17181,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
17137
17181
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
17138
17182
|
declare class CommerceLayerClient {
|
17139
17183
|
#private;
|
17140
|
-
readonly openApiSchemaVersion = "7.8.
|
17184
|
+
readonly openApiSchemaVersion = "7.8.5";
|
17141
17185
|
constructor(config: CommerceLayerInitConfig);
|
17142
17186
|
get addresses(): Addresses;
|
17143
17187
|
get adjustments(): Adjustments;
|
package/lib/index.d.ts
CHANGED
@@ -1094,7 +1094,6 @@ interface PaymentMethod extends Resource {
|
|
1094
1094
|
market?: Market | null;
|
1095
1095
|
payment_gateway?: PaymentGateway | null;
|
1096
1096
|
store?: Store | null;
|
1097
|
-
orders?: Order[] | null;
|
1098
1097
|
attachments?: Attachment[] | null;
|
1099
1098
|
versions?: Version[] | null;
|
1100
1099
|
}
|
@@ -1218,7 +1217,6 @@ declare class PaymentMethods extends ApiResource<PaymentMethod> {
|
|
1218
1217
|
market(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<Market>, options?: ResourcesConfig): Promise<Market>;
|
1219
1218
|
payment_gateway(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentGateway>, options?: ResourcesConfig): Promise<PaymentGateway>;
|
1220
1219
|
store(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve<Store>, options?: ResourcesConfig): Promise<Store>;
|
1221
|
-
orders(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Order>, options?: ResourcesConfig): Promise<ListResponse<Order>>;
|
1222
1220
|
attachments(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
1223
1221
|
versions(paymentMethodId: string | PaymentMethod, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
1224
1222
|
_disable(id: string | PaymentMethod, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
|
@@ -2030,6 +2028,11 @@ interface StripePayment extends Resource {
|
|
2030
2028
|
* @example ```"pi_1234XXX_secret_5678YYY"```
|
2031
2029
|
*/
|
2032
2030
|
client_secret?: string | null;
|
2031
|
+
/**
|
2032
|
+
* The account (if any) for which the funds of the PaymentIntent are intended.
|
2033
|
+
* @example ```"acct_xxxx-yyyy-zzzz"```
|
2034
|
+
*/
|
2035
|
+
connected_account?: string | null;
|
2033
2036
|
/**
|
2034
2037
|
* The Stripe charge ID. Identifies money movement upon the payment intent confirmation.
|
2035
2038
|
* @example ```"ch_1234XXX"```
|
@@ -5649,7 +5652,7 @@ declare class Adjustments extends ApiResource<Adjustment> {
|
|
5649
5652
|
}
|
5650
5653
|
|
5651
5654
|
type DiscountEngineType = 'discount_engines';
|
5652
|
-
type DiscountEngineRel$
|
5655
|
+
type DiscountEngineRel$2 = ResourceRel & {
|
5653
5656
|
type: DiscountEngineType;
|
5654
5657
|
};
|
5655
5658
|
type DiscountEngineSort = Pick<DiscountEngine, 'id' | 'name'> & ResourceSort;
|
@@ -5676,8 +5679,8 @@ declare class DiscountEngines extends ApiResource<DiscountEngine> {
|
|
5676
5679
|
attachments(discountEngineId: string | DiscountEngine, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
5677
5680
|
versions(discountEngineId: string | DiscountEngine, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
5678
5681
|
isDiscountEngine(resource: any): resource is DiscountEngine;
|
5679
|
-
relationship(id: string | ResourceId | null): DiscountEngineRel$
|
5680
|
-
relationshipToMany(...ids: string[]): DiscountEngineRel$
|
5682
|
+
relationship(id: string | ResourceId | null): DiscountEngineRel$2;
|
5683
|
+
relationshipToMany(...ids: string[]): DiscountEngineRel$2[];
|
5681
5684
|
type(): DiscountEngineType;
|
5682
5685
|
}
|
5683
5686
|
|
@@ -9258,6 +9261,16 @@ interface Customer extends Resource {
|
|
9258
9261
|
* @example ```"xxx-yyy-zzz"```
|
9259
9262
|
*/
|
9260
9263
|
tax_exemption_code?: string | null;
|
9264
|
+
/**
|
9265
|
+
* The custom_claim attached to the current JWT (if any).
|
9266
|
+
* @example ```{}```
|
9267
|
+
*/
|
9268
|
+
jwt_custom_claim?: Record<string, any> | null;
|
9269
|
+
/**
|
9270
|
+
* The anonymization info object.
|
9271
|
+
* @example ```{"status":"requested","requested_at":"2025-03-15 11:39:21 UTC","requester":{"id":"fdgt56hh","first_name":"Travis","last_name":"Muller","email":"test@labadie.test"}}```
|
9272
|
+
*/
|
9273
|
+
anonymization_info?: Record<string, any> | null;
|
9261
9274
|
customer_group?: CustomerGroup | null;
|
9262
9275
|
customer_addresses?: CustomerAddress[] | null;
|
9263
9276
|
customer_payment_sources?: CustomerPaymentSource[] | null;
|
@@ -9269,6 +9282,9 @@ interface Customer extends Resource {
|
|
9269
9282
|
attachments?: Attachment[] | null;
|
9270
9283
|
events?: Event[] | null;
|
9271
9284
|
tags?: Tag[] | null;
|
9285
|
+
jwt_customer?: Customer | null;
|
9286
|
+
jwt_markets?: Market[] | null;
|
9287
|
+
jwt_stock_locations?: StockLocation[] | null;
|
9272
9288
|
}
|
9273
9289
|
interface CustomerCreate extends ResourceCreate {
|
9274
9290
|
/**
|
@@ -9333,6 +9349,16 @@ interface CustomerUpdate extends ResourceUpdate {
|
|
9333
9349
|
* Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
|
9334
9350
|
*/
|
9335
9351
|
_remove_tags?: string | null;
|
9352
|
+
/**
|
9353
|
+
* Send this attribute if you want to trigger anonymization.
|
9354
|
+
* @example ```true```
|
9355
|
+
*/
|
9356
|
+
_request_anonymization?: boolean | null;
|
9357
|
+
/**
|
9358
|
+
* Send this attribute if you want to trigger a cancellation of anonymization.
|
9359
|
+
* @example ```true```
|
9360
|
+
*/
|
9361
|
+
_cancel_anonymization?: boolean | null;
|
9336
9362
|
customer_group?: CustomerGroupRel$2 | null;
|
9337
9363
|
tags?: TagRel$4[] | null;
|
9338
9364
|
}
|
@@ -9352,8 +9378,13 @@ declare class Customers extends ApiResource<Customer> {
|
|
9352
9378
|
attachments(customerId: string | Customer, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
|
9353
9379
|
events(customerId: string | Customer, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>>;
|
9354
9380
|
tags(customerId: string | Customer, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
|
9381
|
+
jwt_customer(customerId: string | Customer, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9382
|
+
jwt_markets(customerId: string | Customer, params?: QueryParamsList<Market>, options?: ResourcesConfig): Promise<ListResponse<Market>>;
|
9383
|
+
jwt_stock_locations(customerId: string | Customer, params?: QueryParamsList<StockLocation>, options?: ResourcesConfig): Promise<ListResponse<StockLocation>>;
|
9355
9384
|
_add_tags(id: string | Customer, triggerValue: string, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9356
9385
|
_remove_tags(id: string | Customer, triggerValue: string, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9386
|
+
_request_anonymization(id: string | Customer, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9387
|
+
_cancel_anonymization(id: string | Customer, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer>;
|
9357
9388
|
isCustomer(resource: any): resource is Customer;
|
9358
9389
|
relationship(id: string | ResourceId | null): CustomerRel$3;
|
9359
9390
|
relationshipToMany(...ids: string[]): CustomerRel$3[];
|
@@ -10118,7 +10149,7 @@ interface Order extends Resource {
|
|
10118
10149
|
*/
|
10119
10150
|
fulfillment_updated_at?: string | null;
|
10120
10151
|
/**
|
10121
|
-
* Last time at which
|
10152
|
+
* Last time at which the order was refreshed.
|
10122
10153
|
* @example ```"2018-01-01T12:00:00.000Z"```
|
10123
10154
|
*/
|
10124
10155
|
refreshed_at?: string | null;
|
@@ -10155,6 +10186,7 @@ interface Order extends Resource {
|
|
10155
10186
|
available_free_bundles?: Bundle[] | null;
|
10156
10187
|
payment_method?: PaymentMethod | null;
|
10157
10188
|
payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null;
|
10189
|
+
discount_engine_item?: DiscountEngineItem | null;
|
10158
10190
|
line_items?: LineItem[] | null;
|
10159
10191
|
line_item_options?: LineItemOption[] | null;
|
10160
10192
|
stock_reservations?: StockReservation[] | null;
|
@@ -10568,6 +10600,7 @@ declare class Orders extends ApiResource<Order> {
|
|
10568
10600
|
available_free_skus(orderId: string | Order, params?: QueryParamsList<Sku>, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
|
10569
10601
|
available_free_bundles(orderId: string | Order, params?: QueryParamsList<Bundle>, options?: ResourcesConfig): Promise<ListResponse<Bundle>>;
|
10570
10602
|
payment_method(orderId: string | Order, params?: QueryParamsRetrieve<PaymentMethod>, options?: ResourcesConfig): Promise<PaymentMethod>;
|
10603
|
+
discount_engine_item(orderId: string | Order, params?: QueryParamsRetrieve<DiscountEngineItem>, options?: ResourcesConfig): Promise<DiscountEngineItem>;
|
10571
10604
|
line_items(orderId: string | Order, params?: QueryParamsList<LineItem>, options?: ResourcesConfig): Promise<ListResponse<LineItem>>;
|
10572
10605
|
line_item_options(orderId: string | Order, params?: QueryParamsList<LineItemOption>, options?: ResourcesConfig): Promise<ListResponse<LineItemOption>>;
|
10573
10606
|
stock_reservations(orderId: string | Order, params?: QueryParamsList<StockReservation>, options?: ResourcesConfig): Promise<ListResponse<StockReservation>>;
|
@@ -13958,7 +13991,7 @@ type DeliveryLeadTimeRel = ResourceRel & {
|
|
13958
13991
|
type ShippingMethodRel$1 = ResourceRel & {
|
13959
13992
|
type: ShippingMethodType;
|
13960
13993
|
};
|
13961
|
-
type DiscountEngineRel = ResourceRel & {
|
13994
|
+
type DiscountEngineRel$1 = ResourceRel & {
|
13962
13995
|
type: DiscountEngineType;
|
13963
13996
|
};
|
13964
13997
|
type ShipmentRel$1 = ResourceRel & {
|
@@ -14042,7 +14075,7 @@ interface AttachmentCreate extends ResourceCreate {
|
|
14042
14075
|
* @example ```"https://s3.yourdomain.com/attachment.pdf"```
|
14043
14076
|
*/
|
14044
14077
|
url?: string | null;
|
14045
|
-
attachable: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | DiscountEngineRel | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel;
|
14078
|
+
attachable: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | DiscountEngineRel$1 | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel;
|
14046
14079
|
}
|
14047
14080
|
interface AttachmentUpdate extends ResourceUpdate {
|
14048
14081
|
/**
|
@@ -14060,7 +14093,7 @@ interface AttachmentUpdate extends ResourceUpdate {
|
|
14060
14093
|
* @example ```"https://s3.yourdomain.com/attachment.pdf"```
|
14061
14094
|
*/
|
14062
14095
|
url?: string | null;
|
14063
|
-
attachable?: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | DiscountEngineRel | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel | null;
|
14096
|
+
attachable?: GeocoderRel$3 | PriceListRel$1 | PaymentMethodRel$1 | MarketRel$2 | CustomerGroupRel$1 | OrderRel | TransactionRel | PromotionRel | TaxCalculatorRel | TaxCategoryRel | SkuRel$1 | ShippingCategoryRel | BundleRel | SkuListRel | StockItemRel | StockLocationRel | ReturnRel | CarrierAccountRel | CouponRecipientRel | CustomerRel$1 | DeliveryLeadTimeRel | ShippingMethodRel$1 | DiscountEngineRel$1 | ShipmentRel$1 | ParcelRel | GiftCardRecipientRel | GiftCardRel | InventoryModelRel$1 | StockTransferRel | SkuOptionRel | MerchantRel$2 | SubscriptionModelRel$1 | PaymentOptionRel | PackageRel | PriceRel | PriceTierRel | ShippingMethodTierRel | ShippingZoneRel | null;
|
14064
14097
|
}
|
14065
14098
|
declare class Attachments extends ApiResource<Attachment> {
|
14066
14099
|
static readonly TYPE: AttachmentType;
|
@@ -14138,6 +14171,9 @@ type InventoryModelRel = ResourceRel & {
|
|
14138
14171
|
type SubscriptionModelRel = ResourceRel & {
|
14139
14172
|
type: SubscriptionModelType;
|
14140
14173
|
};
|
14174
|
+
type DiscountEngineRel = ResourceRel & {
|
14175
|
+
type: DiscountEngineType;
|
14176
|
+
};
|
14141
14177
|
type AvalaraAccountRel = ResourceRel & {
|
14142
14178
|
type: AvalaraAccountType;
|
14143
14179
|
};
|
@@ -14231,6 +14267,7 @@ interface Market extends Resource {
|
|
14231
14267
|
base_price_list?: PriceList | null;
|
14232
14268
|
inventory_model?: InventoryModel | null;
|
14233
14269
|
subscription_model?: SubscriptionModel | null;
|
14270
|
+
discount_engine?: DiscountEngine | null;
|
14234
14271
|
tax_calculator?: AvalaraAccount | StripeTaxAccount | VertexAccount | TaxjarAccount | ManualTaxCalculator | ExternalTaxCalculator | null;
|
14235
14272
|
customer_group?: CustomerGroup | null;
|
14236
14273
|
geocoder?: Geocoder | null;
|
@@ -14291,6 +14328,7 @@ interface MarketCreate extends ResourceCreate {
|
|
14291
14328
|
price_list: PriceListRel;
|
14292
14329
|
inventory_model: InventoryModelRel;
|
14293
14330
|
subscription_model?: SubscriptionModelRel | null;
|
14331
|
+
discount_engine?: DiscountEngineRel | null;
|
14294
14332
|
tax_calculator?: AvalaraAccountRel | StripeTaxAccountRel | VertexAccountRel | TaxjarAccountRel | ManualTaxCalculatorRel | ExternalTaxCalculatorRel | null;
|
14295
14333
|
customer_group?: CustomerGroupRel | null;
|
14296
14334
|
geocoder?: GeocoderRel$2 | null;
|
@@ -14347,6 +14385,7 @@ interface MarketUpdate extends ResourceUpdate {
|
|
14347
14385
|
price_list?: PriceListRel | null;
|
14348
14386
|
inventory_model?: InventoryModelRel | null;
|
14349
14387
|
subscription_model?: SubscriptionModelRel | null;
|
14388
|
+
discount_engine?: DiscountEngineRel | null;
|
14350
14389
|
tax_calculator?: AvalaraAccountRel | StripeTaxAccountRel | VertexAccountRel | TaxjarAccountRel | ManualTaxCalculatorRel | ExternalTaxCalculatorRel | null;
|
14351
14390
|
customer_group?: CustomerGroupRel | null;
|
14352
14391
|
geocoder?: GeocoderRel$2 | null;
|
@@ -14363,6 +14402,7 @@ declare class Markets extends ApiResource<Market> {
|
|
14363
14402
|
base_price_list(marketId: string | Market, params?: QueryParamsRetrieve<PriceList>, options?: ResourcesConfig): Promise<PriceList>;
|
14364
14403
|
inventory_model(marketId: string | Market, params?: QueryParamsRetrieve<InventoryModel>, options?: ResourcesConfig): Promise<InventoryModel>;
|
14365
14404
|
subscription_model(marketId: string | Market, params?: QueryParamsRetrieve<SubscriptionModel>, options?: ResourcesConfig): Promise<SubscriptionModel>;
|
14405
|
+
discount_engine(marketId: string | Market, params?: QueryParamsRetrieve<DiscountEngine>, options?: ResourcesConfig): Promise<DiscountEngine>;
|
14366
14406
|
tax_calculator(marketId: string | Market, params?: QueryParamsRetrieve<TaxCalculator>, options?: ResourcesConfig): Promise<TaxCalculator>;
|
14367
14407
|
customer_group(marketId: string | Market, params?: QueryParamsRetrieve<CustomerGroup>, options?: ResourcesConfig): Promise<CustomerGroup>;
|
14368
14408
|
geocoder(marketId: string | Market, params?: QueryParamsRetrieve<Geocoder>, options?: ResourcesConfig): Promise<Geocoder>;
|
@@ -16332,6 +16372,10 @@ interface Organization extends Resource {
|
|
16332
16372
|
* @example ```true```
|
16333
16373
|
*/
|
16334
16374
|
addresses_phone_required?: boolean | null;
|
16375
|
+
/**
|
16376
|
+
* 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, until the lapse is observed.
|
16377
|
+
*/
|
16378
|
+
orders_min_refresh_lapse?: number | null;
|
16335
16379
|
/**
|
16336
16380
|
* The maximum number line items allowed for a test order before disabling the autorefresh option.
|
16337
16381
|
* @example ```50```
|
@@ -17137,7 +17181,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
17137
17181
|
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
17138
17182
|
declare class CommerceLayerClient {
|
17139
17183
|
#private;
|
17140
|
-
readonly openApiSchemaVersion = "7.8.
|
17184
|
+
readonly openApiSchemaVersion = "7.8.5";
|
17141
17185
|
constructor(config: CommerceLayerInitConfig);
|
17142
17186
|
get addresses(): Addresses;
|
17143
17187
|
get adjustments(): Adjustments;
|