@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
132 lines • 4.67 kB
TypeScript
import { z } from 'zod';
/**
* Parameter schema for inventory master location bins list endpoint
* OpenAPI: /inv-mast/{invMastUid}/locations/{locationId}/bins GET
*/
export declare const InvMastLocationsBinsParamsSchema: z.ZodObject<{
limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
offset: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
excludeZero: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
limit: number;
offset: number;
excludeZero?: string | undefined;
}, {
limit?: number | undefined;
offset?: number | undefined;
excludeZero?: string | undefined;
}>;
/**
* Inventory location bin schema for nested path structure
* OpenAPI: /inv-mast/{invMastUid}/locations/{locationId}/bins
*
* Per OpenAPI specification, the response data is defined as:
* - "type": "array"
* - "items": { "type": "object" }
* - "description": "Array of objects (often DTOs)"
*
* The OpenAPI spec does NOT define specific object properties, only that
* data contains an array of generic objects. Following the OpenAPI spec exactly,
* we use z.record() to accept any object structure as the spec allows.
*/
export declare const InvMastLocationBinSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
/**
* Response schemas for inv-mast locations bins endpoints
*/
export declare const InvMastLocationBinResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
message: z.ZodString;
options: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
params: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
status: z.ZodNumber;
total: z.ZodNumber;
totalResults: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
params: Record<string, unknown> | unknown[];
data: Record<string, unknown>;
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: Record<string, unknown>;
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: Record<string, unknown>;
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: Record<string, unknown>;
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export declare const InvMastLocationBinListResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">;
message: z.ZodString;
options: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
params: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
status: z.ZodNumber;
total: z.ZodNumber;
totalResults: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
params: Record<string, unknown> | unknown[];
data: Record<string, unknown>[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: Record<string, unknown>[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: Record<string, unknown>[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: Record<string, unknown>[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export type InvMastLocationsBinsParams = z.infer<typeof InvMastLocationsBinsParamsSchema>;
export type InvMastLocationBin = z.infer<typeof InvMastLocationBinSchema>;
export type InvMastLocationBinResponse = z.infer<typeof InvMastLocationBinResponseSchema>;
export type InvMastLocationBinListResponse = z.infer<typeof InvMastLocationBinListResponseSchema>;
//# sourceMappingURL=invMastLocationsBins.d.ts.map