@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
280 lines • 9.11 kB
TypeScript
import { z } from 'zod';
/**
* Schema for /users/{id}/doc GET endpoint
* Returns enhanced user document with profile values and customer information
* Updated to match current API response format
*/
export declare const UsersIdDocItemSchema: z.ZodObject<{
id: z.ZodNumber;
name: z.ZodString;
username: z.ZodString;
email: z.ZodString;
block: z.ZodNumber;
registerDate: z.ZodString;
lastvisitDate: z.ZodNullable<z.ZodString>;
lastResetTime: z.ZodNullable<z.ZodString>;
profileValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
customerId: z.ZodOptional<z.ZodString>;
contactId: z.ZodOptional<z.ZodString>;
timezone: z.ZodOptional<z.ZodString>;
language: z.ZodOptional<z.ZodString>;
groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodNumber;
title: z.ZodString;
}, "strip", z.ZodTypeAny, {
id: number;
title: string;
}, {
id: number;
title: string;
}>, "many">>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
id: z.ZodNumber;
name: z.ZodString;
username: z.ZodString;
email: z.ZodString;
block: z.ZodNumber;
registerDate: z.ZodString;
lastvisitDate: z.ZodNullable<z.ZodString>;
lastResetTime: z.ZodNullable<z.ZodString>;
profileValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
customerId: z.ZodOptional<z.ZodString>;
contactId: z.ZodOptional<z.ZodString>;
timezone: z.ZodOptional<z.ZodString>;
language: z.ZodOptional<z.ZodString>;
groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodNumber;
title: z.ZodString;
}, "strip", z.ZodTypeAny, {
id: number;
title: string;
}, {
id: number;
title: string;
}>, "many">>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
id: z.ZodNumber;
name: z.ZodString;
username: z.ZodString;
email: z.ZodString;
block: z.ZodNumber;
registerDate: z.ZodString;
lastvisitDate: z.ZodNullable<z.ZodString>;
lastResetTime: z.ZodNullable<z.ZodString>;
profileValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
customerId: z.ZodOptional<z.ZodString>;
contactId: z.ZodOptional<z.ZodString>;
timezone: z.ZodOptional<z.ZodString>;
language: z.ZodOptional<z.ZodString>;
groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodNumber;
title: z.ZodString;
}, "strip", z.ZodTypeAny, {
id: number;
title: string;
}, {
id: number;
title: string;
}>, "many">>;
}, z.ZodTypeAny, "passthrough">>;
export declare const UsersIdDocResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodObject<{
id: z.ZodNumber;
name: z.ZodString;
username: z.ZodString;
email: z.ZodString;
block: z.ZodNumber;
registerDate: z.ZodString;
lastvisitDate: z.ZodNullable<z.ZodString>;
lastResetTime: z.ZodNullable<z.ZodString>;
profileValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
customerId: z.ZodOptional<z.ZodString>;
contactId: z.ZodOptional<z.ZodString>;
timezone: z.ZodOptional<z.ZodString>;
language: z.ZodOptional<z.ZodString>;
groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodNumber;
title: z.ZodString;
}, "strip", z.ZodTypeAny, {
id: number;
title: string;
}, {
id: number;
title: string;
}>, "many">>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
id: z.ZodNumber;
name: z.ZodString;
username: z.ZodString;
email: z.ZodString;
block: z.ZodNumber;
registerDate: z.ZodString;
lastvisitDate: z.ZodNullable<z.ZodString>;
lastResetTime: z.ZodNullable<z.ZodString>;
profileValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
customerId: z.ZodOptional<z.ZodString>;
contactId: z.ZodOptional<z.ZodString>;
timezone: z.ZodOptional<z.ZodString>;
language: z.ZodOptional<z.ZodString>;
groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodNumber;
title: z.ZodString;
}, "strip", z.ZodTypeAny, {
id: number;
title: string;
}, {
id: number;
title: string;
}>, "many">>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
id: z.ZodNumber;
name: z.ZodString;
username: z.ZodString;
email: z.ZodString;
block: z.ZodNumber;
registerDate: z.ZodString;
lastvisitDate: z.ZodNullable<z.ZodString>;
lastResetTime: z.ZodNullable<z.ZodString>;
profileValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
customerId: z.ZodOptional<z.ZodString>;
contactId: z.ZodOptional<z.ZodString>;
timezone: z.ZodOptional<z.ZodString>;
language: z.ZodOptional<z.ZodString>;
groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodNumber;
title: z.ZodString;
}, "strip", z.ZodTypeAny, {
id: number;
title: string;
}, {
id: number;
title: string;
}>, "many">>;
}, 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;
name: string;
username: string;
email: string;
block: number;
registerDate: string;
lastvisitDate: string | null;
lastResetTime: string | null;
profileValues?: Record<string, unknown> | undefined;
customerId?: string | undefined;
contactId?: string | undefined;
timezone?: string | undefined;
language?: string | undefined;
groups?: {
id: number;
title: 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;
name: string;
username: string;
email: string;
block: number;
registerDate: string;
lastvisitDate: string | null;
lastResetTime: string | null;
profileValues?: Record<string, unknown> | undefined;
customerId?: string | undefined;
contactId?: string | undefined;
timezone?: string | undefined;
language?: string | undefined;
groups?: {
id: number;
title: 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;
name: string;
username: string;
email: string;
block: number;
registerDate: string;
lastvisitDate: string | null;
lastResetTime: string | null;
profileValues?: Record<string, unknown> | undefined;
customerId?: string | undefined;
contactId?: string | undefined;
timezone?: string | undefined;
language?: string | undefined;
groups?: {
id: number;
title: 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;
name: string;
username: string;
email: string;
block: number;
registerDate: string;
lastvisitDate: string | null;
lastResetTime: string | null;
profileValues?: Record<string, unknown> | undefined;
customerId?: string | undefined;
contactId?: string | undefined;
timezone?: string | undefined;
language?: string | undefined;
groups?: {
id: number;
title: string;
}[] | undefined;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export type UsersIdDocItem = z.infer<typeof UsersIdDocItemSchema>;
export type UsersIdDocResponse = z.infer<typeof UsersIdDocResponseSchema>;
//# sourceMappingURL=usersIdDoc.d.ts.map