@commercelayer/sdk 6.2.0 → 6.4.0

package/lib/index.d.mts

@@ -4946,6 +4946,11 @@ interface GiftCard extends Resource {
      * @example ```"[object Object],[object Object]"```
      */
     balance_log: Array<Record<string, any>>;
+    /**
+     * The gift card usage log. Tracks all the gift card usage actions by orders..
+     * @example ```"[object Object]"```
+     */
+    usage_log: Record<string, any>;
     /**
      * Indicates if the gift card can be used only one..
      */
@@ -8482,6 +8487,11 @@ interface OrderUpdate extends ResourceUpdate {
      * @example ```"true"```
      */
     _refund?: boolean | null;
+    /**
+     * Send this attribute if you want to mark as fulfilled a shipped/delivered order..
+     * @example ```"true"```
+     */
+    _fulfill?: boolean | null;
     /**
      * Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market)..
      * @example ```"true"```
@@ -8626,6 +8636,7 @@ declare class Orders extends ApiResource<Order> {
     _authorization_amount_cents(id: string | Order, triggerValue: number, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _capture(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _refund(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
+    _fulfill(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _update_taxes(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _nullify_payment_source(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _billing_address_clone_id(id: string | Order, triggerValue: string, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
@@ -9944,15 +9955,15 @@ 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..
      * @example ```"#1234/S/001"```
      */
-    number?: string | null;
+    number: string;
     /**
-     * The shipment status, one of 'draft', 'upcoming', 'cancelled', 'on_hold', 'picking', 'packing', 'ready_to_ship', or 'shipped'..
+     * The shipment status, one of 'draft', 'upcoming', 'cancelled', 'on_hold', 'picking', 'packing', 'ready_to_ship', 'shipped', or 'delivered'..
      * @example ```"draft"```
      */
-    status: 'draft' | 'upcoming' | 'cancelled' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'shipped';
+    status: 'draft' | 'upcoming' | 'cancelled' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'shipped' | 'delivered';
     /**
      * The international 3-letter currency code as defined by the ISO 4217 standard, automatically inherited from the associated order..
      * @example ```"EUR"```
@@ -10081,6 +10092,11 @@ interface ShipmentCreate extends ResourceCreate {
     tags?: TagRel$3[] | null;
 }
 interface ShipmentUpdate extends ResourceUpdate {
+    /**
+     * Unique identifier for the shipment..
+     * @example ```"#1234/S/001"```
+     */
+    number?: string | null;
     /**
      * Send this attribute if you want to mark this shipment as upcoming..
      * @example ```"true"```
@@ -10111,6 +10127,11 @@ interface ShipmentUpdate extends ResourceUpdate {
      * @example ```"true"```
      */
     _ship?: boolean | null;
+    /**
+     * Send this attribute if you want to mark this shipment as delivered..
+     * @example ```"true"```
+     */
+    _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..
      * @example ```"true"```
@@ -10176,6 +10197,7 @@ declare class Shipments extends ApiResource<Shipment> {
     _packing(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
     _ready_to_ship(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
     _ship(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
+    _deliver(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
     _reserve_stock(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
     _release_stock(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
     _decrement_stock(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
@@ -10245,6 +10267,11 @@ interface StockTransfer extends Resource {
     versions?: Version[] | null;
 }
 interface StockTransferCreate extends ResourceCreate {
+    /**
+     * Unique identifier for the stock transfer (numeric)..
+     * @example ```"1234"```
+     */
+    number?: string | null;
     /**
      * The code of the associated SKU..
      * @example ```"TSHIRTMM000000FFFFFFXLXX"```
@@ -10262,6 +10289,11 @@ interface StockTransferCreate extends ResourceCreate {
     line_item?: LineItemRel | null;
 }
 interface StockTransferUpdate extends ResourceUpdate {
+    /**
+     * Unique identifier for the stock transfer (numeric)..
+     * @example ```"1234"```
+     */
+    number?: string | null;
     /**
      * The code of the associated SKU..
      * @example ```"TSHIRTMM000000FFFFFFXLXX"```
@@ -15000,7 +15032,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
 type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
 declare class CommerceLayerClient {
     #private;
-    readonly openApiSchemaVersion = "5.3.1";
+    readonly openApiSchemaVersion = "5.3.3";
     constructor(config: CommerceLayerInitConfig);
     get addresses(): Addresses;
     get adjustments(): Adjustments;

package/lib/index.d.ts

@@ -4946,6 +4946,11 @@ interface GiftCard extends Resource {
      * @example ```"[object Object],[object Object]"```
      */
     balance_log: Array<Record<string, any>>;
+    /**
+     * The gift card usage log. Tracks all the gift card usage actions by orders..
+     * @example ```"[object Object]"```
+     */
+    usage_log: Record<string, any>;
     /**
      * Indicates if the gift card can be used only one..
      */
@@ -8482,6 +8487,11 @@ interface OrderUpdate extends ResourceUpdate {
      * @example ```"true"```
      */
     _refund?: boolean | null;
+    /**
+     * Send this attribute if you want to mark as fulfilled a shipped/delivered order..
+     * @example ```"true"```
+     */
+    _fulfill?: boolean | null;
     /**
      * Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market)..
      * @example ```"true"```
@@ -8626,6 +8636,7 @@ declare class Orders extends ApiResource<Order> {
     _authorization_amount_cents(id: string | Order, triggerValue: number, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _capture(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _refund(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
+    _fulfill(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _update_taxes(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _nullify_payment_source(id: string | Order, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
     _billing_address_clone_id(id: string | Order, triggerValue: string, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order>;
@@ -9944,15 +9955,15 @@ 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..
      * @example ```"#1234/S/001"```
      */
-    number?: string | null;
+    number: string;
     /**
-     * The shipment status, one of 'draft', 'upcoming', 'cancelled', 'on_hold', 'picking', 'packing', 'ready_to_ship', or 'shipped'..
+     * The shipment status, one of 'draft', 'upcoming', 'cancelled', 'on_hold', 'picking', 'packing', 'ready_to_ship', 'shipped', or 'delivered'..
      * @example ```"draft"```
      */
-    status: 'draft' | 'upcoming' | 'cancelled' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'shipped';
+    status: 'draft' | 'upcoming' | 'cancelled' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'shipped' | 'delivered';
     /**
      * The international 3-letter currency code as defined by the ISO 4217 standard, automatically inherited from the associated order..
      * @example ```"EUR"```
@@ -10081,6 +10092,11 @@ interface ShipmentCreate extends ResourceCreate {
     tags?: TagRel$3[] | null;
 }
 interface ShipmentUpdate extends ResourceUpdate {
+    /**
+     * Unique identifier for the shipment..
+     * @example ```"#1234/S/001"```
+     */
+    number?: string | null;
     /**
      * Send this attribute if you want to mark this shipment as upcoming..
      * @example ```"true"```
@@ -10111,6 +10127,11 @@ interface ShipmentUpdate extends ResourceUpdate {
      * @example ```"true"```
      */
     _ship?: boolean | null;
+    /**
+     * Send this attribute if you want to mark this shipment as delivered..
+     * @example ```"true"```
+     */
+    _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..
      * @example ```"true"```
@@ -10176,6 +10197,7 @@ declare class Shipments extends ApiResource<Shipment> {
     _packing(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
     _ready_to_ship(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
     _ship(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
+    _deliver(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
     _reserve_stock(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
     _release_stock(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
     _decrement_stock(id: string | Shipment, params?: QueryParamsRetrieve<Shipment>, options?: ResourcesConfig): Promise<Shipment>;
@@ -10245,6 +10267,11 @@ interface StockTransfer extends Resource {
     versions?: Version[] | null;
 }
 interface StockTransferCreate extends ResourceCreate {
+    /**
+     * Unique identifier for the stock transfer (numeric)..
+     * @example ```"1234"```
+     */
+    number?: string | null;
     /**
      * The code of the associated SKU..
      * @example ```"TSHIRTMM000000FFFFFFXLXX"```
@@ -10262,6 +10289,11 @@ interface StockTransferCreate extends ResourceCreate {
     line_item?: LineItemRel | null;
 }
 interface StockTransferUpdate extends ResourceUpdate {
+    /**
+     * Unique identifier for the stock transfer (numeric)..
+     * @example ```"1234"```
+     */
+    number?: string | null;
     /**
      * The code of the associated SKU..
      * @example ```"TSHIRTMM000000FFFFFFXLXX"```
@@ -15000,7 +15032,7 @@ type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
 type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
 declare class CommerceLayerClient {
     #private;
-    readonly openApiSchemaVersion = "5.3.1";
+    readonly openApiSchemaVersion = "5.3.3";
     constructor(config: CommerceLayerInitConfig);
     get addresses(): Addresses;
     get adjustments(): Adjustments;