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(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<{}>} */ 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(orderRef: string): Promise<{}>; /** * * @param {number} params.limit - Page size (default 50, max 200). * @param {number} params.offset - Row offset for pagination (default 0). * @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} */ inventoriesLocationsList(params?: { limit?: number; offset?: number; order?: string; }): Promise<{}>; /** * * @param {number} limit - Page size (default 50, max 200). * @param {number} offset - Row offset for pagination (default 0). * @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ inventoriesLocationsList(limit?: number, offset?: number, order?: string): 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} */ inventoriesLocationsCreate(params: { code: string; name: string; address?: object; enabled?: boolean; labels?: object; metadata?: object; priority?: number; type?: LocationType; }): Promise; /** * * @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} * @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; /** * * @throws {RevenexxException} * @returns {Promise<{}>} */ inventoriesLocationsDefaults(): Promise<{}>; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise<{}>} */ inventoriesLocationsDelete(params: { id: string; }): Promise<{}>; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ inventoriesLocationsDelete(id: string): Promise<{}>; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise} */ inventoriesLocationsGet(params: { id: string; }): Promise; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ inventoriesLocationsGet(id: string): Promise; /** * * @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} */ inventoriesLocationsUpdate(params: { id: string; address?: object; code?: string; enabled?: boolean; labels?: object; metadata?: object; name?: string; priority?: number; type?: LocationType; }): Promise; /** * * @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} * @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; /** * * @param {number} params.limit - Page size (default 50, max 200). * @param {number} params.offset - Row offset for pagination (default 0). * @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} */ inventoriesMovementsList(params?: { limit?: number; offset?: number; order?: string; }): Promise<{}>; /** * * @param {number} limit - Page size (default 50, max 200). * @param {number} offset - Row offset for pagination (default 0). * @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ inventoriesMovementsList(limit?: number, offset?: number, order?: string): Promise<{}>; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise} */ inventoriesMovementsGet(params: { id: string; }): Promise; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ inventoriesMovementsGet(id: string): Promise; /** * * @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(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. */ 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<{}>; /** * * @param {number} params.limit - Page size (default 50, max 200). * @param {number} params.offset - Row offset for pagination (default 0). * @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} */ inventoriesReservationsList(params?: { limit?: number; offset?: number; order?: string; }): Promise<{}>; /** * * @param {number} limit - Page size (default 50, max 200). * @param {number} offset - Row offset for pagination (default 0). * @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ inventoriesReservationsList(limit?: number, offset?: number, order?: string): Promise<{}>; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise} */ inventoriesReservationsGet(params: { id: string; }): Promise; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ inventoriesReservationsGet(id: string): Promise; /** * * @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(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. */ 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<{}>; /** * * @param {number} params.limit - Page size (default 50, max 200). * @param {number} params.offset - Row offset for pagination (default 0). * @param {string} params.order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} */ inventoriesStockList(params?: { limit?: number; offset?: number; order?: string; }): Promise<{}>; /** * * @param {number} limit - Page size (default 50, max 200). * @param {number} offset - Row offset for pagination (default 0). * @param {string} order - Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ inventoriesStockList(limit?: number, offset?: number, order?: string): 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} */ inventoriesStockCreate(params: { locationId: string; metadata?: object; onHand?: number; productId?: string; reorderPoint?: number; reserved?: number; sku?: string; }): Promise; /** * * @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} * @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; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise<{}>} */ inventoriesStockDelete(params: { id: string; }): Promise<{}>; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise<{}>} * @deprecated Use the object parameter style method for a better developer experience. */ inventoriesStockDelete(id: string): Promise<{}>; /** * * @param {string} params.id - * @throws {RevenexxException} * @returns {Promise} */ inventoriesStockGet(params: { id: string; }): Promise; /** * * @param {string} id - * @throws {RevenexxException} * @returns {Promise} * @deprecated Use the object parameter style method for a better developer experience. */ inventoriesStockGet(id: string): Promise; /** * * @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} */ inventoriesStockUpdate(params: { id: string; locationId?: string; metadata?: object; onHand?: number; productId?: string; reorderPoint?: number; reserved?: number; sku?: string; }): Promise; /** * * @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} * @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; }