@simpleapps-com/augur-api/dist/cjs/services/items/resources/item-uom.d.ts

TypeScript client library for Augur microservices API endpoints

import { ItemUomListParams } from '../schemas';
import type { ItemsClient } from '../client';
type ExecuteRequest = ItemsClient['executeRequest'];
/**
 * Creates the itemUom resource methods
 * OpenAPI Path: /item-uom → itemUom.*
 * @description Methods for managing item units of measure (UOM)
 */
export declare function createItemUomResource(executeRequest: ExecuteRequest): {
    /**
     * List item units of measure
     * @description Retrieve a paginated list of item UOMs with filtering options
     * @fullPath api.items.itemUom.list
     * @service items
     * @domain inventory-management
     * @discoverable true
     * @dataMethod itemUomData.list
     * @searchTerms ["uom", "unit", "measure", "items", "inventory"]
     * @relatedEndpoints ["invMast.list", "attributes.list", "categories.list"]
     * @commonPatterns ["Get item units of measure", "List UOMs for items", "Filter UOMs by item"]
     * @workflow ["inventory-management", "product-configuration"]
     * @prerequisites ["Bearer token", "x-site-id header"]
     * @nextSteps ["Use UOM data for pricing calculations", "Configure item units"]
     * @businessRules ["Returns paginated results", "Supports filtering by item and unit of measure"]
     * @functionalArea "inventory-management"
     * @crossSite true
     * @caching "5 minutes - UOM data changes infrequently"
     * @performance "Fast - indexed lookup operation"
     */
    list: (params?: ItemUomListParams) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: import("zod").objectInputType<{
            itemUomUid: import("zod").ZodNumber;
        }, import("zod").ZodTypeAny, "passthrough">[];
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Get item unit of measure details
     * @description Retrieve specific item UOM details by ID
     * @fullPath api.items.itemUom.get
     * @service items
     * @domain inventory-management
     * @discoverable true
     * @dataMethod itemUomData.get
     * @searchTerms ["uom", "unit", "measure", "details", "specific"]
     * @relatedEndpoints ["itemUom.list", "invMast.get", "attributes.get"]
     * @commonPatterns ["Get UOM details by ID", "Retrieve unit of measure information"]
     * @workflow ["inventory-management", "product-configuration"]
     * @prerequisites ["Valid itemUomUid", "Bearer token", "x-site-id header"]
     * @nextSteps ["Use UOM details for calculations", "Update item configurations"]
     * @businessRules ["Returns single UOM record", "Must provide valid itemUomUid"]
     * @functionalArea "inventory-management"
     * @crossSite true
     * @caching "5 minutes - UOM data changes infrequently"
     * @performance "Very fast - direct ID lookup"
     */
    get: (itemUomUid: number) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            itemUomUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
};
/**
 * Creates the itemUomData resource methods (data-only versions)
 */
export declare function createItemUomDataResource(itemUom: ReturnType<typeof createItemUomResource>): {
    list: (params?: ItemUomListParams) => Promise<import("zod").objectInputType<{
        itemUomUid: import("zod").ZodNumber;
    }, import("zod").ZodTypeAny, "passthrough">[]>;
    get: (itemUomUid: number) => Promise<{
        itemUomUid: number;
    } & {
        [k: string]: unknown;
    }>;
};
export type ItemUomResource = ReturnType<typeof createItemUomResource>;
export type ItemUomDataResource = ReturnType<typeof createItemUomDataResource>;
export {};
//# sourceMappingURL=item-uom.d.ts.map