@simpleapps-com/augur-api/dist/cjs/services/orders/schemas/orders.d.ts

TypeScript client library for Augur microservices API endpoints

import { z } from 'zod';
export declare const OrderLineSchema: z.ZodObject<{
    lineNo: z.ZodNumber;
    invMastUid: z.ZodNumber;
    itemId: z.ZodString;
    description: z.ZodString;
    qtyOrdered: z.ZodNumber;
    qtyAllocated: z.ZodNumber;
    qtyInvoiced: z.ZodNumber;
    unitPrice: z.ZodNumber;
    extendedPrice: z.ZodNumber;
    unitOfMeasure: z.ZodString;
}, "strip", z.ZodTypeAny, {
    description: string;
    lineNo: number;
    invMastUid: number;
    unitOfMeasure: string;
    unitPrice: number;
    itemId: string;
    qtyAllocated: number;
    qtyInvoiced: number;
    qtyOrdered: number;
    extendedPrice: number;
}, {
    description: string;
    lineNo: number;
    invMastUid: number;
    unitOfMeasure: string;
    unitPrice: number;
    itemId: string;
    qtyAllocated: number;
    qtyInvoiced: number;
    qtyOrdered: number;
    extendedPrice: number;
}>;
export declare const OrderHeaderSchema: z.ZodObject<{
    orderNo: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
    customerId: z.ZodString;
    customerName: z.ZodString;
    orderDate: z.ZodString;
    completed: z.ZodString;
    jobName: z.ZodOptional<z.ZodString>;
    requestedDate: z.ZodOptional<z.ZodString>;
    dateOrderCompleted: z.ZodOptional<z.ZodNullable<z.ZodString>>;
    salesrepId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
    customerId: string;
    customerName: string;
    orderNo: string | number;
    orderDate: string;
    completed: string;
    jobName?: string | undefined;
    requestedDate?: string | undefined;
    dateOrderCompleted?: string | null | undefined;
    salesrepId?: string | undefined;
}, {
    customerId: string;
    customerName: string;
    orderNo: string | number;
    orderDate: string;
    completed: string;
    jobName?: string | undefined;
    requestedDate?: string | undefined;
    dateOrderCompleted?: string | null | undefined;
    salesrepId?: string | undefined;
}>;
export declare const OrderDocumentSchema: z.ZodObject<{
    orderNo: z.ZodNumber;
    customerId: z.ZodString;
    customerName: z.ZodString;
    orderDate: z.ZodString;
    completed: z.ZodString;
    ship2Name: z.ZodOptional<z.ZodString>;
    ship2Address1: z.ZodOptional<z.ZodString>;
    ship2City: z.ZodOptional<z.ZodString>;
    ship2State: z.ZodOptional<z.ZodString>;
    ship2Zip: z.ZodOptional<z.ZodString>;
    freightOut: z.ZodOptional<z.ZodNumber>;
    poNo: z.ZodOptional<z.ZodString>;
    webReferenceNo: z.ZodOptional<z.ZodString>;
    lines: z.ZodArray<z.ZodObject<{
        lineNo: z.ZodNumber;
        invMastUid: z.ZodNumber;
        itemId: z.ZodString;
        description: z.ZodString;
        qtyOrdered: z.ZodNumber;
        qtyAllocated: z.ZodNumber;
        qtyInvoiced: z.ZodNumber;
        unitPrice: z.ZodNumber;
        extendedPrice: z.ZodNumber;
        unitOfMeasure: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        description: string;
        lineNo: number;
        invMastUid: number;
        unitOfMeasure: string;
        unitPrice: number;
        itemId: string;
        qtyAllocated: number;
        qtyInvoiced: number;
        qtyOrdered: number;
        extendedPrice: number;
    }, {
        description: string;
        lineNo: number;
        invMastUid: number;
        unitOfMeasure: string;
        unitPrice: number;
        itemId: string;
        qtyAllocated: number;
        qtyInvoiced: number;
        qtyOrdered: number;
        extendedPrice: number;
    }>, "many">;
}, "strip", z.ZodTypeAny, {
    customerId: string;
    lines: {
        description: string;
        lineNo: number;
        invMastUid: number;
        unitOfMeasure: string;
        unitPrice: number;
        itemId: string;
        qtyAllocated: number;
        qtyInvoiced: number;
        qtyOrdered: number;
        extendedPrice: number;
    }[];
    customerName: string;
    orderNo: number;
    orderDate: string;
    completed: string;
    poNo?: string | undefined;
    ship2Name?: string | undefined;
    ship2City?: string | undefined;
    ship2State?: string | undefined;
    ship2Zip?: string | undefined;
    webReferenceNo?: string | undefined;
    ship2Address1?: string | undefined;
    freightOut?: number | undefined;
}, {
    customerId: string;
    lines: {
        description: string;
        lineNo: number;
        invMastUid: number;
        unitOfMeasure: string;
        unitPrice: number;
        itemId: string;
        qtyAllocated: number;
        qtyInvoiced: number;
        qtyOrdered: number;
        extendedPrice: number;
    }[];
    customerName: string;
    orderNo: number;
    orderDate: string;
    completed: string;
    poNo?: string | undefined;
    ship2Name?: string | undefined;
    ship2City?: string | undefined;
    ship2State?: string | undefined;
    ship2Zip?: string | undefined;
    webReferenceNo?: string | undefined;
    ship2Address1?: string | undefined;
    freightOut?: number | undefined;
}>;
export declare const OrderLookupParamsSchema: z.ZodObject<{
    limit: z.ZodOptional<z.ZodNumber>;
    offset: z.ZodOptional<z.ZodNumber>;
    q: z.ZodOptional<z.ZodString>;
    orderBy: z.ZodOptional<z.ZodString>;
    completed: z.ZodOptional<z.ZodString>;
    dateOrderCompleted: z.ZodOptional<z.ZodString>;
    salesrepId: z.ZodOptional<z.ZodString>;
    taker: z.ZodOptional<z.ZodString>;
    class1Id: z.ZodOptional<z.ZodString>;
    addressId: z.ZodOptional<z.ZodString>;
} & {
    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">>;
}, "strip", z.ZodTypeAny, {
    edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
    limit?: number | undefined;
    offset?: number | undefined;
    q?: string | undefined;
    orderBy?: string | undefined;
    taker?: string | undefined;
    class1Id?: string | undefined;
    addressId?: string | undefined;
    completed?: string | undefined;
    dateOrderCompleted?: string | undefined;
    salesrepId?: 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;
    taker?: string | undefined;
    class1Id?: string | undefined;
    addressId?: string | undefined;
    completed?: string | undefined;
    dateOrderCompleted?: string | undefined;
    salesrepId?: string | undefined;
}>;
export declare const OrderDocumentParamsSchema: z.ZodObject<{
    postalCode: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
    postalCode?: string | undefined;
}, {
    postalCode?: string | undefined;
}>;
export declare const OrderHeaderResponseSchema: z.ZodEffects<z.ZodObject<{
    count: z.ZodNumber;
    data: z.ZodArray<z.ZodObject<{
        orderNo: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
        customerId: z.ZodString;
        customerName: z.ZodString;
        orderDate: z.ZodString;
        completed: z.ZodString;
        jobName: z.ZodOptional<z.ZodString>;
        requestedDate: z.ZodOptional<z.ZodString>;
        dateOrderCompleted: z.ZodOptional<z.ZodNullable<z.ZodString>>;
        salesrepId: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        customerId: string;
        customerName: string;
        orderNo: string | number;
        orderDate: string;
        completed: string;
        jobName?: string | undefined;
        requestedDate?: string | undefined;
        dateOrderCompleted?: string | null | undefined;
        salesrepId?: string | undefined;
    }, {
        customerId: string;
        customerName: string;
        orderNo: string | number;
        orderDate: string;
        completed: string;
        jobName?: string | undefined;
        requestedDate?: string | undefined;
        dateOrderCompleted?: string | null | undefined;
        salesrepId?: 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: {
        customerId: string;
        customerName: string;
        orderNo: string | number;
        orderDate: string;
        completed: string;
        jobName?: string | undefined;
        requestedDate?: string | undefined;
        dateOrderCompleted?: string | null | undefined;
        salesrepId?: string | undefined;
    }[];
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}, {
    params: Record<string, unknown> | unknown[];
    data: {
        customerId: string;
        customerName: string;
        orderNo: string | number;
        orderDate: string;
        completed: string;
        jobName?: string | undefined;
        requestedDate?: string | undefined;
        dateOrderCompleted?: string | null | undefined;
        salesrepId?: string | undefined;
    }[];
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}>, {
    params: Record<string, unknown> | unknown[];
    data: {
        customerId: string;
        customerName: string;
        orderNo: string | number;
        orderDate: string;
        completed: string;
        jobName?: string | undefined;
        requestedDate?: string | undefined;
        dateOrderCompleted?: string | null | undefined;
        salesrepId?: string | undefined;
    }[];
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}, {
    params: Record<string, unknown> | unknown[];
    data: {
        customerId: string;
        customerName: string;
        orderNo: string | number;
        orderDate: string;
        completed: string;
        jobName?: string | undefined;
        requestedDate?: string | undefined;
        dateOrderCompleted?: string | null | undefined;
        salesrepId?: string | undefined;
    }[];
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}>;
export declare const OrderDocumentResponseSchema: z.ZodEffects<z.ZodObject<{
    count: z.ZodNumber;
    data: z.ZodObject<{
        orderNo: z.ZodNumber;
        customerId: z.ZodString;
        customerName: z.ZodString;
        orderDate: z.ZodString;
        completed: z.ZodString;
        ship2Name: z.ZodOptional<z.ZodString>;
        ship2Address1: z.ZodOptional<z.ZodString>;
        ship2City: z.ZodOptional<z.ZodString>;
        ship2State: z.ZodOptional<z.ZodString>;
        ship2Zip: z.ZodOptional<z.ZodString>;
        freightOut: z.ZodOptional<z.ZodNumber>;
        poNo: z.ZodOptional<z.ZodString>;
        webReferenceNo: z.ZodOptional<z.ZodString>;
        lines: z.ZodArray<z.ZodObject<{
            lineNo: z.ZodNumber;
            invMastUid: z.ZodNumber;
            itemId: z.ZodString;
            description: z.ZodString;
            qtyOrdered: z.ZodNumber;
            qtyAllocated: z.ZodNumber;
            qtyInvoiced: z.ZodNumber;
            unitPrice: z.ZodNumber;
            extendedPrice: z.ZodNumber;
            unitOfMeasure: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            description: string;
            lineNo: number;
            invMastUid: number;
            unitOfMeasure: string;
            unitPrice: number;
            itemId: string;
            qtyAllocated: number;
            qtyInvoiced: number;
            qtyOrdered: number;
            extendedPrice: number;
        }, {
            description: string;
            lineNo: number;
            invMastUid: number;
            unitOfMeasure: string;
            unitPrice: number;
            itemId: string;
            qtyAllocated: number;
            qtyInvoiced: number;
            qtyOrdered: number;
            extendedPrice: number;
        }>, "many">;
    }, "strip", z.ZodTypeAny, {
        customerId: string;
        lines: {
            description: string;
            lineNo: number;
            invMastUid: number;
            unitOfMeasure: string;
            unitPrice: number;
            itemId: string;
            qtyAllocated: number;
            qtyInvoiced: number;
            qtyOrdered: number;
            extendedPrice: number;
        }[];
        customerName: string;
        orderNo: number;
        orderDate: string;
        completed: string;
        poNo?: string | undefined;
        ship2Name?: string | undefined;
        ship2City?: string | undefined;
        ship2State?: string | undefined;
        ship2Zip?: string | undefined;
        webReferenceNo?: string | undefined;
        ship2Address1?: string | undefined;
        freightOut?: number | undefined;
    }, {
        customerId: string;
        lines: {
            description: string;
            lineNo: number;
            invMastUid: number;
            unitOfMeasure: string;
            unitPrice: number;
            itemId: string;
            qtyAllocated: number;
            qtyInvoiced: number;
            qtyOrdered: number;
            extendedPrice: number;
        }[];
        customerName: string;
        orderNo: number;
        orderDate: string;
        completed: string;
        poNo?: string | undefined;
        ship2Name?: string | undefined;
        ship2City?: string | undefined;
        ship2State?: string | undefined;
        ship2Zip?: string | undefined;
        webReferenceNo?: string | undefined;
        ship2Address1?: string | undefined;
        freightOut?: 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: {
        customerId: string;
        lines: {
            description: string;
            lineNo: number;
            invMastUid: number;
            unitOfMeasure: string;
            unitPrice: number;
            itemId: string;
            qtyAllocated: number;
            qtyInvoiced: number;
            qtyOrdered: number;
            extendedPrice: number;
        }[];
        customerName: string;
        orderNo: number;
        orderDate: string;
        completed: string;
        poNo?: string | undefined;
        ship2Name?: string | undefined;
        ship2City?: string | undefined;
        ship2State?: string | undefined;
        ship2Zip?: string | undefined;
        webReferenceNo?: string | undefined;
        ship2Address1?: string | undefined;
        freightOut?: number | undefined;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}, {
    params: Record<string, unknown> | unknown[];
    data: {
        customerId: string;
        lines: {
            description: string;
            lineNo: number;
            invMastUid: number;
            unitOfMeasure: string;
            unitPrice: number;
            itemId: string;
            qtyAllocated: number;
            qtyInvoiced: number;
            qtyOrdered: number;
            extendedPrice: number;
        }[];
        customerName: string;
        orderNo: number;
        orderDate: string;
        completed: string;
        poNo?: string | undefined;
        ship2Name?: string | undefined;
        ship2City?: string | undefined;
        ship2State?: string | undefined;
        ship2Zip?: string | undefined;
        webReferenceNo?: string | undefined;
        ship2Address1?: string | undefined;
        freightOut?: number | undefined;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}>, {
    params: Record<string, unknown> | unknown[];
    data: {
        customerId: string;
        lines: {
            description: string;
            lineNo: number;
            invMastUid: number;
            unitOfMeasure: string;
            unitPrice: number;
            itemId: string;
            qtyAllocated: number;
            qtyInvoiced: number;
            qtyOrdered: number;
            extendedPrice: number;
        }[];
        customerName: string;
        orderNo: number;
        orderDate: string;
        completed: string;
        poNo?: string | undefined;
        ship2Name?: string | undefined;
        ship2City?: string | undefined;
        ship2State?: string | undefined;
        ship2Zip?: string | undefined;
        webReferenceNo?: string | undefined;
        ship2Address1?: string | undefined;
        freightOut?: number | undefined;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}, {
    params: Record<string, unknown> | unknown[];
    data: {
        customerId: string;
        lines: {
            description: string;
            lineNo: number;
            invMastUid: number;
            unitOfMeasure: string;
            unitPrice: number;
            itemId: string;
            qtyAllocated: number;
            qtyInvoiced: number;
            qtyOrdered: number;
            extendedPrice: number;
        }[];
        customerName: string;
        orderNo: number;
        orderDate: string;
        completed: string;
        poNo?: string | undefined;
        ship2Name?: string | undefined;
        ship2City?: string | undefined;
        ship2State?: string | undefined;
        ship2Zip?: string | undefined;
        webReferenceNo?: string | undefined;
        ship2Address1?: string | undefined;
        freightOut?: number | undefined;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}>;
export type OrderLine = z.infer<typeof OrderLineSchema>;
export type OrderHeader = z.infer<typeof OrderHeaderSchema>;
export type OrderDocument = z.infer<typeof OrderDocumentSchema>;
export type OrderLookupParams = z.infer<typeof OrderLookupParamsSchema>;
export type OrderDocumentParams = z.infer<typeof OrderDocumentParamsSchema>;
export type OrderHeaderResponse = z.infer<typeof OrderHeaderResponseSchema>;
export type OrderDocumentResponse = z.infer<typeof OrderDocumentResponseSchema>;
//# sourceMappingURL=orders.d.ts.map