@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
373 lines • 11.6 kB
TypeScript
import { z } from 'zod';
/**
* Import data schema representing a single import record from P21 SISM
*/
export declare const ImportSchema: z.ZodObject<{
importUid: z.ZodNumber;
scheduledImportMasterUid: z.ZodNumber;
dateCreated: z.ZodString;
dateLastModified: z.ZodString;
sourceName: z.ZodNullable<z.ZodString>;
sourceId: z.ZodNumber;
importState: z.ZodString;
jsonData: z.ZodNullable<z.ZodString>;
importStatusCd: z.ZodNumber;
importResults: z.ZodNullable<z.ZodString>;
referenceNo: z.ZodNullable<z.ZodString>;
}, "strip", z.ZodTypeAny, {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
}, {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
}>;
/**
* Parameters for listing imports with filtering and pagination
*/
export declare const ImportListParamsSchema: z.ZodObject<{
importState: z.ZodOptional<z.ZodEnum<["initial", "hold", "delivered"]>>;
limit: z.ZodOptional<z.ZodNumber>;
offset: z.ZodOptional<z.ZodNumber>;
orderBy: z.ZodOptional<z.ZodString>;
q: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
limit?: number | undefined;
offset?: number | undefined;
q?: string | undefined;
orderBy?: string | undefined;
importState?: "initial" | "hold" | "delivered" | undefined;
}, {
limit?: number | undefined;
offset?: number | undefined;
q?: string | undefined;
orderBy?: string | undefined;
importState?: "initial" | "hold" | "delivered" | undefined;
}>;
/**
* Parameters for recent imports query
*/
export declare const ImportRecentParamsSchema: z.ZodObject<{
hours: z.ZodOptional<z.ZodNumber>;
limit: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
limit?: number | undefined;
hours?: number | undefined;
}, {
limit?: number | undefined;
hours?: number | undefined;
}>;
/**
* Parameters for stuck imports query
*/
export declare const ImportStuckParamsSchema: z.ZodObject<{
hours: z.ZodOptional<z.ZodNumber>;
limit: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
limit?: number | undefined;
hours?: number | undefined;
}, {
limit?: number | undefined;
hours?: number | undefined;
}>;
/**
* Parameters for import detail operations
*/
export declare const ImportDetailParamsSchema: z.ZodObject<{
importUid: z.ZodString;
}, "strip", z.ZodTypeAny, {
importUid: string;
}, {
importUid: string;
}>;
/**
* Response schemas for import operations
*/
export declare const ImportResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodObject<{
importUid: z.ZodNumber;
scheduledImportMasterUid: z.ZodNumber;
dateCreated: z.ZodString;
dateLastModified: z.ZodString;
sourceName: z.ZodNullable<z.ZodString>;
sourceId: z.ZodNumber;
importState: z.ZodString;
jsonData: z.ZodNullable<z.ZodString>;
importStatusCd: z.ZodNumber;
importResults: z.ZodNullable<z.ZodString>;
referenceNo: z.ZodNullable<z.ZodString>;
}, "strip", z.ZodTypeAny, {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
}, {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
}>;
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: {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export declare const ImportListResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodArray<z.ZodObject<{
importUid: z.ZodNumber;
scheduledImportMasterUid: z.ZodNumber;
dateCreated: z.ZodString;
dateLastModified: z.ZodString;
sourceName: z.ZodNullable<z.ZodString>;
sourceId: z.ZodNumber;
importState: z.ZodString;
jsonData: z.ZodNullable<z.ZodString>;
importStatusCd: z.ZodNumber;
importResults: z.ZodNullable<z.ZodString>;
referenceNo: z.ZodNullable<z.ZodString>;
}, "strip", z.ZodTypeAny, {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
}, {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
}>, "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: {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
}[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
}[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
}[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
dateCreated: string;
dateLastModified: string;
jsonData: string | null;
sourceName: string | null;
sourceId: number;
importState: string;
referenceNo: string | null;
importUid: number;
scheduledImportMasterUid: number;
importStatusCd: number;
importResults: string | null;
}[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
/**
* Type exports for TypeScript usage
*/
export type Import = z.infer<typeof ImportSchema>;
export type ImportListParams = z.infer<typeof ImportListParamsSchema>;
export type ImportRecentParams = z.infer<typeof ImportRecentParamsSchema>;
export type ImportStuckParams = z.infer<typeof ImportStuckParamsSchema>;
export type ImportDetailParams = z.infer<typeof ImportDetailParamsSchema>;
export type ImportResponse = z.infer<typeof ImportResponseSchema>;
export type ImportListResponse = z.infer<typeof ImportListResponseSchema>;
//# sourceMappingURL=import.d.ts.map