@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
59 lines • 2.93 kB
TypeScript
import { type P21InvMastListParams, type P21InvMastListResponse } from '../schemas';
import type { ItemsClient } from '../client';
type ExecuteRequest = ItemsClient['executeRequest'];
/**
* Creates the p21 resource methods
* OpenAPI Path: /p21 → p21.*
* @description Prophet 21 (P21) raw data endpoints
*/
export declare function createP21Resource(executeRequest: ExecuteRequest): {
/**
* OpenAPI Path: /p21/inv-mast → p21.invMast.*
* @description Nested path for P21 raw inventory master data
*/
invMast: {
/**
* List raw P21 inventory master data
* @description Retrieve a paginated list of raw P21 inv_mast records
* @fullPath api.items.p21.invMast.list
* @service items
* @domain inventory-management
* @dataMethod p21Data.invMast.list
* @discoverable true
* @searchTerms ["p21 inventory", "raw inv_mast", "prophet 21", "p21 data"]
* @relatedEndpoints ["api.items.invMast.list"]
* @commonPatterns ["List raw P21 data", "Filter by status", "Sync operations"]
* @workflow ["data-sync", "inventory-management"]
* @prerequisites ["Valid authentication", "Bearer token", "x-site-id header"]
* @nextSteps ["Process raw data", "Sync to external systems"]
* @businessRules ["Returns raw P21 inv_mast 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<P21InvMastListResponse> Complete response with P21 inventory data array
*/
list: (params?: P21InvMastListParams) => Promise<P21InvMastListResponse>;
};
};
/**
* Creates the p21Data resource methods (data-only versions)
*/
export declare function createP21DataResource(p21: ReturnType<typeof createP21Resource>): {
invMast: {
list: (params?: P21InvMastListParams) => Promise<import("zod").objectOutputType<{
invMastUid: import("zod").ZodOptional<import("zod").ZodNumber>;
itemId: import("zod").ZodOptional<import("zod").ZodString>;
itemDesc: import("zod").ZodOptional<import("zod").ZodString>;
statusCd: import("zod").ZodOptional<import("zod").ZodNumber>;
onlineCd: 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 P21Resource = ReturnType<typeof createP21Resource>;
export type P21DataResource = ReturnType<typeof createP21DataResource>;
export {};
//# sourceMappingURL=p21.d.ts.map