@revenexx/sdk 0.0.4 → 0.0.6

package/types/services/inventories.d.ts

@@ -1,26 +1,69 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { LocationType } from '../enums/location-type';
 export declare class Inventories {
     client: Client;
     constructor(client: Client);
     /**
      *
+     * @param {Models.InventoryAdjustItem[]} params.items - The corrections — quantities are SIGNED deltas (at most 200).
+     * @param {string} params.reason - Mandatory audit reason — every adjustment is a ledger row.
+     * @param {string} params.locationCode - Adjusted location (default 'main').
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
-    inventoriesAdjust(): Promise<{}>;
+    inventoriesAdjust(params: {
+        items: Models.InventoryAdjustItem[];
+        reason: string;
+        locationCode?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {Models.InventoryAdjustItem[]} items - The corrections — quantities are SIGNED deltas (at most 200).
+     * @param {string} reason - Mandatory audit reason — every adjustment is a ledger row.
+     * @param {string} locationCode - Adjusted location (default 'main').
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesAdjust(items: Models.InventoryAdjustItem[], reason: string, locationCode?: string): Promise<{}>;
+    /**
+     *
+     * @param {Models.InventoryAvailabilityItem[]} params.items - The items to check (batch, at most 200).
+     * @param {string} params.locationCode - Restrict the check to one location (default: all enabled locations).
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesAvailability(params: {
+        items: Models.InventoryAvailabilityItem[];
+        locationCode?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {Models.InventoryAvailabilityItem[]} items - The items to check (batch, at most 200).
+     * @param {string} locationCode - Restrict the check to one location (default: all enabled locations).
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesAvailability(items: Models.InventoryAvailabilityItem[], locationCode?: string): Promise<{}>;
     /**
      *
+     * @param {string} params.orderRef - The order whose active reservations are committed (shipment).
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
-    inventoriesAvailability(): Promise<{}>;
+    inventoriesCommit(params: {
+        orderRef: string;
+    }): Promise<{}>;
     /**
      *
+     * @param {string} orderRef - The order whose active reservations are committed (shipment).
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    inventoriesCommit(): Promise<{}>;
+    inventoriesCommit(orderRef: string): Promise<{}>;
     /**
      *
      * @throws {RevenexxException}
@@ -29,10 +72,42 @@ export declare class Inventories {
     inventoriesLocationsList(): Promise<{}>;
     /**
      *
+     * @param {string} params.code - Unique location code (per tenant).
+     * @param {string} params.name -
+     * @param {object} params.address -
+     * @param {boolean} params.enabled - Disabled locations are skipped by availability and reserve (default true).
+     * @param {object} params.labels - Localised display names ({de, en, …}).
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {number} params.priority - Sourcing order — lower wins (default 0).
+     * @param {LocationType} params.type - Default 'warehouse'.
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.Location>}
+     */
+    inventoriesLocationsCreate(params: {
+        code: string;
+        name: string;
+        address?: object;
+        enabled?: boolean;
+        labels?: object;
+        metadata?: object;
+        priority?: number;
+        type?: LocationType;
+    }): Promise<Models.Location>;
+    /**
+     *
+     * @param {string} code - Unique location code (per tenant).
+     * @param {string} name -
+     * @param {object} address -
+     * @param {boolean} enabled - Disabled locations are skipped by availability and reserve (default true).
+     * @param {object} labels - Localised display names ({de, en, …}).
+     * @param {object} metadata - Free-form metadata.
+     * @param {number} priority - Sourcing order — lower wins (default 0).
+     * @param {LocationType} type - Default 'warehouse'.
      * @throws {RevenexxException}
      * @returns {Promise<Models.Location>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    inventoriesLocationsCreate(): Promise<Models.Location>;
+    inventoriesLocationsCreate(code: string, name: string, address?: object, enabled?: boolean, labels?: object, metadata?: object, priority?: number, type?: LocationType): Promise<Models.Location>;
     /**
      *
      * @throws {RevenexxException}
@@ -76,20 +151,44 @@ export declare class Inventories {
     /**
      *
      * @param {string} params.id -
+     * @param {object} params.address -
+     * @param {string} params.code - Unique location code (per tenant).
+     * @param {boolean} params.enabled - Disabled locations are skipped by availability and reserve (default true).
+     * @param {object} params.labels - Localised display names ({de, en, …}).
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {string} params.name -
+     * @param {number} params.priority - Sourcing order — lower wins (default 0).
+     * @param {LocationType} params.type - Default 'warehouse'.
      * @throws {RevenexxException}
      * @returns {Promise<Models.Location>}
      */
     inventoriesLocationsUpdate(params: {
         id: string;
+        address?: object;
+        code?: string;
+        enabled?: boolean;
+        labels?: object;
+        metadata?: object;
+        name?: string;
+        priority?: number;
+        type?: LocationType;
     }): Promise<Models.Location>;
     /**
      *
      * @param {string} id -
+     * @param {object} address -
+     * @param {string} code - Unique location code (per tenant).
+     * @param {boolean} enabled - Disabled locations are skipped by availability and reserve (default true).
+     * @param {object} labels - Localised display names ({de, en, …}).
+     * @param {object} metadata - Free-form metadata.
+     * @param {string} name -
+     * @param {number} priority - Sourcing order — lower wins (default 0).
+     * @param {LocationType} type - Default 'warehouse'.
      * @throws {RevenexxException}
      * @returns {Promise<Models.Location>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    inventoriesLocationsUpdate(id: string): Promise<Models.Location>;
+    inventoriesLocationsUpdate(id: string, address?: object, code?: string, enabled?: boolean, labels?: object, metadata?: object, name?: string, priority?: number, type?: LocationType): Promise<Models.Location>;
     /**
      *
      * @throws {RevenexxException}
@@ -115,16 +214,44 @@ export declare class Inventories {
     inventoriesMovementsGet(id: string): Promise<Models.StockMovement>;
     /**
      *
+     * @param {Models.InventoryStockItem[]} params.items - The inbound items (at most 200).
+     * @param {string} params.locationCode - Receiving location (default 'main').
+     * @param {string} params.reason - Ledger note (e.g. delivery note number).
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
-    inventoriesReceive(): Promise<{}>;
+    inventoriesReceive(params: {
+        items: Models.InventoryStockItem[];
+        locationCode?: string;
+        reason?: string;
+    }): Promise<{}>;
     /**
      *
+     * @param {Models.InventoryStockItem[]} items - The inbound items (at most 200).
+     * @param {string} locationCode - Receiving location (default 'main').
+     * @param {string} reason - Ledger note (e.g. delivery note number).
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    inventoriesRelease(): Promise<{}>;
+    inventoriesReceive(items: Models.InventoryStockItem[], locationCode?: string, reason?: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.orderRef - The order whose active reservations are released.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesRelease(params: {
+        orderRef: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} orderRef - The order whose active reservations are released.
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesRelease(orderRef: string): Promise<{}>;
     /**
      *
      * @throws {RevenexxException}
@@ -150,16 +277,53 @@ export declare class Inventories {
     inventoriesReservationsGet(id: string): Promise<Models.Reservation>;
     /**
      *
+     * @param {Models.InventoryStockItem[]} params.items - The items to reserve — all-or-nothing (at most 200).
+     * @param {string} params.orderRef - The order this reservation belongs to.
+     * @param {string} params.expiresAt - Optional reservation expiry.
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
      */
-    inventoriesReserve(): Promise<{}>;
+    inventoriesReserve(params: {
+        items: Models.InventoryStockItem[];
+        orderRef: string;
+        expiresAt?: string;
+    }): Promise<{}>;
     /**
      *
+     * @param {Models.InventoryStockItem[]} items - The items to reserve — all-or-nothing (at most 200).
+     * @param {string} orderRef - The order this reservation belongs to.
+     * @param {string} expiresAt - Optional reservation expiry.
      * @throws {RevenexxException}
      * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
-    inventoriesRestock(): Promise<{}>;
+    inventoriesReserve(items: Models.InventoryStockItem[], orderRef: string, expiresAt?: string): Promise<{}>;
+    /**
+     *
+     * @param {Models.InventoryStockItem[]} params.items - The returned items (at most 200).
+     * @param {string} params.locationCode - Restocking location (default 'main').
+     * @param {string} params.orderRef - Originating order (ledger reference).
+     * @param {string} params.reason - Ledger note (e.g. return reason).
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesRestock(params: {
+        items: Models.InventoryStockItem[];
+        locationCode?: string;
+        orderRef?: string;
+        reason?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {Models.InventoryStockItem[]} items - The returned items (at most 200).
+     * @param {string} locationCode - Restocking location (default 'main').
+     * @param {string} orderRef - Originating order (ledger reference).
+     * @param {string} reason - Ledger note (e.g. return reason).
+     * @throws {RevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesRestock(items: Models.InventoryStockItem[], locationCode?: string, orderRef?: string, reason?: string): Promise<{}>;
     /**
      *
      * @throws {RevenexxException}
@@ -168,10 +332,39 @@ export declare class Inventories {
     inventoriesStockList(): Promise<{}>;
     /**
      *
+     * @param {string} params.locationId - Owning location.
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {number} params.onHand - Physical stock (default 0).
+     * @param {string} params.productId - Tracked product.
+     * @param {number} params.reorderPoint -
+     * @param {number} params.reserved - Reserved stock (default 0) — normally managed by reserve/release/commit.
+     * @param {string} params.sku - Tracked SKU (alternative to product_id).
      * @throws {RevenexxException}
      * @returns {Promise<Models.StockLevel>}
      */
-    inventoriesStockCreate(): Promise<Models.StockLevel>;
+    inventoriesStockCreate(params: {
+        locationId: string;
+        metadata?: object;
+        onHand?: number;
+        productId?: string;
+        reorderPoint?: number;
+        reserved?: number;
+        sku?: string;
+    }): Promise<Models.StockLevel>;
+    /**
+     *
+     * @param {string} locationId - Owning location.
+     * @param {object} metadata - Free-form metadata.
+     * @param {number} onHand - Physical stock (default 0).
+     * @param {string} productId - Tracked product.
+     * @param {number} reorderPoint -
+     * @param {number} reserved - Reserved stock (default 0) — normally managed by reserve/release/commit.
+     * @param {string} sku - Tracked SKU (alternative to product_id).
+     * @throws {RevenexxException}
+     * @returns {Promise<Models.StockLevel>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesStockCreate(locationId: string, metadata?: object, onHand?: number, productId?: string, reorderPoint?: number, reserved?: number, sku?: string): Promise<Models.StockLevel>;
     /**
      *
      * @param {string} params.id -
@@ -209,18 +402,39 @@ export declare class Inventories {
     /**
      *
      * @param {string} params.id -
+     * @param {string} params.locationId - Owning location.
+     * @param {object} params.metadata - Free-form metadata.
+     * @param {number} params.onHand - Physical stock (default 0).
+     * @param {string} params.productId - Tracked product.
+     * @param {number} params.reorderPoint -
+     * @param {number} params.reserved - Reserved stock (default 0) — normally managed by reserve/release/commit.
+     * @param {string} params.sku - Tracked SKU (alternative to product_id).
      * @throws {RevenexxException}
      * @returns {Promise<Models.StockLevel>}
      */
     inventoriesStockUpdate(params: {
         id: string;
+        locationId?: string;
+        metadata?: object;
+        onHand?: number;
+        productId?: string;
+        reorderPoint?: number;
+        reserved?: number;
+        sku?: string;
     }): Promise<Models.StockLevel>;
     /**
      *
      * @param {string} id -
+     * @param {string} locationId - Owning location.
+     * @param {object} metadata - Free-form metadata.
+     * @param {number} onHand - Physical stock (default 0).
+     * @param {string} productId - Tracked product.
+     * @param {number} reorderPoint -
+     * @param {number} reserved - Reserved stock (default 0) — normally managed by reserve/release/commit.
+     * @param {string} sku - Tracked SKU (alternative to product_id).
      * @throws {RevenexxException}
      * @returns {Promise<Models.StockLevel>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    inventoriesStockUpdate(id: string): Promise<Models.StockLevel>;
+    inventoriesStockUpdate(id: string, locationId?: string, metadata?: object, onHand?: number, productId?: string, reorderPoint?: number, reserved?: number, sku?: string): Promise<Models.StockLevel>;
 }