@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
659 lines • 21.3 kB
TypeScript
import { z } from 'zod';
/**
* Entity contacts refresh parameters - trigger data refresh
*/
export declare const EntityContactsRefreshParamsSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
/**
* Entity customers refresh parameters - trigger data refresh
*/
export declare const EntityCustomersRefreshParamsSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
/**
* Health check parameters
*/
export declare const HealthCheckParamsSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
/**
* Transaction category parameters for CRUD operations
*/
export declare const TransCategoryParamsSchema: z.ZodObject<{
categoryUid: z.ZodNumber;
categoryId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
categoryUid: number;
categoryId?: string | undefined;
}, {
categoryUid: number;
categoryId?: string | undefined;
}>;
/**
* Transaction category create parameters
*/
export declare const TransCategoryCreateParamsSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
/**
* Transaction company parameters for CRUD operations
*/
export declare const TransCompanyParamsSchema: z.ZodObject<{
companyUid: z.ZodNumber;
companyId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
companyUid: number;
companyId?: string | undefined;
}, {
companyUid: number;
companyId?: string | undefined;
}>;
/**
* Transaction company create parameters
*/
export declare const TransCompanyCreateParamsSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
/**
* Transaction purchase order receipt parameters
*/
export declare const TransPurchaseOrderReceiptParamsSchema: z.ZodObject<{
poNo: z.ZodString;
}, "strip", z.ZodTypeAny, {
poNo: string;
}, {
poNo: string;
}>;
/**
* Transaction user parameters for CRUD operations
*/
export declare const TransUserParamsSchema: z.ZodObject<{
usersUid: z.ZodNumber;
userId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
usersUid: number;
userId?: string | undefined;
}, {
usersUid: number;
userId?: string | undefined;
}>;
/**
* Transaction user create parameters
*/
export declare const TransUserCreateParamsSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
/**
* Transaction web display type parameters for CRUD operations
*/
export declare const TransWebDisplayTypeParamsSchema: z.ZodObject<{
webDisplayTypeUid: z.ZodNumber;
webDisplayTypeId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
webDisplayTypeUid: number;
webDisplayTypeId?: string | undefined;
}, {
webDisplayTypeUid: number;
webDisplayTypeId?: string | undefined;
}>;
/**
* Transaction web display type create parameters
*/
export declare const TransWebDisplayTypeCreateParamsSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
/**
* Transaction web display type defaults parameters
*/
export declare const TransWebDisplayTypeDefaultsParamsSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
/**
* Transaction web display type definition parameters
*/
export declare const TransWebDisplayTypeDefinitionParamsSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
/**
* Health check response data
*/
export declare const HealthCheckDataSchema: z.ZodUnknown;
/**
* Entity refresh response data
*/
export declare const EntityRefreshDataSchema: z.ZodUnknown;
/**
* Transaction category data
*/
export declare const TransCategoryDataSchema: z.ZodUnknown;
/**
* Transaction company data
*/
export declare const TransCompanyDataSchema: z.ZodUnknown;
/**
* Transaction purchase order receipt data
*/
export declare const TransPurchaseOrderReceiptDataSchema: z.ZodUnknown;
/**
* Transaction user data
*/
export declare const TransUserDataSchema: z.ZodUnknown;
/**
* Transaction web display type data
*/
export declare const TransWebDisplayTypeDataSchema: z.ZodUnknown;
/**
* Transaction web display type defaults data
*/
export declare const TransWebDisplayTypeDefaultsDataSchema: z.ZodUnknown;
/**
* Transaction web display type definition data
*/
export declare const TransWebDisplayTypeDefinitionDataSchema: z.ZodUnknown;
/**
* Health check response
*/
export declare const HealthCheckResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodUnknown;
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[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Entity contacts refresh response
*/
export declare const EntityContactsRefreshResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodUnknown;
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[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Entity customers refresh response
*/
export declare const EntityCustomersRefreshResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodUnknown;
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[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Transaction category response
*/
export declare const TransCategoryResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodUnknown;
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[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Transaction company response
*/
export declare const TransCompanyResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodUnknown;
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[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Transaction purchase order receipt response
*/
export declare const TransPurchaseOrderReceiptResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodUnknown;
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[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Transaction user response
*/
export declare const TransUserResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodUnknown;
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[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Transaction web display type response
*/
export declare const TransWebDisplayTypeResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodUnknown;
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[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Transaction web display type defaults response
*/
export declare const TransWebDisplayTypeDefaultsResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodUnknown;
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[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Transaction web display type definition response
*/
export declare const TransWebDisplayTypeDefinitionResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodUnknown;
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[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}, {
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
export type EntityContactsRefreshParams = z.infer<typeof EntityContactsRefreshParamsSchema>;
export type EntityCustomersRefreshParams = z.infer<typeof EntityCustomersRefreshParamsSchema>;
export type HealthCheckParams = z.infer<typeof HealthCheckParamsSchema>;
export type TransCategoryParams = z.infer<typeof TransCategoryParamsSchema>;
export type TransCategoryCreateParams = z.infer<typeof TransCategoryCreateParamsSchema>;
export type TransCompanyParams = z.infer<typeof TransCompanyParamsSchema>;
export type TransCompanyCreateParams = z.infer<typeof TransCompanyCreateParamsSchema>;
export type TransPurchaseOrderReceiptParams = z.infer<typeof TransPurchaseOrderReceiptParamsSchema>;
export type TransUserParams = z.infer<typeof TransUserParamsSchema>;
export type TransUserCreateParams = z.infer<typeof TransUserCreateParamsSchema>;
export type TransWebDisplayTypeParams = z.infer<typeof TransWebDisplayTypeParamsSchema>;
export type TransWebDisplayTypeCreateParams = z.infer<typeof TransWebDisplayTypeCreateParamsSchema>;
export type TransWebDisplayTypeDefaultsParams = z.infer<typeof TransWebDisplayTypeDefaultsParamsSchema>;
export type TransWebDisplayTypeDefinitionParams = z.infer<typeof TransWebDisplayTypeDefinitionParamsSchema>;
export type HealthCheckData = z.infer<typeof HealthCheckDataSchema>;
export type EntityRefreshData = z.infer<typeof EntityRefreshDataSchema>;
export type TransCategoryData = z.infer<typeof TransCategoryDataSchema>;
export type TransCompanyData = z.infer<typeof TransCompanyDataSchema>;
export type TransPurchaseOrderReceiptData = z.infer<typeof TransPurchaseOrderReceiptDataSchema>;
export type TransUserData = z.infer<typeof TransUserDataSchema>;
export type TransWebDisplayTypeData = z.infer<typeof TransWebDisplayTypeDataSchema>;
export type TransWebDisplayTypeDefaultsData = z.infer<typeof TransWebDisplayTypeDefaultsDataSchema>;
export type TransWebDisplayTypeDefinitionData = z.infer<typeof TransWebDisplayTypeDefinitionDataSchema>;
export type HealthCheckResponse = z.infer<typeof HealthCheckResponseSchema>;
export type EntityContactsRefreshResponse = z.infer<typeof EntityContactsRefreshResponseSchema>;
export type EntityCustomersRefreshResponse = z.infer<typeof EntityCustomersRefreshResponseSchema>;
export type TransCategoryResponse = z.infer<typeof TransCategoryResponseSchema>;
export type TransCompanyResponse = z.infer<typeof TransCompanyResponseSchema>;
export type TransPurchaseOrderReceiptResponse = z.infer<typeof TransPurchaseOrderReceiptResponseSchema>;
export type TransUserResponse = z.infer<typeof TransUserResponseSchema>;
export type TransWebDisplayTypeResponse = z.infer<typeof TransWebDisplayTypeResponseSchema>;
export type TransWebDisplayTypeDefaultsResponse = z.infer<typeof TransWebDisplayTypeDefaultsResponseSchema>;
export type TransWebDisplayTypeDefinitionResponse = z.infer<typeof TransWebDisplayTypeDefinitionResponseSchema>;
//# sourceMappingURL=schemas.d.ts.map