UNPKG

@simpleapps-com/augur-api

Version:

TypeScript client library for Augur microservices API endpoints

862 lines 29.2 kB
import { z } from 'zod'; export declare const AddressSchema: z.ZodObject<{ addressId: z.ZodNumber; customerId: z.ZodNumber; addressName: z.ZodString; address1: z.ZodString; address2: z.ZodOptional<z.ZodString>; city: z.ZodString; state: z.ZodString; zipCode: z.ZodString; country: z.ZodString; phoneNumber: z.ZodOptional<z.ZodString>; faxNumber: z.ZodOptional<z.ZodString>; isPrimary: z.ZodOptional<z.ZodBoolean>; }, "strip", z.ZodTypeAny, { state: string; customerId: number; city: string; zipCode: string; country: string; addressId: number; addressName: string; address1: string; isPrimary?: boolean | undefined; phoneNumber?: string | undefined; address2?: string | undefined; faxNumber?: string | undefined; }, { state: string; customerId: number; city: string; zipCode: string; country: string; addressId: number; addressName: string; address1: string; isPrimary?: boolean | undefined; phoneNumber?: string | undefined; address2?: string | undefined; faxNumber?: string | undefined; }>; export declare const AddressListParamsSchema: z.ZodObject<{ 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">>; } & { q: z.ZodString; limit: z.ZodOptional<z.ZodNumber>; offset: z.ZodOptional<z.ZodNumber>; }, "strip", z.ZodTypeAny, { q: string; edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined; limit?: number | undefined; offset?: number | undefined; }, { q: string; edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined; limit?: number | undefined; offset?: number | undefined; }>; export declare const AddressSubSchema: z.ZodObject<{ id: z.ZodNumber; name: z.ZodNullable<z.ZodString>; mailAddress1: z.ZodNullable<z.ZodString>; mailAddress2: z.ZodNullable<z.ZodString>; mailCity: z.ZodNullable<z.ZodString>; mailState: z.ZodNullable<z.ZodString>; mailPostalCode: z.ZodNullable<z.ZodString>; mailCountry: z.ZodNullable<z.ZodString>; physAddress1: z.ZodNullable<z.ZodString>; physAddress2: z.ZodNullable<z.ZodString>; physCity: z.ZodNullable<z.ZodString>; physState: z.ZodNullable<z.ZodString>; physPostalCode: z.ZodNullable<z.ZodString>; physCountry: z.ZodNullable<z.ZodString>; }, "strip", z.ZodTypeAny, { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }, { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }>; export declare const ShipToAddressSchema: z.ZodObject<{ shipToId: z.ZodNumber; customerId: z.ZodNumber; companyId: z.ZodString; defaultBranch: z.ZodString; defaultCarrierId: z.ZodNullable<z.ZodNumber>; address: z.ZodObject<{ id: z.ZodNumber; name: z.ZodNullable<z.ZodString>; mailAddress1: z.ZodNullable<z.ZodString>; mailAddress2: z.ZodNullable<z.ZodString>; mailCity: z.ZodNullable<z.ZodString>; mailState: z.ZodNullable<z.ZodString>; mailPostalCode: z.ZodNullable<z.ZodString>; mailCountry: z.ZodNullable<z.ZodString>; physAddress1: z.ZodNullable<z.ZodString>; physAddress2: z.ZodNullable<z.ZodString>; physCity: z.ZodNullable<z.ZodString>; physState: z.ZodNullable<z.ZodString>; physPostalCode: z.ZodNullable<z.ZodString>; physCountry: z.ZodNullable<z.ZodString>; }, "strip", z.ZodTypeAny, { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }, { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }>; }, "strip", z.ZodTypeAny, { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }, { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }>; export declare const ShipToAddressCreateParamsSchema: z.ZodObject<{ shipToName: z.ZodString; address1: z.ZodString; address2: z.ZodOptional<z.ZodString>; city: z.ZodString; state: z.ZodString; zipCode: z.ZodString; country: z.ZodString; contactName: z.ZodOptional<z.ZodString>; phoneNumber: z.ZodOptional<z.ZodString>; deliveryInstructions: z.ZodOptional<z.ZodString>; isDefault: z.ZodOptional<z.ZodBoolean>; }, "strip", z.ZodTypeAny, { state: string; shipToName: string; city: string; zipCode: string; country: string; address1: string; isDefault?: boolean | undefined; phoneNumber?: string | undefined; address2?: string | undefined; contactName?: string | undefined; deliveryInstructions?: string | undefined; }, { state: string; shipToName: string; city: string; zipCode: string; country: string; address1: string; isDefault?: boolean | undefined; phoneNumber?: string | undefined; address2?: string | undefined; contactName?: string | undefined; deliveryInstructions?: string | undefined; }>; export declare const ShipToAddressListParamsSchema: z.ZodObject<{ 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">>; } & { limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>; offset: z.ZodDefault<z.ZodOptional<z.ZodNumber>>; orderBy: z.ZodDefault<z.ZodOptional<z.ZodString>>; }, "strip", z.ZodTypeAny, { limit: number; offset: number; orderBy: string; edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined; }, { edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined; limit?: number | undefined; offset?: number | undefined; orderBy?: string | undefined; }>; export declare const AddressListResponseSchema: z.ZodEffects<z.ZodObject<{ count: z.ZodNumber; data: z.ZodArray<z.ZodObject<{ addressId: z.ZodNumber; customerId: z.ZodNumber; addressName: z.ZodString; address1: z.ZodString; address2: z.ZodOptional<z.ZodString>; city: z.ZodString; state: z.ZodString; zipCode: z.ZodString; country: z.ZodString; phoneNumber: z.ZodOptional<z.ZodString>; faxNumber: z.ZodOptional<z.ZodString>; isPrimary: z.ZodOptional<z.ZodBoolean>; }, "strip", z.ZodTypeAny, { state: string; customerId: number; city: string; zipCode: string; country: string; addressId: number; addressName: string; address1: string; isPrimary?: boolean | undefined; phoneNumber?: string | undefined; address2?: string | undefined; faxNumber?: string | undefined; }, { state: string; customerId: number; city: string; zipCode: string; country: string; addressId: number; addressName: string; address1: string; isPrimary?: boolean | undefined; phoneNumber?: string | undefined; address2?: string | undefined; faxNumber?: string | 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: { state: string; customerId: number; city: string; zipCode: string; country: string; addressId: number; addressName: string; address1: string; isPrimary?: boolean | undefined; phoneNumber?: string | undefined; address2?: string | undefined; faxNumber?: string | undefined; }[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: { state: string; customerId: number; city: string; zipCode: string; country: string; addressId: number; addressName: string; address1: string; isPrimary?: boolean | undefined; phoneNumber?: string | undefined; address2?: string | undefined; faxNumber?: string | undefined; }[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>, { params: Record<string, unknown> | unknown[]; data: { state: string; customerId: number; city: string; zipCode: string; country: string; addressId: number; addressName: string; address1: string; isPrimary?: boolean | undefined; phoneNumber?: string | undefined; address2?: string | undefined; faxNumber?: string | undefined; }[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: { state: string; customerId: number; city: string; zipCode: string; country: string; addressId: number; addressName: string; address1: string; isPrimary?: boolean | undefined; phoneNumber?: string | undefined; address2?: string | undefined; faxNumber?: string | undefined; }[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>; export declare const ShipToAddressListResponseSchema: z.ZodEffects<z.ZodObject<{ count: z.ZodNumber; data: z.ZodArray<z.ZodObject<{ shipToId: z.ZodNumber; customerId: z.ZodNumber; companyId: z.ZodString; defaultBranch: z.ZodString; defaultCarrierId: z.ZodNullable<z.ZodNumber>; address: z.ZodObject<{ id: z.ZodNumber; name: z.ZodNullable<z.ZodString>; mailAddress1: z.ZodNullable<z.ZodString>; mailAddress2: z.ZodNullable<z.ZodString>; mailCity: z.ZodNullable<z.ZodString>; mailState: z.ZodNullable<z.ZodString>; mailPostalCode: z.ZodNullable<z.ZodString>; mailCountry: z.ZodNullable<z.ZodString>; physAddress1: z.ZodNullable<z.ZodString>; physAddress2: z.ZodNullable<z.ZodString>; physCity: z.ZodNullable<z.ZodString>; physState: z.ZodNullable<z.ZodString>; physPostalCode: z.ZodNullable<z.ZodString>; physCountry: z.ZodNullable<z.ZodString>; }, "strip", z.ZodTypeAny, { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }, { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }>; }, "strip", z.ZodTypeAny, { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }, { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | 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: { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>, { params: Record<string, unknown> | unknown[]; data: { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>; export declare const ShipToAddressResponseSchema: z.ZodEffects<z.ZodObject<{ count: z.ZodNumber; data: z.ZodObject<{ shipToId: z.ZodNumber; customerId: z.ZodNumber; companyId: z.ZodString; defaultBranch: z.ZodString; defaultCarrierId: z.ZodNullable<z.ZodNumber>; address: z.ZodObject<{ id: z.ZodNumber; name: z.ZodNullable<z.ZodString>; mailAddress1: z.ZodNullable<z.ZodString>; mailAddress2: z.ZodNullable<z.ZodString>; mailCity: z.ZodNullable<z.ZodString>; mailState: z.ZodNullable<z.ZodString>; mailPostalCode: z.ZodNullable<z.ZodString>; mailCountry: z.ZodNullable<z.ZodString>; physAddress1: z.ZodNullable<z.ZodString>; physAddress2: z.ZodNullable<z.ZodString>; physCity: z.ZodNullable<z.ZodString>; physState: z.ZodNullable<z.ZodString>; physPostalCode: z.ZodNullable<z.ZodString>; physCountry: z.ZodNullable<z.ZodString>; }, "strip", z.ZodTypeAny, { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }, { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }>; }, "strip", z.ZodTypeAny, { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }, { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | 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: { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>, { params: Record<string, unknown> | unknown[]; data: { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: { customerId: number; address: { id: number; name: string | null; physState: string | null; mailState: string | null; mailAddress1: string | null; mailAddress2: string | null; mailCity: string | null; mailPostalCode: string | null; mailCountry: string | null; physAddress1: string | null; physAddress2: string | null; physCity: string | null; physPostalCode: string | null; physCountry: string | null; }; shipToId: number; companyId: string; defaultBranch: string; defaultCarrierId: number | null; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>; export type Address = z.infer<typeof AddressSchema>; export type AddressSub = z.infer<typeof AddressSubSchema>; export type AddressListParams = z.infer<typeof AddressListParamsSchema>; export type ShipToAddress = z.infer<typeof ShipToAddressSchema>; export type ShipToAddressCreateParams = z.infer<typeof ShipToAddressCreateParamsSchema>; export type ShipToAddressListParams = z.infer<typeof ShipToAddressListParamsSchema>; export type AddressListResponse = z.infer<typeof AddressListResponseSchema>; export type ShipToAddressListResponse = z.infer<typeof ShipToAddressListResponseSchema>; export type ShipToAddressResponse = z.infer<typeof ShipToAddressResponseSchema>; //# sourceMappingURL=addresses.d.ts.map