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

TypeScript client library for Augur microservices API endpoints

import { type InvMastUdListParams, type InvMastUdListResponse } from '../schemas';
import type { ItemsClient } from '../client';
type ExecuteRequest = ItemsClient['executeRequest'];
/**
 * Creates the invMastUd resource methods
 * OpenAPI Path: /inv-mast-ud → invMastUd.*
 * @description Inventory Master User-Defined fields endpoints
 */
export declare function createInvMastUdResource(executeRequest: ExecuteRequest): {
    /**
     * List inventory master user-defined records
     * @description Retrieve a paginated list of inv_mast_ud records with filtering
     * @fullPath api.items.invMastUd.list
     * @service items
     * @domain inventory-management
     * @dataMethod invMastUdData.list
     * @discoverable true
     * @searchTerms ["inv mast ud", "user defined", "custom fields", "inventory extensions"]
     * @relatedEndpoints ["api.items.invMast.list", "api.items.invMast.get"]
     * @commonPatterns ["List user-defined data", "Filter by invMastUid", "Date filtering"]
     * @workflow ["inventory-management", "custom-data"]
     * @prerequisites ["Valid authentication", "Bearer token", "x-site-id header"]
     * @nextSteps ["Link to invMast records", "Process custom fields"]
     * @businessRules ["Returns inv_mast_ud records", "Supports date filtering", "Supports status filtering"]
     * @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<InvMastUdListResponse> Complete response with user-defined records array
     */
    list: (params?: InvMastUdListParams) => Promise<InvMastUdListResponse>;
};
/**
 * Creates the invMastUdData resource methods (data-only versions)
 */
export declare function createInvMastUdDataResource(invMastUd: ReturnType<typeof createInvMastUdResource>): {
    list: (params?: InvMastUdListParams) => Promise<import("zod").objectOutputType<{
        invMastUdUid: import("zod").ZodOptional<import("zod").ZodNumber>;
        invMastUid: import("zod").ZodOptional<import("zod").ZodNumber>;
        statusCd: import("zod").ZodOptional<import("zod").ZodNumber>;
        dateCreated: import("zod").ZodOptional<import("zod").ZodString>;
        dateLastModified: import("zod").ZodOptional<import("zod").ZodString>;
    }, import("zod").ZodTypeAny, "passthrough">[]>;
};
export type InvMastUdResource = ReturnType<typeof createInvMastUdResource>;
export type InvMastUdDataResource = ReturnType<typeof createInvMastUdDataResource>;
export {};
//# sourceMappingURL=inv-mast-ud.d.ts.map