@simpleapps-com/augur-api/dist/cjs/services/items/resources/inv-loc.d.ts

TypeScript client library for Augur microservices API endpoints

import { type InvLocListParams, type InvLocListResponse } from '../schemas';
import type { ItemsClient } from '../client';
type ExecuteRequest = ItemsClient['executeRequest'];
/**
 * Creates the invLoc resource methods
 * OpenAPI Path: /inv-loc → invLoc.*
 * @description Inventory Location endpoints
 */
export declare function createInvLocResource(executeRequest: ExecuteRequest): {
    /**
     * List inventory locations
     * @description Retrieve a paginated list of inventory location records
     * @fullPath api.items.invLoc.list
     * @service items
     * @domain inventory-management
     * @dataMethod invLocData.list
     * @discoverable true
     * @searchTerms ["inventory locations", "inv loc", "stock locations", "warehouse locations"]
     * @relatedEndpoints ["api.items.invMast.list", "api.items.locations.bins.list"]
     * @commonPatterns ["List inventory by location", "Filter by invMastUid", "Pagination"]
     * @workflow ["inventory-management", "stock-tracking"]
     * @prerequisites ["Valid authentication", "Bearer token", "x-site-id header"]
     * @nextSteps ["Use invMastUid for item details", "Check stock levels"]
     * @businessRules ["Returns array of inv_loc records", "Supports filtering by invMastUid", "Supports pagination"]
     * @functionalArea "inventory-management"
     * @caching "Variable TTL based on cacheTtl parameter"
     * @performance "Good - supports filtering and pagination"
     *
     * @param params Optional filtering and pagination parameters
     * @returns Promise<InvLocListResponse> Complete response with inventory locations array
     */
    list: (params?: InvLocListParams) => Promise<InvLocListResponse>;
};
/**
 * Creates the invLocData resource methods (data-only versions)
 */
export declare function createInvLocDataResource(invLoc: ReturnType<typeof createInvLocResource>): {
    list: (params?: InvLocListParams) => Promise<import("zod").objectOutputType<{
        companyId: import("zod").ZodOptional<import("zod").ZodString>;
        locationId: import("zod").ZodOptional<import("zod").ZodNumber>;
        invMastUid: import("zod").ZodOptional<import("zod").ZodNumber>;
        qtyOnHand: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
        qtyInProcess: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
        dateCreated: import("zod").ZodOptional<import("zod").ZodString>;
        dateLastModified: import("zod").ZodOptional<import("zod").ZodString>;
    }, import("zod").ZodTypeAny, "passthrough">[]>;
};
export type InvLocResource = ReturnType<typeof createInvLocResource>;
export type InvLocDataResource = ReturnType<typeof createInvLocDataResource>;
export {};
//# sourceMappingURL=inv-loc.d.ts.map