@commercelayer/sdk 6.15.0 → 6.17.0

package/lib/index.d.mts

@@ -789,7 +789,7 @@ interface WebhookUpdate extends ResourceUpdate {
      */
     _enable?: boolean | null;
     /**
-     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count.
+     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _reset_circuit?: boolean | null;
@@ -827,7 +827,7 @@ interface Event extends Resource {
 }
 interface EventUpdate extends ResourceUpdate {
     /**
-     * Send this attribute if you want to force webhooks execution for this event.
+     * Send this attribute if you want to force webhooks execution for this event. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _trigger?: boolean | null;
@@ -3606,17 +3606,17 @@ interface StockLineItemUpdate extends ResourceUpdate {
      */
     quantity?: number | null;
     /**
-     * Send this attribute if you want to automatically reserve the stock for this stock line item. Can be done only when fulfillment is in progress.
+     * Send this attribute if you want to automatically reserve the stock for this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _reserve_stock?: boolean | null;
     /**
-     * Send this attribute if you want to automatically destroy the stock reservation for this stock line item. Can be done only when fulfillment is in progress.
+     * Send this attribute if you want to automatically destroy the stock reservation for this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _release_stock?: boolean | null;
     /**
-     * Send this attribute if you want to automatically decrement and release the stock this stock line item. Can be done only when fulfillment is in progress.
+     * Send this attribute if you want to automatically decrement and release the stock this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _decrement_stock?: boolean | null;
@@ -5106,7 +5106,7 @@ interface ExternalPromotionUpdate extends ResourceUpdate {
      */
     promotion_url?: string | null;
     /**
-     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count.
+     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _reset_circuit?: boolean | null;
@@ -5459,9 +5459,9 @@ interface FlexPromotion extends Resource {
     status?: 'disabled' | 'expired' | 'pending' | 'active' | 'inactive' | null;
     /**
      * The discount rule to be applied.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rules: object;
+    rules: Record<string, any>;
     /**
      * Time at which this resource was disabled.
      * @example ```"2018-01-01T12:00:00.000Z"```
@@ -5469,9 +5469,9 @@ interface FlexPromotion extends Resource {
     disabled_at?: string | null;
     /**
      * The rule outcomes.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rule_outcomes?: object | null;
+    rule_outcomes?: Record<string, any> | null;
     coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
     coupons?: Coupon[] | null;
     attachments?: Attachment[] | null;
@@ -5512,9 +5512,9 @@ interface FlexPromotionCreate extends ResourceCreate {
     total_usage_limit?: number | null;
     /**
      * The discount rule to be applied.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rules: object;
+    rules: Record<string, any>;
     /**
      * Send this attribute if you want to mark this resource as disabled.
      * @example ```"true"```
@@ -5561,9 +5561,9 @@ interface FlexPromotionUpdate extends ResourceUpdate {
     total_usage_limit?: number | null;
     /**
      * The discount rule to be applied.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rules?: object | null;
+    rules?: Record<string, any> | null;
     /**
      * Send this attribute if you want to mark this resource as disabled.
      * @example ```"true"```
@@ -7283,7 +7283,7 @@ interface LineItem extends Resource {
      */
     formatted_compare_at_amount?: string | null;
     /**
-     * The options amount of the line item, in cents.
+     * The options amount of the line item, in cents. Cannot be passed by sales channels.
      * @example ```"1000"```
      */
     options_amount_cents?: number | null;
@@ -7435,7 +7435,7 @@ interface LineItemCreate extends ResourceCreate {
      */
     _update_quantity?: boolean | null;
     /**
-     * Send this attribute if you want to reserve the stock for the line item's SKUs quantity. Stock reservations expiration depends on the inventory model's cutoff. When used on update the existing active stock reservations are renewed.
+     * Send this attribute if you want to reserve the stock for the line item's SKUs quantity. Stock reservations expiration depends on the inventory model's cutoff. When used on update the existing active stock reservations are renewed. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _reserve_stock?: boolean | null;
@@ -7495,7 +7495,7 @@ interface LineItemUpdate extends ResourceUpdate {
      */
     _external_price?: boolean | null;
     /**
-     * Send this attribute if you want to reserve the stock for the line item's SKUs quantity. Stock reservations expiration depends on the inventory model's cutoff. When used on update the existing active stock reservations are renewed.
+     * Send this attribute if you want to reserve the stock for the line item's SKUs quantity. Stock reservations expiration depends on the inventory model's cutoff. When used on update the existing active stock reservations are renewed. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _reserve_stock?: boolean | null;
@@ -7509,6 +7509,11 @@ interface LineItemUpdate extends ResourceUpdate {
      * @example ```"13000"```
      */
     compare_at_amount_cents?: number | null;
+    /**
+     * The options amount of the line item, in cents. Cannot be passed by sales channels.
+     * @example ```"1000"```
+     */
+    options_amount_cents?: number | null;
     /**
      * The name of the line item. When blank, it gets populated with the name of the associated item (if present).
      * @example ```"Men's Black T-shirt with White Logo (XL)"```
@@ -7525,7 +7530,7 @@ interface LineItemUpdate extends ResourceUpdate {
      */
     frequency?: string | null;
     /**
-     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count.
+     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _reset_circuit?: boolean | null;
@@ -8290,6 +8295,16 @@ interface OrderCopy extends Resource {
      * @example ```"true"```
      */
     cancel_source_order?: boolean | null;
+    /**
+     * Indicates if promotions got applied upon copy.
+     * @example ```"true"```
+     */
+    apply_promotions?: boolean | null;
+    /**
+     * Indicates to ignore invalid coupon code during copy.
+     * @example ```"true"```
+     */
+    ignore_invalid_coupon?: boolean | null;
     source_order?: Order | null;
     target_order?: Order | null;
     events?: Event[] | null;
@@ -8311,6 +8326,16 @@ interface OrderCopyCreate extends ResourceCreate {
      * @example ```"true"```
      */
     cancel_source_order?: boolean | null;
+    /**
+     * Indicates if promotions got applied upon copy.
+     * @example ```"true"```
+     */
+    apply_promotions?: boolean | null;
+    /**
+     * Indicates to ignore invalid coupon code during copy.
+     * @example ```"true"```
+     */
+    ignore_invalid_coupon?: boolean | null;
     source_order: OrderRel$3;
 }
 type OrderCopyUpdate = ResourceUpdate;
@@ -8382,7 +8407,7 @@ type OrderSort = Pick<Order, 'id' | 'number' | 'place_async' | 'status' | 'payme
 interface Order extends Resource {
     readonly type: OrderType;
     /**
-     * The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise.
+     * The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise. Cannot be passed by sales channels.
      * @example ```"1234"```
      */
     number?: string | null;
@@ -8944,7 +8969,7 @@ interface Order extends Resource {
 }
 interface OrderCreate extends ResourceCreate {
     /**
-     * The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise.
+     * The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise. Cannot be passed by sales channels.
      * @example ```"1234"```
      */
     number?: string | null;
@@ -9042,7 +9067,7 @@ interface OrderCreate extends ResourceCreate {
 }
 interface OrderUpdate extends ResourceUpdate {
     /**
-     * The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise.
+     * The order identifier. Can be specified if unique within the organization (for enterprise plans only), default to numeric ID otherwise. Cannot be passed by sales channels.
      * @example ```"1234"```
      */
     number?: string | null;
@@ -9141,7 +9166,7 @@ interface OrderUpdate extends ResourceUpdate {
      */
     _unarchive?: boolean | null;
     /**
-     * Send this attribute if you want to move a draft or placing order to pending.
+     * Send this attribute if you want to move a draft or placing order to pending. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _pending?: boolean | null;
@@ -9156,12 +9181,12 @@ interface OrderUpdate extends ResourceUpdate {
      */
     _cancel?: boolean | null;
     /**
-     * Send this attribute if you want to approve a placed order.
+     * Send this attribute if you want to approve a placed order. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _approve?: boolean | null;
     /**
-     * Send this attribute if you want to approve and capture a placed order.
+     * Send this attribute if you want to approve and capture a placed order. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _approve_and_capture?: boolean | null;
@@ -9176,17 +9201,17 @@ interface OrderUpdate extends ResourceUpdate {
      */
     _authorization_amount_cents?: number | null;
     /**
-     * Send this attribute if you want to capture an authorized order.
+     * Send this attribute if you want to capture an authorized order. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _capture?: boolean | null;
     /**
-     * Send this attribute if you want to refund a captured order.
+     * Send this attribute if you want to refund a captured order. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _refund?: boolean | null;
     /**
-     * Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered).
+     * Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered). Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _fulfill?: boolean | null;
@@ -9265,17 +9290,17 @@ interface OrderUpdate extends ResourceUpdate {
      */
     _create_subscriptions?: boolean | null;
     /**
-     * Send this attribute if you want to edit the order after it is placed. Remember you cannot exceed the original total amount.
+     * Send this attribute if you want to edit the order after it is placed. Remember you cannot exceed the original total amount. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _start_editing?: boolean | null;
     /**
-     * Send this attribute to stop the editing for the order and return back to placed status.
+     * Send this attribute to stop the editing for the order and return back to placed status. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _stop_editing?: boolean | null;
     /**
-     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count.
+     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _reset_circuit?: boolean | null;
@@ -9968,7 +9993,7 @@ interface ShippingMethodUpdate extends ResourceUpdate {
      */
     _enable?: boolean | null;
     /**
-     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count.
+     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _reset_circuit?: boolean | null;
@@ -10701,7 +10726,7 @@ type ShipmentSort = Pick<Shipment, 'id' | 'number' | 'status' | 'cost_amount_cen
 interface Shipment extends Resource {
     readonly type: ShipmentType;
     /**
-     * Unique identifier for the shipment.
+     * Unique identifier for the shipment. Cannot be passed by sales channels.
      * @example ```"#1234/S/001"```
      */
     number: string;
@@ -10839,17 +10864,17 @@ interface ShipmentCreate extends ResourceCreate {
 }
 interface ShipmentUpdate extends ResourceUpdate {
     /**
-     * Unique identifier for the shipment.
+     * Unique identifier for the shipment. Cannot be passed by sales channels.
      * @example ```"#1234/S/001"```
      */
     number?: string | null;
     /**
-     * Send this attribute if you want to mark this shipment as upcoming.
+     * Send this attribute if you want to mark this shipment as upcoming. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _upcoming?: boolean | null;
     /**
-     * Send this attribute if you want to mark this shipment as cancelled (unless already shipped or delivered).
+     * Send this attribute if you want to mark this shipment as cancelled (unless already shipped or delivered). Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _cancel?: boolean | null;
@@ -10884,17 +10909,17 @@ interface ShipmentUpdate extends ResourceUpdate {
      */
     _deliver?: boolean | null;
     /**
-     * Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. Can be done only when fulfillment is in progress.
+     * Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _reserve_stock?: boolean | null;
     /**
-     * Send this attribute if you want to automatically destroy the stock reservations for each of the associated stock line item. Can be done only when fulfillment is in progress.
+     * Send this attribute if you want to automatically destroy the stock reservations for each of the associated stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _release_stock?: boolean | null;
     /**
-     * Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. Can be done only when fulfillment is in progress.
+     * Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _decrement_stock?: boolean | null;
@@ -11273,7 +11298,7 @@ interface StockItemUpdate extends ResourceUpdate {
      */
     quantity?: number | null;
     /**
-     * Send this attribute if you want to validate the stock item quantity against the existing reserved stock one, returns an error in case the former is smaller.
+     * Send this attribute if you want to validate the stock item quantity against the existing reserved stock one, returns an error in case the former is smaller. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _validate?: boolean | null;
@@ -11805,14 +11830,14 @@ interface Price extends Resource {
     formatted_compare_at_amount?: string | null;
     /**
      * The rules (using Rules Engine) to be applied.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rules?: object | null;
+    rules?: Record<string, any> | null;
     /**
      * The rule outcomes.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rule_outcomes?: object | null;
+    rule_outcomes?: Record<string, any> | null;
     price_list?: PriceList | null;
     sku?: Sku | null;
     price_tiers?: PriceTier[] | null;
@@ -11842,9 +11867,9 @@ interface PriceCreate extends ResourceCreate {
     compare_at_amount_cents?: number | null;
     /**
      * The rules (using Rules Engine) to be applied.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rules?: object | null;
+    rules?: Record<string, any> | null;
     price_list: PriceListRel$4;
     sku: SkuRel$3;
     price_tiers?: PriceTierRel$1[] | null;
@@ -11867,9 +11892,9 @@ interface PriceUpdate extends ResourceUpdate {
     compare_at_amount_cents?: number | null;
     /**
      * The rules (using Rules Engine) to be applied.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rules?: object | null;
+    rules?: Record<string, any> | null;
     price_list?: PriceListRel$4 | null;
     sku?: SkuRel$3 | null;
     price_tiers?: PriceTierRel$1[] | null;
@@ -12047,14 +12072,14 @@ interface PriceList extends Resource {
     tax_included?: boolean | null;
     /**
      * The rules (using Rules Engine) to be applied.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rules?: object | null;
+    rules?: Record<string, any> | null;
     /**
      * The rule outcomes.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rule_outcomes?: object | null;
+    rule_outcomes?: Record<string, any> | null;
     prices?: Price[] | null;
     price_list_schedulers?: PriceListScheduler[] | null;
     attachments?: Attachment[] | null;
@@ -12083,9 +12108,9 @@ interface PriceListCreate extends ResourceCreate {
     tax_included?: boolean | null;
     /**
      * The rules (using Rules Engine) to be applied.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rules?: object | null;
+    rules?: Record<string, any> | null;
 }
 interface PriceListUpdate extends ResourceUpdate {
     /**
@@ -12110,9 +12135,9 @@ interface PriceListUpdate extends ResourceUpdate {
     tax_included?: boolean | null;
     /**
      * The rules (using Rules Engine) to be applied.
-     * @example ```"{}"```
+     * @example ```"[object Object]"```
      */
-    rules?: object | null;
+    rules?: Record<string, any> | null;
 }
 declare class PriceLists extends ApiResource<PriceList> {
     static readonly TYPE: PriceListType;
@@ -12828,7 +12853,7 @@ interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
      */
     tax_calculator_url?: string | null;
     /**
-     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count.
+     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _reset_circuit?: boolean | null;
@@ -13251,6 +13276,7 @@ interface Market extends Resource {
     shared_secret: string;
     merchant?: Merchant | null;
     price_list?: PriceList | null;
+    base_price_list?: PriceList | null;
     inventory_model?: InventoryModel | null;
     subscription_model?: SubscriptionModel | null;
     tax_calculator?: AvalaraAccount | TaxjarAccount | ManualTaxCalculator | ExternalTaxCalculator | null;
@@ -13375,6 +13401,7 @@ declare class Markets extends ApiResource<Market> {
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     merchant(marketId: string | Market, params?: QueryParamsRetrieve<Merchant>, options?: ResourcesConfig): Promise<Merchant>;
     price_list(marketId: string | Market, params?: QueryParamsRetrieve<PriceList>, options?: ResourcesConfig): Promise<PriceList>;
+    base_price_list(marketId: string | Market, params?: QueryParamsRetrieve<PriceList>, options?: ResourcesConfig): Promise<PriceList>;
     inventory_model(marketId: string | Market, params?: QueryParamsRetrieve<InventoryModel>, options?: ResourcesConfig): Promise<InventoryModel>;
     subscription_model(marketId: string | Market, params?: QueryParamsRetrieve<SubscriptionModel>, options?: ResourcesConfig): Promise<SubscriptionModel>;
     tax_calculator(marketId: string | Market, params?: QueryParamsRetrieve<TaxCalculator>, options?: ResourcesConfig): Promise<TaxCalculator>;
@@ -14688,7 +14715,7 @@ interface ExternalGatewayUpdate extends ResourceUpdate {
      */
     token_url?: string | null;
     /**
-     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count.
+     * Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
      * @example ```"true"```
      */
     _reset_circuit?: boolean | null;
@@ -15776,7 +15803,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
 type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
 declare class CommerceLayerClient {
     #private;
-    readonly openApiSchemaVersion = "7.0.0";
+    readonly openApiSchemaVersion = "7.1.0";
     constructor(config: CommerceLayerInitConfig);
     get addresses(): Addresses;
     get adjustments(): Adjustments;