@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
211 lines • 8.6 kB
TypeScript
import { z } from 'zod';
/** State - key field only, passthrough for API flexibility */
export declare const StateSchema: z.ZodObject<{
stateUid: z.ZodNumber;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
stateUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
stateUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">>;
export declare const StateListParamsSchema: z.ZodObject<{
limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
offset: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
orderBy: z.ZodOptional<z.ZodString>;
} & {
edgeCache: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>, z.ZodLiteral<5>, z.ZodLiteral<8>, z.ZodLiteral<"1">, z.ZodLiteral<"2">, z.ZodLiteral<"3">, z.ZodLiteral<"4">, z.ZodLiteral<"5">, z.ZodLiteral<"8">]>, 3 | 2 | 1 | 4 | 5 | 8, 3 | 2 | 1 | 4 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8">>;
} & {
q: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
limit: number;
offset: number;
edgeCache?: 3 | 2 | 1 | 4 | 5 | 8 | undefined;
q?: string | undefined;
orderBy?: string | undefined;
}, {
limit?: number | undefined;
offset?: number | undefined;
edgeCache?: 3 | 2 | 1 | 4 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
q?: string | undefined;
orderBy?: string | undefined;
}> | z.ZodObject<{
limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
offset: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
orderBy: z.ZodOptional<z.ZodString>;
} & {
edgeCache: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>, z.ZodLiteral<5>, z.ZodLiteral<8>, z.ZodLiteral<"1">, z.ZodLiteral<"2">, z.ZodLiteral<"3">, z.ZodLiteral<"4">, z.ZodLiteral<"5">, z.ZodLiteral<"8">]>, 3 | 2 | 1 | 4 | 5 | 8, 3 | 2 | 1 | 4 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8">>;
} & {
q: z.ZodOptional<z.ZodString>;
} & {
twoLetterCode: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
limit: number;
offset: number;
edgeCache?: 3 | 2 | 1 | 4 | 5 | 8 | undefined;
q?: string | undefined;
orderBy?: string | undefined;
twoLetterCode?: string | undefined;
}, {
limit?: number | undefined;
offset?: number | undefined;
edgeCache?: 3 | 2 | 1 | 4 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
q?: string | undefined;
orderBy?: string | undefined;
twoLetterCode?: string | undefined;
}>;
export declare const StateGetParamsSchema: z.ZodObject<{
edgeCache: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>, z.ZodLiteral<5>, z.ZodLiteral<8>, z.ZodLiteral<"1">, z.ZodLiteral<"2">, z.ZodLiteral<"3">, z.ZodLiteral<"4">, z.ZodLiteral<"5">, z.ZodLiteral<"8">]>, 3 | 2 | 1 | 4 | 5 | 8, 3 | 2 | 1 | 4 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8">>;
}, "strip", z.ZodTypeAny, {
edgeCache?: 3 | 2 | 1 | 4 | 5 | 8 | undefined;
}, {
edgeCache?: 3 | 2 | 1 | 4 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
}> | z.ZodObject<{
edgeCache: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>, z.ZodLiteral<5>, z.ZodLiteral<8>, z.ZodLiteral<"1">, z.ZodLiteral<"2">, z.ZodLiteral<"3">, z.ZodLiteral<"4">, z.ZodLiteral<"5">, z.ZodLiteral<"8">]>, 3 | 2 | 1 | 4 | 5 | 8, 3 | 2 | 1 | 4 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8">>;
} & {
twoLetterCode: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
edgeCache?: 3 | 2 | 1 | 4 | 5 | 8 | undefined;
twoLetterCode?: string | undefined;
}, {
edgeCache?: 3 | 2 | 1 | 4 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
twoLetterCode?: string | undefined;
}>;
/** Create state request - passthrough for flexible input */
export declare const CreateStateRequestSchema: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
/** Update state request - passthrough for flexible input */
export declare const UpdateStateRequestSchema: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
export declare const StateListResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodArray<z.ZodObject<{
stateUid: z.ZodNumber;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
stateUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
stateUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">>, "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: z.objectOutputType<{
stateUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: z.objectInputType<{
stateUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: z.objectOutputType<{
stateUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: z.objectInputType<{
stateUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export declare const StateResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodObject<{
stateUid: z.ZodNumber;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
stateUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
stateUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">>;
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: {
stateUid: number;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
stateUid: number;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: {
stateUid: number;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
stateUid: number;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export type State = z.infer<typeof StateSchema>;
export type StateListParams = z.infer<typeof StateListParamsSchema>;
export type StateGetParams = z.infer<typeof StateGetParamsSchema>;
export type CreateStateRequest = z.infer<typeof CreateStateRequestSchema>;
export type UpdateStateRequest = z.infer<typeof UpdateStateRequestSchema>;
export type StateListResponse = z.infer<typeof StateListResponseSchema>;
export type StateResponse = z.infer<typeof StateResponseSchema>;
//# sourceMappingURL=states.d.ts.map