@revenexx/node 0.0.1 → 0.0.2

package/dist/services/inventories.d.mts

@@ -0,0 +1,511 @@
+import { Client } from '../client.mjs';
+import { Models } from '../models.mjs';
+import { LocationType } from '../enums/location-type.mjs';
+import '../query.mjs';
+import '../enums/address-type.mjs';
+import '../enums/cart-export-format.mjs';
+import '../enums/cart-item-type.mjs';
+import '../enums/channel-status.mjs';
+import '../enums/channel-type.mjs';
+import '../enums/contact-role.mjs';
+import '../enums/contact-status.mjs';
+import '../enums/cart-io-apply-mode.mjs';
+import '../enums/cart-io-direction.mjs';
+import '../enums/cart-io-entity.mjs';
+import '../enums/cart-io-format.mjs';
+import '../enums/market-status.mjs';
+import '../enums/order-comment-visibility.mjs';
+import '../enums/order-item-type.mjs';
+import '../enums/order-list-kind.mjs';
+import '../enums/order-payment-status.mjs';
+import '../enums/organization-status.mjs';
+import '../enums/page-status.mjs';
+import '../enums/payment-fee-type.mjs';
+import '../enums/payment-method-kind.mjs';
+import '../enums/price-entry-type.mjs';
+import '../enums/price-list-status.mjs';
+import '../enums/shipping-method-matrix-basis.mjs';
+import '../enums/shipping-method-pricing-type.mjs';
+import '../enums/store-asset-request-visibility.mjs';
+import '../enums/attribute-boolean-status.mjs';
+import '../enums/attribute-datetime-status.mjs';
+import '../enums/attribute-email-status.mjs';
+import '../enums/attribute-enum-status.mjs';
+import '../enums/attribute-float-status.mjs';
+import '../enums/attribute-integer-status.mjs';
+import '../enums/attribute-ip-status.mjs';
+import '../enums/attribute-line-status.mjs';
+import '../enums/attribute-longtext-status.mjs';
+import '../enums/attribute-mediumtext-status.mjs';
+import '../enums/attribute-point-status.mjs';
+import '../enums/attribute-polygon-status.mjs';
+import '../enums/attribute-relationship-status.mjs';
+import '../enums/attribute-string-status.mjs';
+import '../enums/attribute-text-status.mjs';
+import '../enums/attribute-url-status.mjs';
+import '../enums/attribute-varchar-status.mjs';
+import '../enums/column-boolean-status.mjs';
+import '../enums/column-datetime-status.mjs';
+import '../enums/column-email-status.mjs';
+import '../enums/column-enum-status.mjs';
+import '../enums/column-float-status.mjs';
+import '../enums/column-integer-status.mjs';
+import '../enums/column-ip-status.mjs';
+import '../enums/column-line-status.mjs';
+import '../enums/column-longtext-status.mjs';
+import '../enums/column-mediumtext-status.mjs';
+import '../enums/column-point-status.mjs';
+import '../enums/column-polygon-status.mjs';
+import '../enums/column-relationship-status.mjs';
+import '../enums/column-string-status.mjs';
+import '../enums/column-text-status.mjs';
+import '../enums/column-url-status.mjs';
+import '../enums/column-varchar-status.mjs';
+import '../enums/database-type.mjs';
+import '../enums/deployment-status.mjs';
+import '../enums/execution-status.mjs';
+import '../enums/execution-trigger.mjs';
+import '../enums/health-antivirus-status.mjs';
+import '../enums/health-status-status.mjs';
+import '../enums/index-status.mjs';
+import '../enums/message-status.mjs';
+
+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 {RevenexxAPIRevenexxException}
+     * @returns {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 {RevenexxAPIRevenexxException}
+     * @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 {RevenexxAPIRevenexxException}
+     * @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 {RevenexxAPIRevenexxException}
+     * @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 {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesCommit(params: {
+        orderRef: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} orderRef - The order whose active reservations are committed (shipment).
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesCommit(orderRef: string): Promise<{}>;
+    /**
+     *
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    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 {RevenexxAPIRevenexxException}
+     * @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 {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Location>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesLocationsCreate(code: string, name: string, address?: object, enabled?: boolean, labels?: object, metadata?: object, priority?: number, type?: LocationType): Promise<Models.Location>;
+    /**
+     *
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesLocationsDefaults(): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesLocationsDelete(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesLocationsDelete(id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Location>}
+     */
+    inventoriesLocationsGet(params: {
+        id: string;
+    }): Promise<Models.Location>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Location>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesLocationsGet(id: string): Promise<Models.Location>;
+    /**
+     *
+     * @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 {RevenexxAPIRevenexxException}
+     * @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 {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Location>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesLocationsUpdate(id: string, address?: object, code?: string, enabled?: boolean, labels?: object, metadata?: object, name?: string, priority?: number, type?: LocationType): Promise<Models.Location>;
+    /**
+     *
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesMovementsList(): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.StockMovement>}
+     */
+    inventoriesMovementsGet(params: {
+        id: string;
+    }): Promise<Models.StockMovement>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.StockMovement>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    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 {RevenexxAPIRevenexxException}
+     * @returns {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 {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesReceive(items: Models.InventoryStockItem[], locationCode?: string, reason?: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.orderRef - The order whose active reservations are released.
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesRelease(params: {
+        orderRef: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} orderRef - The order whose active reservations are released.
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesRelease(orderRef: string): Promise<{}>;
+    /**
+     *
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesReservationsList(): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Reservation>}
+     */
+    inventoriesReservationsGet(params: {
+        id: string;
+    }): Promise<Models.Reservation>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.Reservation>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    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 {RevenexxAPIRevenexxException}
+     * @returns {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 {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    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 {RevenexxAPIRevenexxException}
+     * @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 {RevenexxAPIRevenexxException}
+     * @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 {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    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 {RevenexxAPIRevenexxException}
+     * @returns {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 {RevenexxAPIRevenexxException}
+     * @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 -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     */
+    inventoriesStockDelete(params: {
+        id: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesStockDelete(id: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.StockLevel>}
+     */
+    inventoriesStockGet(params: {
+        id: string;
+    }): Promise<Models.StockLevel>;
+    /**
+     *
+     * @param {string} id -
+     * @throws {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.StockLevel>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesStockGet(id: string): Promise<Models.StockLevel>;
+    /**
+     *
+     * @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 {RevenexxAPIRevenexxException}
+     * @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 {RevenexxAPIRevenexxException}
+     * @returns {Promise<Models.StockLevel>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    inventoriesStockUpdate(id: string, locationId?: string, metadata?: object, onHand?: number, productId?: string, reorderPoint?: number, reserved?: number, sku?: string): Promise<Models.StockLevel>;
+}
+
+export { Inventories };