UNPKG

@simpleapps-com/augur-api

Version:

TypeScript client library for Augur microservices API endpoints

158 lines 5.22 kB
import { z } from 'zod'; import { BaseResponseSchema } from '../../core/schemas'; // P21 APIs Parameter Schemas /** * Entity contacts refresh parameters - trigger data refresh */ export const EntityContactsRefreshParamsSchema = z.object({}); /** * Entity customers refresh parameters - trigger data refresh */ export const EntityCustomersRefreshParamsSchema = z.object({}); /** * Health check parameters */ export const HealthCheckParamsSchema = z.object({}); /** * Transaction category parameters for CRUD operations */ export const TransCategoryParamsSchema = z.object({ categoryUid: z.number().describe('Category UID'), categoryId: z.string().optional().describe('Category ID'), }); /** * Transaction category create parameters */ export const TransCategoryCreateParamsSchema = z.object({}); /** * Transaction company parameters for CRUD operations */ export const TransCompanyParamsSchema = z.object({ companyUid: z.number().describe('Company UID'), companyId: z.string().optional().describe('Company ID'), }); /** * Transaction company create parameters */ export const TransCompanyCreateParamsSchema = z.object({}); /** * Transaction purchase order receipt parameters */ export const TransPurchaseOrderReceiptParamsSchema = z.object({ poNo: z.string().describe('Purchase Order Number'), }); /** * Transaction user parameters for CRUD operations */ export const TransUserParamsSchema = z.object({ usersUid: z.number().describe('User UID'), userId: z.string().optional().describe('User ID'), }); /** * Transaction user create parameters */ export const TransUserCreateParamsSchema = z.object({}); /** * Transaction web display type parameters for CRUD operations */ export const TransWebDisplayTypeParamsSchema = z.object({ webDisplayTypeUid: z.number().describe('Web Display Type UID'), webDisplayTypeId: z.string().optional().describe('Web Display Type ID'), }); /** * Transaction web display type create parameters */ export const TransWebDisplayTypeCreateParamsSchema = z.object({}); /** * Transaction web display type defaults parameters */ export const TransWebDisplayTypeDefaultsParamsSchema = z.object({}); /** * Transaction web display type definition parameters */ export const TransWebDisplayTypeDefinitionParamsSchema = z.object({}); // Data Schemas (flexible for API responses without schemas) /** * Health check response data */ export const HealthCheckDataSchema = z.unknown().describe('Health check status information'); /** * Entity refresh response data */ export const EntityRefreshDataSchema = z.unknown().describe('Entity refresh operation result'); /** * Transaction category data */ export const TransCategoryDataSchema = z.unknown().describe('Transaction category information'); /** * Transaction company data */ export const TransCompanyDataSchema = z.unknown().describe('Transaction company information'); /** * Transaction purchase order receipt data */ export const TransPurchaseOrderReceiptDataSchema = z .unknown() .describe('Purchase order receipt information'); /** * Transaction user data */ export const TransUserDataSchema = z.unknown().describe('Transaction user information'); /** * Transaction web display type data */ export const TransWebDisplayTypeDataSchema = z.unknown().describe('Web display type information'); /** * Transaction web display type defaults data */ export const TransWebDisplayTypeDefaultsDataSchema = z .unknown() .describe('Web display type default values'); /** * Transaction web display type definition data */ export const TransWebDisplayTypeDefinitionDataSchema = z .unknown() .describe('Web display type service definition'); // Response Schemas using BaseResponseSchema /** * Health check response */ export const HealthCheckResponseSchema = BaseResponseSchema(HealthCheckDataSchema); /** * Entity contacts refresh response */ export const EntityContactsRefreshResponseSchema = BaseResponseSchema(EntityRefreshDataSchema); /** * Entity customers refresh response */ export const EntityCustomersRefreshResponseSchema = BaseResponseSchema(EntityRefreshDataSchema); /** * Transaction category response */ export const TransCategoryResponseSchema = BaseResponseSchema(TransCategoryDataSchema); /** * Transaction company response */ export const TransCompanyResponseSchema = BaseResponseSchema(TransCompanyDataSchema); /** * Transaction purchase order receipt response */ export const TransPurchaseOrderReceiptResponseSchema = BaseResponseSchema(TransPurchaseOrderReceiptDataSchema); /** * Transaction user response */ export const TransUserResponseSchema = BaseResponseSchema(TransUserDataSchema); /** * Transaction web display type response */ export const TransWebDisplayTypeResponseSchema = BaseResponseSchema(TransWebDisplayTypeDataSchema); /** * Transaction web display type defaults response */ export const TransWebDisplayTypeDefaultsResponseSchema = BaseResponseSchema(TransWebDisplayTypeDefaultsDataSchema); /** * Transaction web display type definition response */ export const TransWebDisplayTypeDefinitionResponseSchema = BaseResponseSchema(TransWebDisplayTypeDefinitionDataSchema); //# sourceMappingURL=schemas.js.map