@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
438 lines • 15.6 kB
TypeScript
import { z } from 'zod';
export declare const ItemFaqSchema: z.ZodObject<{
invMastFaqUid: z.ZodNumber;
invMastUid: z.ZodNumber;
question: z.ZodString;
answer: z.ZodString;
category: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodString>;
isPublic: z.ZodOptional<z.ZodString>;
viewCount: z.ZodOptional<z.ZodNumber>;
helpfulCount: z.ZodOptional<z.ZodNumber>;
dateCreated: z.ZodOptional<z.ZodString>;
dateLastModified: z.ZodOptional<z.ZodString>;
createdBy: z.ZodOptional<z.ZodString>;
lastMaintainedBy: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
}, {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
}>;
export declare const CreateItemFaqRequestSchema: z.ZodObject<{
question: z.ZodString;
answer: z.ZodString;
category: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodString>;
isPublic: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
question: string;
answer: string;
category?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
}, {
question: string;
answer: string;
category?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
}>;
export declare const UpdateItemFaqRequestSchema: z.ZodObject<{
question: z.ZodOptional<z.ZodString>;
answer: z.ZodOptional<z.ZodString>;
category: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodString>;
isPublic: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
category?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
question?: string | undefined;
answer?: string | undefined;
}, {
category?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
question?: string | undefined;
answer?: string | undefined;
}>;
export declare const ItemFaqListParamsSchema: z.ZodObject<{
limit: z.ZodOptional<z.ZodNumber>;
offset: z.ZodOptional<z.ZodNumber>;
} & {
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 | 4 | 1 | 5 | 8, 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8">>;
} & {
category: z.ZodOptional<z.ZodString>;
isActive: z.ZodOptional<z.ZodString>;
isPublic: z.ZodOptional<z.ZodString>;
q: z.ZodOptional<z.ZodString>;
orderBy: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
limit?: number | undefined;
offset?: number | undefined;
q?: string | undefined;
orderBy?: string | undefined;
category?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
}, {
edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
limit?: number | undefined;
offset?: number | undefined;
q?: string | undefined;
orderBy?: string | undefined;
category?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
}>;
export declare const ItemFaqVoteRequestSchema: z.ZodObject<{
isHelpful: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
isHelpful: boolean;
}, {
isHelpful: boolean;
}>;
export declare const ItemFaqResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodObject<{
invMastFaqUid: z.ZodNumber;
invMastUid: z.ZodNumber;
question: z.ZodString;
answer: z.ZodString;
category: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodString>;
isPublic: z.ZodOptional<z.ZodString>;
viewCount: z.ZodOptional<z.ZodNumber>;
helpfulCount: z.ZodOptional<z.ZodNumber>;
dateCreated: z.ZodOptional<z.ZodString>;
dateLastModified: z.ZodOptional<z.ZodString>;
createdBy: z.ZodOptional<z.ZodString>;
lastMaintainedBy: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
}, {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
}>;
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: {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export declare const ItemFaqListResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodArray<z.ZodObject<{
invMastFaqUid: z.ZodNumber;
invMastUid: z.ZodNumber;
question: z.ZodString;
answer: z.ZodString;
category: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodString>;
isPublic: z.ZodOptional<z.ZodString>;
viewCount: z.ZodOptional<z.ZodNumber>;
helpfulCount: z.ZodOptional<z.ZodNumber>;
dateCreated: z.ZodOptional<z.ZodString>;
dateLastModified: z.ZodOptional<z.ZodString>;
createdBy: z.ZodOptional<z.ZodString>;
lastMaintainedBy: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
}, {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
}>, "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: {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
}[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
}[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
}[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
invMastUid: number;
invMastFaqUid: number;
question: string;
answer: string;
category?: string | undefined;
dateCreated?: string | undefined;
dateLastModified?: string | undefined;
createdBy?: string | undefined;
lastMaintainedBy?: string | undefined;
isPublic?: string | undefined;
isActive?: string | undefined;
displayOrder?: number | undefined;
viewCount?: number | undefined;
helpfulCount?: number | undefined;
}[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export type ItemFaq = z.infer<typeof ItemFaqSchema>;
export type CreateItemFaqRequest = z.infer<typeof CreateItemFaqRequestSchema>;
export type UpdateItemFaqRequest = z.infer<typeof UpdateItemFaqRequestSchema>;
export type ItemFaqListParams = z.infer<typeof ItemFaqListParamsSchema>;
export type ItemFaqVoteRequest = z.infer<typeof ItemFaqVoteRequestSchema>;
export type ItemFaqResponse = z.infer<typeof ItemFaqResponseSchema>;
export type ItemFaqListResponse = z.infer<typeof ItemFaqListResponseSchema>;
//# sourceMappingURL=faq.d.ts.map