@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
38 lines • 1.62 kB
JavaScript
import { z } from 'zod';
import { BaseResponseSchema } from '../../../core/schemas';
/**
* Schema for contracts items GET request parameters
* OpenAPI Path: /contracts/{jobNo}/items
*/
export const ContractsItemsParamsSchema = z.object({
jobNo: z.number().describe('Job number'),
classId5ExcludeList: z
.string()
.optional()
.describe('List of excluded class 5 values (default:blank)'),
classId5List: z.string().optional().describe('List of allowed class 5 values (default:blank)'),
displayOnWebFlag: z
.string()
.optional()
.describe('Display on web flag [Y|N|Blank] (Default: Blank)'),
fields: z
.string()
.optional()
.describe('fields to filter with (Default: itemId, itemDesc, ExtendedDesc)'),
filters: z
.string()
.optional()
.describe('A JSON representation of the filters [{attributeUid:attributeValueUid}]'),
includeStock: z.string().optional().describe('Include Stock [Y|N] (Default: N)'),
limit: z.number().int().optional().describe('Limit number of results (Default: 12)'),
offset: z.number().int().optional().describe('Starting offset results (Default: 0)'),
q: z.string().describe('search query'),
sortBy: z.string().optional().describe('Field from Document to sort by (Default: item_id)'),
tags: z.string().optional().describe('A CSV of tags'),
});
/**
* Schema for contracts items response
* OpenAPI Path: /contracts/{jobNo}/items
*/
export const ContractsItemsResponseSchema = BaseResponseSchema(z.unknown());
//# sourceMappingURL=contractsItems.js.map