@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
266 lines • 8.94 kB
TypeScript
import { z } from 'zod';
/**
* Todo list parameters
*/
export declare const TodoListParamsSchema: z.ZodObject<{
limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
offset: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
} & {
'x-site-id': z.ZodString;
orderBy: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
'x-site-id': string;
limit: number;
offset: number;
orderBy?: string | undefined;
}, {
'x-site-id': string;
limit?: number | undefined;
offset?: number | undefined;
orderBy?: string | undefined;
}>;
/**
* Todo get parameters
*/
export declare const TodoGetParamsSchema: z.ZodObject<{
'x-site-id': z.ZodString;
}, "strip", z.ZodTypeAny, {
'x-site-id': string;
}, {
'x-site-id': string;
}>;
/**
* Todo data schema
*/
export declare const TodoDataSchema: z.ZodObject<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">>;
/**
* Todo response
*/
export declare const TodoResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodObject<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, 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: {
id: number;
title?: string | undefined;
completed?: boolean | undefined;
created_at?: string | undefined;
updated_at?: string | undefined;
content?: string | undefined;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
id: number;
title?: string | undefined;
completed?: boolean | undefined;
created_at?: string | undefined;
updated_at?: string | undefined;
content?: string | undefined;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: {
id: number;
title?: string | undefined;
completed?: boolean | undefined;
created_at?: string | undefined;
updated_at?: string | undefined;
content?: string | undefined;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
id: number;
title?: string | undefined;
completed?: boolean | undefined;
created_at?: string | undefined;
updated_at?: string | undefined;
content?: string | undefined;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
/**
* Todo list response
*/
export declare const TodoListResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodArray<z.ZodObject<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, 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<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, 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<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, 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<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, 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<{
id: z.ZodNumber;
title: z.ZodOptional<z.ZodString>;
content: z.ZodOptional<z.ZodString>;
completed: z.ZodOptional<z.ZodBoolean>;
created_at: z.ZodOptional<z.ZodString>;
updated_at: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export type TodoListParams = z.infer<typeof TodoListParamsSchema>;
export type TodoGetParams = z.infer<typeof TodoGetParamsSchema>;
export type TodoData = z.infer<typeof TodoDataSchema>;
export type TodoResponse = z.infer<typeof TodoResponseSchema>;
export type TodoListResponse = z.infer<typeof TodoListResponseSchema>;
//# sourceMappingURL=todos.d.ts.map