@simpleapps-com/augur-api/dist/cjs/services/commerce/resources/checkout.d.ts

TypeScript client library for Augur microservices API endpoints

import type { CommerceClient } from '../client';
import type { CheckoutCreateRequest, CheckoutDocParams } from '../schemas';
type ExecuteRequest = CommerceClient['executeRequest'];
/**
 * Creates the checkout resource methods
 * OpenAPI Path: /checkout → checkout.*
 * @description End-to-end checkout processing with Prophet21 ERP integration
 */
export declare function createCheckoutResource(executeRequest: ExecuteRequest): {
    /**
     * Create a new checkout session
     * @fullPath api.commerce.checkout.create
     * @service commerce
     * @domain checkout-processing
     * @dataMethod checkoutData.create
     * @discoverable true
     */
    create: (orderData: CheckoutCreateRequest) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            checkoutUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Get checkout details by ID
     * @fullPath api.commerce.checkout.get
     * @service commerce
     * @domain checkout-processing
     * @dataMethod checkoutData.get
     * @discoverable true
     */
    get: (checkoutUid: number) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            checkoutUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Activate Operations
     */
    activate: {
        /**
         * Activate and process checkout
         * @fullPath api.commerce.checkout.activate.update
         * @service commerce
         * @domain checkout-processing
         * @dataMethod checkoutData.activate.update
         * @discoverable true
         */
        update: (checkoutUid: number) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                checkoutUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
    };
    /**
     * Doc Operations
     */
    doc: {
        /**
         * Get formatted checkout document
         * @fullPath api.commerce.checkout.doc.get
         * @service commerce
         * @domain checkout-processing
         * @dataMethod checkoutData.doc.get
         * @discoverable true
         */
        get: (checkoutUid: number, params?: CheckoutDocParams) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                checkoutUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
    };
    /**
     * Validate Operations
     */
    validate: {
        /**
         * Validate checkout data
         * @fullPath api.commerce.checkout.validate.update
         * @service commerce
         * @domain checkout-processing
         * @dataMethod checkoutData.validate.update
         * @discoverable true
         */
        update: (checkoutUid: number) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                checkoutUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
    };
    /**
     * Prophet21 Hdr Operations
     */
    prophet21Hdr: {
        /**
         * Create Prophet21 checkout header
         * @fullPath api.commerce.checkout.prophet21Hdr.create
         * @service commerce
         * @domain erp-integration
         * @dataMethod checkoutData.prophet21Hdr.create
         * @discoverable true
         */
        create: (checkoutUid: number) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                checkoutUid: number;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
        /**
         * Prophet21 Line Operations
         */
        prophet21Line: {
            /**
             * Add Prophet21 checkout lines
             * @fullPath api.commerce.checkout.prophet21Hdr.prophet21Line.create
             * @service commerce
             * @domain erp-integration
             * @dataMethod checkoutData.prophet21Hdr.prophet21Line.create
             * @discoverable true
             */
            create: (checkoutUid: number, prophet21HdrUid: number) => Promise<{
                params: Record<string, unknown> | unknown[];
                data: import("zod").objectInputType<{
                    lineNo: import("zod").ZodNumber;
                }, import("zod").ZodTypeAny, "passthrough">[];
                options: Record<string, unknown> | unknown[];
                status: number;
                message: string;
                count: number;
                total: number;
                totalResults: number;
            }>;
        };
    };
};
/**
 * Creates the checkoutData resource methods (data-only versions)
 */
export declare function createCheckoutDataResource(checkout: ReturnType<typeof createCheckoutResource>): {
    create: (orderData: CheckoutCreateRequest) => Promise<{
        checkoutUid: number;
    } & {
        [k: string]: unknown;
    }>;
    get: (checkoutUid: number) => Promise<{
        checkoutUid: number;
    } & {
        [k: string]: unknown;
    }>;
    activate: {
        update: (checkoutUid: number) => Promise<{
            checkoutUid: number;
        } & {
            [k: string]: unknown;
        }>;
    };
    doc: {
        get: (checkoutUid: number, params?: CheckoutDocParams) => Promise<unknown>;
    };
    validate: {
        update: (checkoutUid: number) => Promise<{
            checkoutUid: number;
        } & {
            [k: string]: unknown;
        }>;
    };
    prophet21Hdr: {
        create: (checkoutUid: number) => Promise<{
            checkoutUid: number;
        } & {
            [k: string]: unknown;
        }>;
        prophet21Line: {
            create: (checkoutUid: number, prophet21HdrUid: number) => Promise<import("zod").objectInputType<{
                lineNo: import("zod").ZodNumber;
            }, import("zod").ZodTypeAny, "passthrough">[]>;
        };
    };
};
export type CheckoutResource = ReturnType<typeof createCheckoutResource>;
export type CheckoutDataResource = ReturnType<typeof createCheckoutDataResource>;
export {};
//# sourceMappingURL=checkout.d.ts.map