@managemint-solutions/sdk 0.66.0 → 0.67.0

package/dist/inventory/dto.d.ts

@@ -0,0 +1,134 @@
+import type { UUID } from 'crypto';
+import type { CountInventoryDto as CountInventoryDtoType, CreateInventoryItemDto as CreateInventoryItemDtoType, CreateInventoryLocationDto as CreateInventoryLocationDtoType, CreateInventoryMovementDto as CreateInventoryMovementDtoType, CreateInventoryTransferDto as CreateInventoryTransferDtoType, CreateInventoryTransferLineDto as CreateInventoryTransferLineDtoType, GetInventoryItemsDto as GetInventoryItemsDtoType, GeocodeAddressDto as GeocodeAddressDtoType, GetInventoryLocationsDto as GetInventoryLocationsDtoType, GetInventoryMovementsDto as GetInventoryMovementsDtoType, GetInventoryStocktakesDto as GetInventoryStocktakesDtoType, GetInventoryTransfersDto as GetInventoryTransfersDtoType, ImportInventoryItemDto as ImportInventoryItemDtoType, ImportInventoryItemsDto as ImportInventoryItemsDtoType, InventoryItemFieldsDto as InventoryItemFieldsDtoType, InventoryItemIdDto as InventoryItemIdDtoType, InventoryLevelKeyDto as InventoryLevelKeyDtoType, InventoryLocationIdDto as InventoryLocationIdDtoType, InventoryStocktakeIdDto as InventoryStocktakeIdDtoType, InventoryTransferIdDto as InventoryTransferIdDtoType, ReceiveInventoryTransferDto as ReceiveInventoryTransferDtoType, SuggestAddressesDto as SuggestAddressesDtoType, StaffGetInventoryItemsDto as StaffGetInventoryItemsDtoType, UpdateInventoryItemDto as UpdateInventoryItemDtoType, UpdateInventoryLevelDto as UpdateInventoryLevelDtoType, UpdateInventoryLocationDto as UpdateInventoryLocationDtoType, UpdateInventoryTransferDto as UpdateInventoryTransferDtoType } from '@managemint-solutions/entities/inventory/dto';
+import { InventoryLocationKind, InventoryMovementType, InventoryTransferStatus } from '@managemint-solutions/entities/inventory/enum';
+export declare class GetInventoryLocationsDto implements GetInventoryLocationsDtoType {
+    readonly archive: boolean;
+}
+export declare class InventoryLocationIdDto implements InventoryLocationIdDtoType {
+    readonly locationId: string;
+}
+export declare class CreateInventoryLocationDto implements CreateInventoryLocationDtoType {
+    readonly name: string;
+    readonly kind: InventoryLocationKind;
+    readonly address?: string | null;
+    readonly latitude?: number | null;
+    readonly longitude?: number | null;
+    readonly is_default?: boolean;
+}
+export declare class UpdateInventoryLocationDto extends CreateInventoryLocationDto implements UpdateInventoryLocationDtoType {
+}
+export declare class GeocodeAddressDto implements GeocodeAddressDtoType {
+    readonly address?: string | null;
+    readonly place_id?: string | null;
+}
+export declare class SuggestAddressesDto implements SuggestAddressesDtoType {
+    readonly query: string;
+}
+export declare class GetInventoryItemsDto implements GetInventoryItemsDtoType {
+    readonly search?: string | null;
+    readonly page: number;
+    readonly page_size: number;
+    readonly archive: boolean;
+    readonly group_name?: string | null;
+    readonly location_id?: string | null;
+    readonly below_reorder?: boolean | null;
+}
+/** A staff read across organizations, optionally narrowed to one of them. */
+export declare class StaffGetInventoryItemsDto extends GetInventoryItemsDto implements StaffGetInventoryItemsDtoType {
+    readonly organization_id?: string | null;
+}
+export declare class InventoryItemIdDto implements InventoryItemIdDtoType {
+    readonly itemId: string;
+}
+export declare class InventoryItemFieldsDto implements InventoryItemFieldsDtoType {
+    readonly name: string;
+    readonly sku?: string | null;
+    readonly description?: string | null;
+    readonly group_name?: string | null;
+    readonly cost_minor?: number | null;
+    readonly price_minor?: number | null;
+    readonly track_stock?: boolean;
+}
+/** A new item with what is already on the shelf: the opening quantity lands at the named location, or the default one. */
+export declare class CreateInventoryItemDto extends InventoryItemFieldsDto implements CreateInventoryItemDtoType {
+    readonly opening_quantity?: number | null;
+    readonly location_id?: string | null;
+}
+export declare class UpdateInventoryItemDto extends InventoryItemFieldsDto implements UpdateInventoryItemDtoType {
+}
+/** One CSV row: the item plus an optional opening quantity at a named location. */
+export declare class ImportInventoryItemDto extends InventoryItemFieldsDto implements ImportInventoryItemDtoType {
+    readonly opening_quantity?: number | null;
+    readonly location_name?: string | null;
+}
+export declare class ImportInventoryItemsDto implements ImportInventoryItemsDtoType {
+    readonly items: ImportInventoryItemDto[];
+}
+export declare class InventoryLevelKeyDto implements InventoryLevelKeyDtoType {
+    readonly itemId: string;
+    readonly locationId: string;
+}
+export declare class UpdateInventoryLevelDto implements UpdateInventoryLevelDtoType {
+    readonly reorder_point: number | null;
+    readonly reorder_quantity: number | null;
+    readonly bin?: string | null;
+}
+export declare class GetInventoryMovementsDto implements GetInventoryMovementsDtoType {
+    readonly page: number;
+    readonly page_size: number;
+    readonly item_id?: string | null;
+    readonly location_id?: string | null;
+    readonly type?: InventoryMovementType | null;
+}
+export declare class CreateInventoryMovementDto implements CreateInventoryMovementDtoType {
+    readonly item_id: UUID;
+    readonly location_id: UUID;
+    readonly type: InventoryMovementType;
+    readonly quantity: number;
+    readonly unit_cost_minor?: number | null;
+    readonly reason?: string | null;
+    readonly supplier?: string | null;
+    readonly supplier_reference?: string | null;
+    readonly notes?: string | null;
+}
+export declare class CountInventoryLineDto {
+    readonly item_id: UUID;
+    readonly counted: number;
+    readonly reason?: string | null;
+}
+export declare class CountInventoryDto implements CountInventoryDtoType {
+    readonly lines: CountInventoryLineDto[];
+    readonly notes?: string | null;
+}
+export declare class GetInventoryStocktakesDto implements GetInventoryStocktakesDtoType {
+    readonly page: number;
+    readonly page_size: number;
+    readonly location_id?: string | null;
+}
+export declare class InventoryStocktakeIdDto implements InventoryStocktakeIdDtoType {
+    readonly stocktakeId: string;
+}
+export declare class GetInventoryTransfersDto implements GetInventoryTransfersDtoType {
+    readonly page: number;
+    readonly page_size: number;
+    readonly status?: InventoryTransferStatus | null;
+    readonly location_id?: string | null;
+}
+export declare class InventoryTransferIdDto implements InventoryTransferIdDtoType {
+    readonly transferId: string;
+}
+export declare class CreateInventoryTransferLineDto implements CreateInventoryTransferLineDtoType {
+    readonly item_id: UUID;
+    readonly quantity: number;
+}
+export declare class CreateInventoryTransferDto implements CreateInventoryTransferDtoType {
+    readonly from_location_id: UUID;
+    readonly to_location_id: UUID;
+    readonly lines: CreateInventoryTransferLineDto[];
+    readonly notes?: string | null;
+}
+export declare class UpdateInventoryTransferDto extends CreateInventoryTransferDto implements UpdateInventoryTransferDtoType {
+}
+export declare class ReceiveInventoryTransferDto implements ReceiveInventoryTransferDtoType {
+    readonly lines?: CreateInventoryTransferLineDto[] | null;
+}