@simpleapps-com/augur-api 0.5.1 → 0.7.0

package/dist/cjs/services/orders/client.d.ts

@@ -1,6 +1,6 @@
 import { HTTPClient } from '../../core/client';
 import { BaseServiceClient } from '../../core/base-client';
-import { type OeHdrDocParams, type OeHdrLookupParams, type PurchaseOrderListParams, type PurchaseOrderScanParams, type PickTicketsListParams, type PickTicketsLinesParams } from './schemas';
+import { type HealthCheckResource, type HealthCheckDataResource, type InvoiceHdrResource, type InvoiceHdrDataResource, type OeHdrResource, type OeHdrDataResource, type OeHdrSalesrepResource, type OeHdrSalesrepDataResource, type PickTicketsResource, type PickTicketsDataResource, type PoHdrResource, type PoHdrDataResource } from './resources';
 /**
  * Orders Service Client - OpenAPI Path Mirroring Implementation
  * @description Comprehensive order management functionality for the Augur platform covering the complete order lifecycle from creation through fulfillment, including order processing, invoicing, purchase orders, and sales representative management. Follows strict OpenAPI path mirroring pattern.
@@ -37,917 +37,35 @@ import { type OeHdrDocParams, type OeHdrLookupParams, type PurchaseOrderListPara
  * ```
  */
 export declare class OrdersClient extends BaseServiceClient {
+    /** Health check resource */
+    readonly healthCheck: HealthCheckResource;
+    /** Health check data resource (data-only) */
+    readonly healthCheckData: HealthCheckDataResource;
+    /** Invoice header resource */
+    readonly invoiceHdr: InvoiceHdrResource;
+    /** Invoice header data resource (data-only) */
+    readonly invoiceHdrData: InvoiceHdrDataResource;
+    /** Order header resource */
+    readonly oeHdr: OeHdrResource;
+    /** Order header data resource (data-only) */
+    readonly oeHdrData: OeHdrDataResource;
+    /** Sales representative order header resource */
+    readonly oeHdrSalesrep: OeHdrSalesrepResource;
+    /** Sales representative order header data resource (data-only) */
+    readonly oeHdrSalesrepData: OeHdrSalesrepDataResource;
+    /** Pick tickets resource */
+    readonly pickTickets: PickTicketsResource;
+    /** Pick tickets data resource (data-only) */
+    readonly pickTicketsData: PickTicketsDataResource;
+    /** Purchase order header resource */
+    readonly poHdr: PoHdrResource;
+    /** Purchase order header data resource (data-only) */
+    readonly poHdrData: PoHdrDataResource;
     /**
      * Create a new OrdersClient instance
      * @param http Configured HTTPClient instance with authentication
      * @param baseUrl Base URL for the Orders API (default: https://orders.augur-api.com)
      */
     constructor(http: HTTPClient, baseUrl?: string);
-    /**
-     * Health check endpoint
-     * @description Service health and status monitoring endpoint for system diagnostics and uptime verification
-     *
-     * @fullPath api.orders.healthCheck.get
-     * @service orders
-     * @domain system-monitoring
-     * @dataMethod getData - returns only the health check data without metadata
-     * @discoverable true
-     * @searchTerms ["health check", "service status", "orders health", "system status"]
-     * @relatedEndpoints ["api.joomla.healthCheck.get", "api.nexus.healthCheck.get", "api.items.healthCheck.get"]
-     * @commonPatterns ["Check service health", "System monitoring", "Service status"]
-     * @workflow ["system-monitoring", "health-diagnostics"]
-     * @functionalArea "system-operations"
-     * @performance "Lightweight endpoint for monitoring - minimal response time"
-     */
-    healthCheck: {
-        get: () => Promise<{
-            params: Record<string, unknown> | unknown[];
-            data: {
-                siteHash: string;
-                siteId: string;
-            };
-            options: Record<string, unknown> | unknown[];
-            status: number;
-            message: string;
-            count: number;
-            total: number;
-            totalResults: number;
-        }>;
-        /**
-         * Get only health check data without response metadata
-         * @returns Promise<HealthCheckData> Direct health check data object
-         */
-        getData: () => Promise<{
-            siteHash: string;
-            siteId: string;
-        }>;
-    };
-    /**
-     * Invoice Header Operations - OpenAPI Path: /invoice-hdr
-     * @description Invoice processing and document management with Prophet 21 integration for billing and accounting workflows following OpenAPI path mirroring pattern
-     */
-    invoiceHdr: {
-        /**
-         * Invoice reprint operations - OpenAPI Path: /invoice-hdr/{invoiceNo}/reprint
-         */
-        reprint: {
-            /**
-             * Reprint an existing invoice through Prophet 21 integration
-             * @description Generates a reprint of an existing invoice through Prophet 21 system integration. Returns invoice document data and reprint status for billing and customer service workflows.
-             *
-             * @fullPath api.orders.invoiceHdr.reprint.get
-             * @service orders
-             * @domain invoice-management
-             * @dataMethod getData - returns only the reprint result without metadata
-             * @discoverable true
-             * @searchTerms ["invoice reprint", "reprint invoice", "invoice copy", "duplicate invoice", "invoice document"]
-             * @relatedEndpoints ["api.orders.oeHdr.doc.get", "api.customers.customer.get", "api.p21-core.company.get"]
-             * @commonPatterns ["Reprint invoice", "Customer invoice copy", "Billing document", "Invoice duplicate"]
-             * @workflow ["invoice-management", "customer-service", "billing-workflow"]
-             * @prerequisites ["Valid invoice number", "Invoice exists in Prophet 21", "Reprint permissions"]
-             * @nextSteps ["Deliver invoice to customer", "Update billing records", "Customer service follow-up"]
-             * @businessRules ["Invoice must exist in Prophet 21", "Reprint creates audit trail", "Formatting matches original invoice"]
-             * @functionalArea "billing-and-invoicing"
-             * @performance "Integrates with Prophet 21 - response time depends on P21 system load"
-             */
-            get: (invoiceNo: number) => Promise<{
-                params: Record<string, unknown> | unknown[];
-                data: {
-                    invoiceNo: number;
-                } & {
-                    [k: string]: unknown;
-                };
-                options: Record<string, unknown> | unknown[];
-                status: number;
-                message: string;
-                count: number;
-                total: number;
-                totalResults: number;
-            }>;
-            /**
-             * Get only invoice reprint data without response metadata
-             * @param invoiceNo Invoice number to reprint
-             * @returns Promise<InvoiceReprintResult> Direct reprint result object
-             */
-            getData: (invoiceNo: number) => Promise<{
-                invoiceNo: number;
-            } & {
-                [k: string]: unknown;
-            }>;
-        };
-    };
-    /**
-     * Order Header Operations - OpenAPI Path: /oe-hdr
-     * @description Core order management functionality for searching, tracking, and retrieving sales orders following OpenAPI path mirroring pattern
-     */
-    oeHdr: {
-        /**
-         * Order lookup operations - OpenAPI Path: /oe-hdr/lookup
-         */
-        lookup: {
-            /**
-             * Search and list order headers with flexible filtering options
-             * @description Returns paginated order headers with comprehensive filtering by customer, date, status, sales rep, and search terms. Supports edge caching for improved performance.
-             *
-             * @fullPath api.orders.oeHdr.lookup.list
-             * @service orders
-             * @domain order-management
-             * @dataMethod listData - returns only the order headers array without metadata
-             * @discoverable true
-             * @searchTerms ["order lookup", "search orders", "order list", "find orders", "order search", "sales orders"]
-             * @relatedEndpoints ["api.orders.oeHdr.doc.get", "api.customers.customer.list", "api.orders.oeHdrSalesrep.oeHdr.list"]
-             * @commonPatterns ["Search orders by customer", "Find orders by order number", "List incomplete orders", "Filter by date range"]
-             * @workflow ["order-discovery", "order-status-tracking", "customer-order-history"]
-             * @prerequisites ["Valid authentication token", "Order access permissions"]
-             * @nextSteps ["api.orders.oeHdr.doc.get for full details", "api.customers.customer.get for customer info"]
-             * @businessRules ["Returns only orders accessible to current user/sales rep", "Completed orders may have restricted access", "Search supports partial matches"]
-             * @functionalArea "order-and-fulfillment-management"
-             * @caching "Supports edgeCache parameter (1-8 hours) for frequently accessed order lists"
-             * @performance "Use pagination for large result sets. Filter by specific criteria to improve performance."
-             */
-            list: (params?: {
-                limit?: number | undefined;
-                offset?: number | undefined;
-                edgeCache?: number | undefined;
-                q?: string | undefined;
-                orderBy?: string | undefined;
-                taker?: string | undefined;
-                class1Id?: string | undefined;
-                completed?: string | undefined;
-                dateOrderCompleted?: string | undefined;
-                salesrepId?: string | undefined;
-            } | undefined) => Promise<{
-                params: Record<string, unknown> | unknown[];
-                data: import("zod").objectInputType<{
-                    orderNo: import("zod").ZodNumber;
-                }, import("zod").ZodTypeAny, "passthrough">[];
-                options: Record<string, unknown> | unknown[];
-                status: number;
-                message: string;
-                count: number;
-                total: number;
-                totalResults: number;
-            }>;
-            /**
-             * Get only order headers data without response metadata
-             * @param params Same parameters as list() method
-             * @returns Promise<OrderHeader[]> Direct array of order headers
-             */
-            listData: (params?: OeHdrLookupParams) => Promise<import("zod").objectInputType<{
-                orderNo: import("zod").ZodNumber;
-            }, import("zod").ZodTypeAny, "passthrough">[]>;
-        };
-        /**
-         * Order document operations - OpenAPI Path: /oe-hdr/{orderNo}/doc
-         */
-        doc: {
-            /**
-             * Retrieve complete order document with all related information
-             * @description Returns comprehensive order details including customer info, shipping address, line items, and totals. Includes optional postal code validation for security.
-             *
-             * @fullPath api.orders.oeHdr.doc.get
-             * @service orders
-             * @domain order-management
-             * @dataMethod getData - returns only the order document without metadata
-             * @discoverable true
-             * @searchTerms ["order document", "order details", "full order", "order with lines", "complete order"]
-             * @relatedEndpoints ["api.orders.oeHdr.lookup.list", "api.customers.customer.get", "api.items.products.get"]
-             * @commonPatterns ["Get order details", "View complete order", "Order with line items", "Full order document"]
-             * @workflow ["order-review", "order-fulfillment", "customer-service"]
-             * @prerequisites ["Valid order number", "Order access permissions", "Optional postal code for validation"]
-             * @nextSteps ["Process order fulfillment", "Update order status", "Generate invoice"]
-             * @businessRules ["Postal code validation optional but recommended for security", "Access restricted by sales rep permissions", "Includes all order line items and totals"]
-             * @functionalArea "order-and-fulfillment-management"
-             * @performance "Single document retrieval - no pagination needed. Consider caching for frequently accessed orders."
-             */
-            get: (orderNo: number, params?: OeHdrDocParams) => Promise<{
-                params: Record<string, unknown> | unknown[];
-                data: {
-                    orderNo: number;
-                } & {
-                    [k: string]: unknown;
-                };
-                options: Record<string, unknown> | unknown[];
-                status: number;
-                message: string;
-                count: number;
-                total: number;
-                totalResults: number;
-            }>;
-            /**
-             * Get only order document data without response metadata
-             * @param orderNo Order number to retrieve
-             * @param params Optional parameters including postal code validation
-             * @returns Promise<OrderDocument> Direct order document object
-             */
-            getData: (orderNo: number, params?: OeHdrDocParams) => Promise<{
-                orderNo: number;
-            } & {
-                [k: string]: unknown;
-            }>;
-        };
-    };
-    /**
-     * Sales Representative Order Header Operations - OpenAPI Path: /oe-hdr-salesrep
-     * @description Order management functionality specific to sales representatives including territory-based order access and rep-specific reporting following OpenAPI path mirroring pattern
-     */
-    oeHdrSalesrep: {
-        /**
-         * Sales representative order operations - OpenAPI Path: /oe-hdr-salesrep/{salesrepId}/oe-hdr
-         */
-        oeHdr: {
-            /**
-             * Get order list for a specific sales representative
-             * @description Returns all orders associated with a specific sales representative, filtered by territory and permissions. Essential for sales performance tracking and customer relationship management.
-             *
-             * @fullPath api.orders.oeHdrSalesrep.oeHdr.list
-             * @service orders
-             * @domain sales-management
-             * @dataMethod listData - returns only the orders array without metadata
-             * @discoverable true
-             * @searchTerms ["sales rep orders", "representative orders", "territory orders", "sales orders by rep", "rep performance"]
-             * @relatedEndpoints ["api.orders.oeHdrSalesrep.oeHdr.doc.get", "api.orders.oeHdr.lookup.list", "api.customers.customer.list"]
-             * @commonPatterns ["Sales rep performance", "Territory management", "Rep order history", "Sales tracking"]
-             * @workflow ["sales-performance-tracking", "territory-management", "commission-calculation"]
-             * @prerequisites ["Valid sales representative ID", "Sales rep access permissions"]
-             * @nextSteps ["api.orders.oeHdrSalesrep.oeHdr.doc.get for details", "Calculate commission totals", "Territory analysis"]
-             * @businessRules ["Returns only orders within rep's territory", "Respects sales hierarchy permissions", "May include completed and pending orders"]
-             * @functionalArea "sales-and-territory-management"
-             * @performance "Territory-filtered results - typically smaller datasets than global order lists"
-             */
-            list: (salesrepId: number) => Promise<{
-                params: Record<string, unknown> | unknown[];
-                data: {
-                    customerId: string;
-                    customerName: string;
-                    orderNo: string | number;
-                    orderDate: string;
-                    completed: string;
-                    dateOrderCompleted?: string | null | undefined;
-                    jobName?: string | undefined;
-                    requestedDate?: string | undefined;
-                }[];
-                options: Record<string, unknown> | unknown[];
-                status: number;
-                message: string;
-                count: number;
-                total: number;
-                totalResults: number;
-            }>;
-            /**
-             * Get only sales rep orders data without response metadata
-             * @param salesrepId Sales representative ID
-             * @returns Promise<SalesRepOrder[]> Direct array of sales rep orders
-             */
-            listData: (salesrepId: number) => Promise<{
-                customerId: string;
-                customerName: string;
-                orderNo: string | number;
-                orderDate: string;
-                completed: string;
-                dateOrderCompleted?: string | null | undefined;
-                jobName?: string | undefined;
-                requestedDate?: string | undefined;
-            }[]>;
-            /**
-             * Sales rep order document operations - OpenAPI Path: /oe-hdr-salesrep/{salesrepId}/oe-hdr/{orderNo}/doc
-             */
-            doc: {
-                /**
-                 * Get specific order document for a sales representative
-                 * @description Returns complete order document with sales rep context, including commission details and territory-specific information. Validates that the order belongs to the specified sales representative.
-                 *
-                 * @fullPath api.orders.oeHdrSalesrep.oeHdr.doc.get
-                 * @service orders
-                 * @domain sales-management
-                 * @dataMethod getData - returns only the order document without metadata
-                 * @discoverable true
-                 * @searchTerms ["sales rep order document", "rep order details", "territory order document", "rep order with lines"]
-                 * @relatedEndpoints ["api.orders.oeHdrSalesrep.oeHdr.list", "api.orders.oeHdr.doc.get", "api.customers.customer.get"]
-                 * @commonPatterns ["Rep order details", "Commission calculation", "Territory order review", "Sales order analysis"]
-                 * @workflow ["sales-order-review", "commission-processing", "territory-analysis"]
-                 * @prerequisites ["Valid sales rep ID", "Valid order number", "Order must belong to specified rep"]
-                 * @nextSteps ["Calculate commission", "Update order status", "Customer follow-up"]
-                 * @businessRules ["Order must belong to specified sales rep", "Includes commission and territory data", "Access controlled by sales hierarchy"]
-                 * @functionalArea "sales-and-territory-management"
-                 * @performance "Single document retrieval with rep validation - efficient for territory-specific access"
-                 */
-                get: (salesrepId: number, orderNo: number) => Promise<{
-                    params: Record<string, unknown> | unknown[];
-                    data: {
-                        customerId: string;
-                        lines: unknown[];
-                        orderNo: number;
-                        orderDate: string;
-                        completed: string;
-                        jobName?: string | undefined;
-                        ship2Name?: string | undefined;
-                        ship2Address1?: string | undefined;
-                        invoices?: unknown[] | undefined;
-                        pickTickets?: unknown[] | undefined;
-                    };
-                    options: Record<string, unknown> | unknown[];
-                    status: number;
-                    message: string;
-                    count: number;
-                    total: number;
-                    totalResults: number;
-                }>;
-                /**
-                 * Get only sales rep order document data without response metadata
-                 * @param salesrepId Sales representative ID
-                 * @param orderNo Order number to retrieve
-                 * @returns Promise<SalesRepOrderDocument> Direct sales rep order document object
-                 */
-                getData: (salesrepId: number, orderNo: number) => Promise<{
-                    customerId: string;
-                    lines: unknown[];
-                    orderNo: number;
-                    orderDate: string;
-                    completed: string;
-                    jobName?: string | undefined;
-                    ship2Name?: string | undefined;
-                    ship2Address1?: string | undefined;
-                    invoices?: unknown[] | undefined;
-                    pickTickets?: unknown[] | undefined;
-                }>;
-            };
-        };
-    };
-    /**
-     * Pick Tickets Operations - OpenAPI Path: /pick-tickets
-     * @description Pick ticket management for warehouse fulfillment and order picking workflows following OpenAPI path mirroring pattern
-     */
-    pickTickets: {
-        /**
-         * List pick tickets with filtering and pagination - OpenAPI Path: /pick-tickets
-         * @description Returns paginated pick tickets with comprehensive filtering by company, location, order status, and other criteria. Essential for warehouse management and order fulfillment workflows.
-         *
-         * @fullPath api.orders.pickTickets.list
-         * @service orders
-         * @domain warehouse-fulfillment
-         * @dataMethod listData - returns only the pick tickets array without metadata
-         * @discoverable true
-         * @searchTerms ["pick tickets", "warehouse fulfillment", "order picking", "pick ticket list", "fulfillment tracking"]
-         * @relatedEndpoints ["api.orders.pickTickets.get", "api.orders.oeHdr.lookup.list", "api.orders.oeHdr.doc.get"]
-         * @commonPatterns ["List pending pick tickets", "Filter by location", "Track picking status", "Warehouse dashboard"]
-         * @workflow ["warehouse-fulfillment", "order-picking", "fulfillment-tracking"]
-         * @prerequisites ["Valid authentication", "Warehouse access permissions"]
-         * @nextSteps ["api.orders.pickTickets.get for details", "Update picking status", "Process fulfillment"]
-         * @businessRules ["Filters by location and company", "Supports order and status filtering", "Pagination required for large datasets"]
-         * @functionalArea "warehouse-and-fulfillment"
-         * @performance "Use filtering to reduce result sets. Consider pagination for better performance."
-         */
-        list: (params?: {
-            limit?: number | undefined;
-            offset?: number | undefined;
-            q?: string | undefined;
-            orderBy?: string | undefined;
-            deleteFlag?: string | undefined;
-            companyId?: string | undefined;
-            locationId?: number | undefined;
-            orderNo?: string | undefined;
-            printedFlag?: string | undefined;
-        } | undefined) => Promise<{
-            params: Record<string, unknown> | unknown[];
-            data: import("zod").objectInputType<{
-                pickTicketNo: import("zod").ZodNumber;
-            }, import("zod").ZodTypeAny, "passthrough">[];
-            options: Record<string, unknown> | unknown[];
-            status: number;
-            message: string;
-            count: number;
-            total: number;
-            totalResults: number;
-        }>;
-        /**
-         * Get only pick tickets data without response metadata
-         * @param params Same parameters as list() method
-         * @returns Promise<PickTicketData[]> Direct array of pick tickets
-         */
-        listData: (params?: PickTicketsListParams) => Promise<import("zod").objectInputType<{
-            pickTicketNo: import("zod").ZodNumber;
-        }, import("zod").ZodTypeAny, "passthrough">[]>;
-        /**
-         * Get detailed pick ticket information - OpenAPI Path: /pick-tickets/{pickTicketNo}
-         * @description Returns comprehensive pick ticket details including order information, shipping details, tracking, and fulfillment status. Critical for warehouse operations and order tracking.
-         *
-         * @fullPath api.orders.pickTickets.get
-         * @service orders
-         * @domain warehouse-fulfillment
-         * @dataMethod getData - returns only the pick ticket detail without metadata
-         * @discoverable true
-         * @searchTerms ["pick ticket details", "pick ticket info", "fulfillment details", "warehouse pick ticket"]
-         * @relatedEndpoints ["api.orders.pickTickets.list", "api.orders.oeHdr.doc.get", "api.orders.invoiceHdr.reprint.get"]
-         * @commonPatterns ["Get pick ticket details", "View pick ticket", "Track fulfillment", "Shipping information"]
-         * @workflow ["pick-ticket-review", "fulfillment-processing", "shipping-preparation"]
-         * @prerequisites ["Valid pick ticket number", "Warehouse access permissions"]
-         * @nextSteps ["Update fulfillment status", "Process shipping", "Generate tracking"]
-         * @businessRules ["Pick ticket number must be valid", "Access controlled by location permissions", "Includes shipping and tracking details"]
-         * @functionalArea "warehouse-and-fulfillment"
-         * @performance "Single pick ticket retrieval - efficient for detail information"
-         */
-        get: (pickTicketNo: number) => Promise<{
-            params: Record<string, unknown> | unknown[];
-            data: {
-                pickTicketNo: number;
-            } & {
-                [k: string]: unknown;
-            };
-            options: Record<string, unknown> | unknown[];
-            status: number;
-            message: string;
-            count: number;
-            total: number;
-            totalResults: number;
-        }>;
-        /**
-         * Get only pick ticket detail data without response metadata
-         * @param pickTicketNo Pick ticket number to retrieve
-         * @returns Promise<PickTicketData> Direct pick ticket detail object
-         */
-        getData: (pickTicketNo: number) => Promise<{
-            pickTicketNo: number;
-        } & {
-            [k: string]: unknown;
-        }>;
-        /**
-         * Pick ticket lines operations - OpenAPI Path: /pick-tickets/{pickTicketNo}/lines
-         */
-        lines: {
-            /**
-             * List pick ticket lines for a specific pick ticket
-             * @description Returns paginated pick ticket lines with detailed line item information including quantities, item details, and fulfillment status. Essential for warehouse picking operations and line-level tracking.
-             *
-             * @fullPath api.orders.pickTickets.lines.list
-             * @service orders
-             * @domain warehouse-fulfillment
-             * @dataMethod listData - returns only the pick ticket lines array without metadata
-             * @discoverable true
-             * @searchTerms ["pick ticket lines", "pick ticket items", "line items", "picking details", "warehouse lines"]
-             * @relatedEndpoints ["api.orders.pickTickets.get", "api.orders.pickTickets.list", "api.items.products.get"]
-             * @commonPatterns ["List pick ticket lines", "View line items", "Track picking by line", "Line-level fulfillment"]
-             * @workflow ["pick-ticket-fulfillment", "line-item-picking", "inventory-tracking"]
-             * @prerequisites ["Valid pick ticket number", "Warehouse access permissions"]
-             * @nextSteps ["Update line quantities", "Mark lines as picked", "Process line-level fulfillment"]
-             * @businessRules ["Lines are ordered by line number", "Supports pagination", "Includes quantity and item details"]
-             * @functionalArea "warehouse-and-fulfillment"
-             * @performance "Use pagination for pick tickets with many lines. Default ordering by line_number|ASC."
-             */
-            list: (pickTicketNo: number, params?: PickTicketsLinesParams) => Promise<{
-                params: Record<string, unknown> | unknown[];
-                data: import("zod").objectInputType<{
-                    pickTicketNo: import("zod").ZodNumber;
-                    lineNumber: import("zod").ZodNumber;
-                }, import("zod").ZodTypeAny, "passthrough">[];
-                options: Record<string, unknown> | unknown[];
-                status: number;
-                message: string;
-                count: number;
-                total: number;
-                totalResults: number;
-            }>;
-            /**
-             * Get only pick ticket lines data without response metadata
-             * @param pickTicketNo Pick ticket number to retrieve lines for
-             * @param params Same parameters as list() method
-             * @returns Promise<PickTicketLineData[]> Direct array of pick ticket lines
-             */
-            listData: (pickTicketNo: number, params?: PickTicketsLinesParams) => Promise<import("zod").objectInputType<{
-                pickTicketNo: import("zod").ZodNumber;
-                lineNumber: import("zod").ZodNumber;
-            }, import("zod").ZodTypeAny, "passthrough">[]>;
-            /**
-             * Get specific pick ticket line detail
-             * @description Returns detailed information for a specific line within a pick ticket including quantities, item details, and fulfillment status. Used for individual line tracking and updates.
-             *
-             * @fullPath api.orders.pickTickets.lines.get
-             * @service orders
-             * @domain warehouse-fulfillment
-             * @dataMethod getData - returns only the pick ticket line data without metadata
-             * @discoverable true
-             * @searchTerms ["pick ticket line detail", "single line item", "line detail", "individual picking line"]
-             * @relatedEndpoints ["api.orders.pickTickets.lines.list", "api.orders.pickTickets.get", "api.items.products.get"]
-             * @commonPatterns ["Get line detail", "View single line item", "Update line status", "Line-specific operations"]
-             * @workflow ["line-item-fulfillment", "individual-line-tracking", "line-status-updates"]
-             * @prerequisites ["Valid pick ticket number", "Valid line number", "Warehouse access permissions"]
-             * @nextSteps ["Update line quantities", "Mark line as picked", "Process line fulfillment"]
-             * @businessRules ["Line must exist in pick ticket", "Returns complete line details", "Includes item and quantity information"]
-             * @functionalArea "warehouse-and-fulfillment"
-             * @performance "Single line retrieval - efficient for detail operations"
-             */
-            get: (pickTicketNo: number, lineNumber: number) => Promise<{
-                params: Record<string, unknown> | unknown[];
-                data: {
-                    pickTicketNo: number;
-                    lineNumber: number;
-                } & {
-                    [k: string]: unknown;
-                };
-                options: Record<string, unknown> | unknown[];
-                status: number;
-                message: string;
-                count: number;
-                total: number;
-                totalResults: number;
-            }>;
-            /**
-             * Get only pick ticket line detail data without response metadata
-             * @param pickTicketNo Pick ticket number
-             * @param lineNumber Line number to retrieve
-             * @returns Promise<PickTicketLineData> Direct pick ticket line data object
-             */
-            getData: (pickTicketNo: number, lineNumber: number) => Promise<{
-                pickTicketNo: number;
-                lineNumber: number;
-            } & {
-                [k: string]: unknown;
-            }>;
-        };
-    };
-    /**
-     * Purchase Order Header Operations - OpenAPI Path: /po-hdr
-     * @description Comprehensive purchase order management including creation, tracking, receiving, and document generation for procurement workflows following OpenAPI path mirroring pattern
-     */
-    poHdr: {
-        /**
-         * List purchase orders with filtering and pagination - OpenAPI Path: /po-hdr
-         * @description Returns paginated purchase orders with comprehensive filtering by status, vendor, date ranges, and completion status. Essential for procurement management and receiving workflows.
-         *
-         * @fullPath api.orders.poHdr.list
-         * @service orders
-         * @domain procurement-management
-         * @dataMethod listData - returns only the purchase orders array without metadata
-         * @discoverable true
-         * @searchTerms ["purchase orders", "PO list", "procurement", "vendor orders", "purchase order management", "receiving"]
-         * @relatedEndpoints ["api.orders.poHdr.get", "api.orders.poHdr.doc.get", "api.orders.poHdr.scan.create", "api.nexus.receiving.list"]
-         * @commonPatterns ["List open POs", "Find POs by vendor", "Track receiving status", "Procurement dashboard"]
-         * @workflow ["procurement-workflow", "purchase-order-lifecycle", "receiving-management"]
-         * @prerequisites ["Valid authentication", "Purchase order access permissions"]
-         * @nextSteps ["api.orders.poHdr.get for details", "api.nexus.receiving.create for receiving", "Update PO status"]
-         * @businessRules ["Filters by completion status", "Supports vendor and date filtering", "Pagination required for large datasets"]
-         * @functionalArea "procurement-and-purchasing"
-         * @performance "Use filtering to reduce result sets. Consider pagination for better performance."
-         */
-        list: (params?: {
-            limit?: number | undefined;
-            offset?: number | undefined;
-            edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
-            q?: string | undefined;
-            orderBy?: string | undefined;
-            locationId?: number | undefined;
-            complete?: string | undefined;
-        } | undefined) => Promise<{
-            params: Record<string, unknown> | unknown[];
-            data: {
-                poNo: number;
-                vendorId: number;
-                vendorName: string | null;
-                complete: string;
-                lines?: unknown[] | undefined;
-                locationId?: number | undefined;
-                totalAmount?: number | undefined;
-                orderDate?: unknown;
-                ship2Name?: string | null | undefined;
-                poHdrUid?: number | undefined;
-                supplierId?: number | undefined;
-                supplierName?: string | null | undefined;
-                divisionId?: number | undefined;
-                poDate?: string | undefined;
-                companyNo?: string | undefined;
-                packingSlipNumber?: unknown;
-                ship2Add1?: string | null | undefined;
-                ship2Add2?: string | null | undefined;
-                expedite?: string | undefined;
-                ackFlag?: string | undefined;
-            }[];
-            options: Record<string, unknown> | unknown[];
-            status: number;
-            message: string;
-            count: number;
-            total: number;
-            totalResults: number;
-        }>;
-        /**
-         * Get only purchase orders data without response metadata
-         * @param params Same parameters as list() method
-         * @returns Promise<PurchaseOrder[]> Direct array of purchase orders
-         */
-        listData: (params?: PurchaseOrderListParams) => Promise<{
-            poNo: number;
-            vendorId: number;
-            vendorName: string | null;
-            complete: string;
-            lines?: unknown[] | undefined;
-            locationId?: number | undefined;
-            totalAmount?: number | undefined;
-            orderDate?: unknown;
-            ship2Name?: string | null | undefined;
-            poHdrUid?: number | undefined;
-            supplierId?: number | undefined;
-            supplierName?: string | null | undefined;
-            divisionId?: number | undefined;
-            poDate?: string | undefined;
-            companyNo?: string | undefined;
-            packingSlipNumber?: unknown;
-            ship2Add1?: string | null | undefined;
-            ship2Add2?: string | null | undefined;
-            expedite?: string | undefined;
-            ackFlag?: string | undefined;
-        }[]>;
-        /**
-         * Get detailed purchase order information - OpenAPI Path: /po-hdr/{poNo}
-         * @description Returns comprehensive purchase order details including header information, vendor details, status, and summary totals. Used for PO management and tracking.
-         *
-         * @fullPath api.orders.poHdr.get
-         * @service orders
-         * @domain procurement-management
-         * @dataMethod getData - returns only the purchase order detail without metadata
-         * @discoverable true
-         * @searchTerms ["purchase order details", "PO details", "purchase order info", "PO header"]
-         * @relatedEndpoints ["api.orders.poHdr.list", "api.orders.poHdr.doc.get", "api.nexus.receiving.list"]
-         * @commonPatterns ["Get PO details", "View purchase order", "PO status check", "Vendor order info"]
-         * @workflow ["purchase-order-review", "receiving-preparation", "vendor-management"]
-         * @prerequisites ["Valid purchase order number", "PO access permissions"]
-         * @nextSteps ["api.orders.poHdr.doc.get for full details", "Create receiving record", "Update PO status"]
-         * @businessRules ["Returns header-level information only", "Access controlled by permissions", "Status reflects current receiving state"]
-         * @functionalArea "procurement-and-purchasing"
-         * @performance "Single PO retrieval - efficient for header information"
-         */
-        get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
-            params: Record<string, unknown> | unknown[];
-            data: {
-                lines: {
-                    lineNo: number;
-                    invMastUid: number;
-                    itemId: string;
-                    qtyReceived: number;
-                    qtyOrdered: number;
-                    description?: string | undefined;
-                    unitOfMeasure?: string | undefined;
-                    itemDesc?: string | undefined;
-                    serialized?: string | undefined;
-                    primaryBin?: string | undefined;
-                    unitCost?: number | undefined;
-                    qtyOutstanding?: number | undefined;
-                    extendedCost?: number | undefined;
-                    trackBins?: string | undefined;
-                    lotAssignmentRequired?: string | undefined;
-                }[];
-                poNo: number;
-                vendorId: number;
-                vendorName: string | null;
-                complete: string;
-                approved?: string | undefined;
-                totalAmount?: number | undefined;
-                orderDate?: unknown;
-                requestedDate?: string | undefined;
-                poDate?: string | undefined;
-                expedite?: string | undefined;
-                ackFlag?: string | undefined;
-                currencyId?: string | undefined;
-                exchangeRate?: number | undefined;
-            };
-            options: Record<string, unknown> | unknown[];
-            status: number;
-            message: string;
-            count: number;
-            total: number;
-            totalResults: number;
-        }>;
-        /**
-         * Get only purchase order detail data without response metadata
-         * @param id Purchase order number to retrieve
-         * @returns Promise<PurchaseOrderDetail> Direct purchase order detail object
-         */
-        getData: (id: number) => Promise<{
-            lines: {
-                lineNo: number;
-                invMastUid: number;
-                itemId: string;
-                qtyReceived: number;
-                qtyOrdered: number;
-                description?: string | undefined;
-                unitOfMeasure?: string | undefined;
-                itemDesc?: string | undefined;
-                serialized?: string | undefined;
-                primaryBin?: string | undefined;
-                unitCost?: number | undefined;
-                qtyOutstanding?: number | undefined;
-                extendedCost?: number | undefined;
-                trackBins?: string | undefined;
-                lotAssignmentRequired?: string | undefined;
-            }[];
-            poNo: number;
-            vendorId: number;
-            vendorName: string | null;
-            complete: string;
-            approved?: string | undefined;
-            totalAmount?: number | undefined;
-            orderDate?: unknown;
-            requestedDate?: string | undefined;
-            poDate?: string | undefined;
-            expedite?: string | undefined;
-            ackFlag?: string | undefined;
-            currencyId?: string | undefined;
-            exchangeRate?: number | undefined;
-        }>;
-        /**
-         * Purchase order document operations - OpenAPI Path: /po-hdr/{poNo}/doc
-         */
-        doc: {
-            /**
-             * Get complete purchase order document with all related information
-             * @description Returns comprehensive purchase order document including header, line items, vendor information, shipping details, and totals. Complete document for receiving and fulfillment processes.
-             *
-             * @fullPath api.orders.poHdr.doc.get
-             * @service orders
-             * @domain procurement-management
-             * @dataMethod getData - returns only the purchase order document without metadata
-             * @discoverable true
-             * @searchTerms ["purchase order document", "complete PO", "PO with lines", "full purchase order", "PO document"]
-             * @relatedEndpoints ["api.orders.poHdr.get", "api.orders.poHdr.list", "api.nexus.receiving.create"]
-             * @commonPatterns ["Complete PO details", "PO for receiving", "Full purchase order", "PO with line items"]
-             * @workflow ["purchase-order-fulfillment", "receiving-workflow", "vendor-management"]
-             * @prerequisites ["Valid purchase order number", "Document access permissions"]
-             * @nextSteps ["Process receiving", "Create receiving records", "Update line item status"]
-             * @businessRules ["Includes all line items and quantities", "Shows receiving status per line", "Contains vendor and shipping details"]
-             * @functionalArea "procurement-and-purchasing"
-             * @performance "Complete document retrieval - includes all related data in single call"
-             */
-            get: (poNo: number) => Promise<{
-                params: Record<string, unknown> | unknown[];
-                data: {
-                    lines: {
-                        lineNo: number;
-                        invMastUid: number;
-                        itemId: string;
-                        qtyReceived: number;
-                        qtyOrdered: number;
-                        description?: string | undefined;
-                        unitOfMeasure?: string | undefined;
-                        itemDesc?: string | undefined;
-                        serialized?: string | undefined;
-                        primaryBin?: string | undefined;
-                        unitCost?: number | undefined;
-                        qtyOutstanding?: number | undefined;
-                        extendedCost?: number | undefined;
-                        trackBins?: string | undefined;
-                        lotAssignmentRequired?: string | undefined;
-                    }[];
-                    poNo: number;
-                    vendorId: number;
-                    vendorName: string | null;
-                    receipts?: unknown[] | undefined;
-                    totalAmount?: number | undefined;
-                    orderDate?: unknown;
-                    invoices?: unknown[] | undefined;
-                    poDate?: string | undefined;
-                    vendorAddress?: {
-                        city?: string | undefined;
-                        state?: string | undefined;
-                        address1?: string | undefined;
-                        zip?: string | undefined;
-                    } | undefined;
-                    terms?: string | undefined;
-                    fobPoint?: string | undefined;
-                };
-                options: Record<string, unknown> | unknown[];
-                status: number;
-                message: string;
-                count: number;
-                total: number;
-                totalResults: number;
-            }>;
-            /**
-             * Get only purchase order document data without response metadata
-             * @param poNo Purchase order number to retrieve
-             * @returns Promise<PurchaseOrderDocument> Direct purchase order document object
-             */
-            getData: (poNo: number) => Promise<{
-                lines: {
-                    lineNo: number;
-                    invMastUid: number;
-                    itemId: string;
-                    qtyReceived: number;
-                    qtyOrdered: number;
-                    description?: string | undefined;
-                    unitOfMeasure?: string | undefined;
-                    itemDesc?: string | undefined;
-                    serialized?: string | undefined;
-                    primaryBin?: string | undefined;
-                    unitCost?: number | undefined;
-                    qtyOutstanding?: number | undefined;
-                    extendedCost?: number | undefined;
-                    trackBins?: string | undefined;
-                    lotAssignmentRequired?: string | undefined;
-                }[];
-                poNo: number;
-                vendorId: number;
-                vendorName: string | null;
-                receipts?: unknown[] | undefined;
-                totalAmount?: number | undefined;
-                orderDate?: unknown;
-                invoices?: unknown[] | undefined;
-                poDate?: string | undefined;
-                vendorAddress?: {
-                    city?: string | undefined;
-                    state?: string | undefined;
-                    address1?: string | undefined;
-                    zip?: string | undefined;
-                } | undefined;
-                terms?: string | undefined;
-                fobPoint?: string | undefined;
-            }>;
-        };
-        /**
-         * Purchase order scan operations - OpenAPI Path: /po-hdr/scan
-         */
-        scan: {
-            /**
-             * Scan for similar purchase orders based on provided criteria
-             * @description Intelligent purchase order discovery that finds similar POs based on items, vendors, or other criteria. Useful for reordering, vendor analysis, and procurement optimization.
-             *
-             * @fullPath api.orders.poHdr.scan.create
-             * @service orders
-             * @domain procurement-management
-             * @dataMethod createData - returns only the scan results without metadata
-             * @discoverable true
-             * @searchTerms ["PO scan", "similar purchase orders", "find similar POs", "PO search", "procurement patterns"]
-             * @relatedEndpoints ["api.orders.poHdr.list", "api.orders.poHdr.doc.get", "api.items.products.list"]
-             * @commonPatterns ["Find similar orders", "Reorder analysis", "Vendor pattern analysis", "Procurement optimization"]
-             * @workflow ["procurement-optimization", "reorder-analysis", "vendor-comparison"]
-             * @prerequisites ["Scan criteria parameters", "PO access permissions"]
-             * @nextSteps ["Analyze results for reordering", "Compare vendor patterns", "Optimize procurement"]
-             * @businessRules ["Matches based on provided criteria", "Returns similarity scores", "Filters by date ranges and status"]
-             * @functionalArea "procurement-and-purchasing"
-             * @performance "Advanced search operation - may take longer for complex criteria"
-             */
-            create: (data: {
-                locationId?: number | undefined;
-                vendorId?: number | undefined;
-                complete?: string | undefined;
-                dateRange?: {
-                    startDate?: string | undefined;
-                    endDate?: string | undefined;
-                } | undefined;
-                itemIds?: string[] | undefined;
-                minAmount?: number | undefined;
-                maxAmount?: number | undefined;
-            }) => Promise<{
-                params: Record<string, unknown> | unknown[];
-                data: {
-                    similarity: number;
-                    poNo: number;
-                    vendorId: number;
-                    matchedCriteria: string[];
-                    totalAmount?: number | undefined;
-                    orderDate?: unknown;
-                    poDate?: string | undefined;
-                }[];
-                options: Record<string, unknown> | unknown[];
-                status: number;
-                message: string;
-                count: number;
-                total: number;
-                totalResults: number;
-            }>;
-            /**
-             * Get only purchase order scan results data without response metadata
-             * @param params Same parameters as create() method
-             * @returns Promise<PurchaseOrderScanResult[]> Direct array of scan results
-             */
-            createData: (params?: PurchaseOrderScanParams) => Promise<{
-                similarity: number;
-                poNo: number;
-                vendorId: number;
-                matchedCriteria: string[];
-                totalAmount?: number | undefined;
-                orderDate?: unknown;
-                poDate?: string | undefined;
-            }[]>;
-        };
-    };
-    /**
-     * Legacy method support for backward compatibility
-     * @deprecated Use the new OpenAPI path mirroring structure instead
-     */
-    getHealthCheck: () => Promise<{
-        params: Record<string, unknown> | unknown[];
-        data: {
-            siteHash: string;
-            siteId: string;
-        };
-        options: Record<string, unknown> | unknown[];
-        status: number;
-        message: string;
-        count: number;
-        total: number;
-        totalResults: number;
-    }>;
-    getHealthCheckData: () => Promise<{
-        siteHash: string;
-        siteId: string;
-    }>;
 }
 //# sourceMappingURL=client.d.ts.map