@simpleapps-com/augur-api 0.1.0

package/dist/types/services/nexus/client.d.ts

@@ -0,0 +1,1213 @@
+import { BaseServiceClient } from '../../core/base-client';
+import type { HTTPClient } from '../../core/client';
+/**
+ * Nexus API Client
+ * @description Client for interacting with Nexus microservice API endpoints for comprehensive warehouse management
+ * @example
+ * ```typescript
+ * import { HTTPClient } from '@augur/api-client/core';
+ * import { NexusClient } from '@augur/api-client/services/nexus';
+ *
+ * const http = new HTTPClient('nexus', { siteId: 'your-site-id', bearerToken: 'your-token' });
+ * const nexus = new NexusClient(http);
+ *
+ * // Create a bin transfer
+ * const binTransfer = await nexus.binTransfers.create({
+ *   usersId: 1001,
+ *   locationId: 5.0,
+ *   transfers: [{
+ *     lineNo: 1.0,
+ *     invMastUid: 67890,
+ *     itemId: 'ITEM001',
+ *     toBin: 'A1-01',
+ *     fromBin: 'B2-05',
+ *     lot: 'LOT123',
+ *     uom: 'EA',
+ *     quantity: 10.0
+ *   }]
+ * });
+ *
+ * // Create a receiving document
+ * const receiving = await nexus.receivings.create({
+ *   poNo: 12345.0,
+ *   referenceNo: 'REF001',
+ *   jsonData: JSON.stringify({ items: [{ itemId: 'ITEM001', quantity: 100 }] })
+ * });
+ * ```
+ */
+export declare class NexusClient extends BaseServiceClient {
+    /**
+     * Create a new NexusClient instance
+     * @param http Configured HTTPClient instance
+     * @param baseUrl Base URL for the Nexus API (default: https://nexus.augur-api.com)
+     */
+    constructor(http: HTTPClient, baseUrl?: string);
+    /**
+     * Health monitoring endpoints
+     * @description Methods for checking service availability and health status
+     */
+    health: {
+        /**
+         * Simple health check endpoint that doesn't require authentication
+         * @description Returns "pong" response for basic connectivity testing
+         * @returns Simple pong response
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const pong = await client.health.ping();
+         * console.log(pong.data); // "pong"
+         * ```
+         */
+        ping: () => Promise<{
+            data: "pong";
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Comprehensive health check with authentication and site validation
+         * @description Validates authentication, site configuration, and service health
+         * @returns Health check response with site information
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const health = await client.health.check();
+         * console.log('Site:', health.data.siteId, 'Hash:', health.data.siteHash);
+         * ```
+         */
+        check: () => Promise<{
+            data: {
+                siteHash: string;
+                siteId: string;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+    /**
+     * Bin Transfer endpoints
+     * @description Methods for managing bin transfers - movement of inventory between bins within the same location
+     */
+    binTransfers: {
+        /**
+         * Retrieve a list of bin transfer headers with optional filtering
+         * @description Returns all bin transfer headers with pagination and status filtering support
+         * @param params Optional filtering and pagination parameters
+         * @returns Array of bin transfer headers
+         * @throws ValidationError When parameters are invalid or response is malformed
+         * @example
+         * ```typescript
+         * const transfers = await client.binTransfers.list({ limit: 20, statusCd: 704 });
+         * transfers.data.forEach(transfer => {
+         *   console.log(`Transfer ${transfer.binTransferHdrUid}: Status ${transfer.statusCd}`);
+         * });
+         * ```
+         */
+        list: (params?: {
+            edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
+            limit?: number | undefined;
+            offset?: number | undefined;
+            statusCd?: number | undefined;
+        } | undefined) => Promise<{
+            data: {
+                usersId: number;
+                locationId: number;
+                binTransferHdrUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                response?: string | null | undefined;
+            }[];
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Retrieve details for a specific bin transfer header
+         * @description Returns complete details for a bin transfer including JSON data and properties
+         * @param binTransferHdrUid Bin transfer header unique identifier
+         * @returns Complete bin transfer details
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const transfer = await client.binTransfers.get(12345);
+         * console.log('Transfer details:', transfer.data.jsonData);
+         * console.log('Users ID:', transfer.data.usersId);
+         * ```
+         */
+        get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
+            data: {
+                usersId: number;
+                locationId: number;
+                binTransferHdrUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                response?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Create a new bin transfer header with associated line items
+         * @description Creates a bin transfer with complete transfer line items for inventory movement
+         * @param transferData Complete bin transfer data including user, location, and transfer lines
+         * @returns Created bin transfer header details
+         * @throws ValidationError When request is invalid or response is malformed
+         * @example
+         * ```typescript
+         * const transfer = await client.binTransfers.create({
+         *   usersId: 1001,
+         *   locationId: 5.0,
+         *   requestId: 'req_12346',
+         *   transfers: [{
+         *     lineNo: 1.0,
+         *     invMastUid: 67890,
+         *     itemId: 'ITEM001',
+         *     toBin: 'A1-01',
+         *     fromBin: 'B2-05',
+         *     lot: 'LOT123',
+         *     uom: 'EA',
+         *     moveAvailable: 'Y',
+         *     quantity: 10.0
+         *   }]
+         * });
+         * ```
+         */
+        create: (data: {
+            usersId: number;
+            transfers: {
+                lineNo: number;
+                invMastUid: number;
+                itemId: string;
+                uom: string;
+                toBin: string;
+                fromBin: string;
+                lot: string;
+                quantity?: number | undefined;
+                moveAvailable?: string | undefined;
+                moveAllocations?: string | undefined;
+            }[];
+            locationId: number;
+            requestId?: string | undefined;
+        }) => Promise<{
+            data: {
+                usersId: number;
+                locationId: number;
+                binTransferHdrUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                response?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Update an existing bin transfer header
+         * @description Updates bin transfer status, process codes, and additional data
+         * @param binTransferHdrUid Bin transfer header unique identifier
+         * @param updateData Fields to update on the bin transfer
+         * @returns Updated bin transfer details
+         * @throws ValidationError When request is invalid or response is malformed
+         * @example
+         * ```typescript
+         * const updated = await client.binTransfers.update(12346, {
+         *   statusCd: 705,
+         *   processCd: 705,
+         *   properties: JSON.stringify({ notes: 'Transfer in progress' })
+         * });
+         * ```
+         */
+        update: (id: string | number, data: {
+            statusCd?: number | undefined;
+            processCd?: number | undefined;
+            properties?: string | undefined;
+            jsonData?: string | undefined;
+        }) => Promise<{
+            data: {
+                usersId: number;
+                locationId: number;
+                binTransferHdrUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                response?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Soft delete a bin transfer header
+         * @description Marks a bin transfer as deleted by setting status code to 700
+         * @param binTransferHdrUid Bin transfer header unique identifier
+         * @returns Deleted bin transfer details with updated status
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const deleted = await client.binTransfers.delete(12346);
+         * console.log('Transfer deleted, status:', deleted.data.statusCd); // Should be 700
+         * ```
+         */
+        delete: (id: string | number) => Promise<{
+            data: {
+                usersId: number;
+                locationId: number;
+                binTransferHdrUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                response?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+    /**
+     * Receiving endpoints
+     * @description Methods for managing receiving operations - purchase order receipts and inventory receiving processes
+     */
+    receivings: {
+        /**
+         * Retrieve a list of receiving documents with optional filtering
+         * @description Returns receiving documents with pagination and filtering by PO number or status
+         * @param params Optional filtering and pagination parameters
+         * @returns Array of receiving documents
+         * @throws ValidationError When parameters are invalid or response is malformed
+         * @example
+         * ```typescript
+         * const receivings = await client.receivings.list({ limit: 50, poNo: 12345, statusCd: 704 });
+         * receivings.data.forEach(receiving => {
+         *   console.log(`Receiving ${receiving.receivingUid}: PO ${receiving.poNo}`);
+         * });
+         * ```
+         */
+        list: (params?: {
+            edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
+            limit?: number | undefined;
+            offset?: number | undefined;
+            statusCd?: number | undefined;
+            poNo?: number | undefined;
+        } | undefined) => Promise<{
+            data: {
+                receivingUid: number;
+                poNo: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            }[];
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Retrieve details for a specific receiving document
+         * @description Returns complete details for a receiving document including JSON data and properties
+         * @param receivingUid Receiving unique identifier
+         * @returns Complete receiving document details
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const receiving = await client.receivings.get(54321);
+         * console.log('Receiving details:', receiving.data.jsonData);
+         * console.log('PO Number:', receiving.data.poNo);
+         * ```
+         */
+        get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
+            data: {
+                receivingUid: number;
+                poNo: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Create a new receiving document
+         * @description Creates a receiving document for purchase order receipt processing
+         * @param receivingData Complete receiving data including PO number and optional details
+         * @returns Created receiving document details
+         * @throws ValidationError When request is invalid or response is malformed
+         * @example
+         * ```typescript
+         * const receiving = await client.receivings.create({
+         *   poNo: 12345.0,
+         *   referenceNo: 'REF002',
+         *   requestId: 'req_recv_002',
+         *   jsonData: JSON.stringify({ items: [{ itemId: 'ITEM001', quantity: 100 }] }),
+         *   properties: JSON.stringify({ supplier: 'ACME Corp', expectedDate: '2024-01-02' })
+         * });
+         * ```
+         */
+        create: (data: {
+            poNo: number;
+            properties?: string | undefined;
+            jsonData?: string | undefined;
+            requestId?: string | undefined;
+            referenceNo?: string | undefined;
+        }) => Promise<{
+            data: {
+                receivingUid: number;
+                poNo: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Update an existing receiving document
+         * @description Updates receiving status, process codes, and messages
+         * @param receivingUid Receiving unique identifier
+         * @param updateData Fields to update on the receiving document
+         * @returns Updated receiving details
+         * @throws ValidationError When request is invalid or response is malformed
+         * @example
+         * ```typescript
+         * const updated = await client.receivings.update(54322, {
+         *   statusCd: 705,
+         *   processCd: 705,
+         *   processMessage: 'Processing receipt',
+         *   jsonData: JSON.stringify({ status: 'in_progress' })
+         * });
+         * ```
+         */
+        update: (id: string | number, data: {
+            statusCd?: number | undefined;
+            processCd?: number | undefined;
+            jsonData?: string | undefined;
+            processMessage?: string | undefined;
+        }) => Promise<{
+            data: {
+                receivingUid: number;
+                poNo: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Soft delete a receiving document
+         * @description Marks a receiving document as deleted by setting status code to 700
+         * @param receivingUid Receiving unique identifier
+         * @returns Deleted receiving details with updated status
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const deleted = await client.receivings.delete(54322);
+         * console.log('Receiving deleted, status:', deleted.data.statusCd); // Should be 700
+         * ```
+         */
+        delete: (id: string | number) => Promise<{
+            data: {
+                receivingUid: number;
+                poNo: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+    /**
+     * Transfer endpoints
+     * @description Methods for managing general transfer operations for inventory movement between locations
+     */
+    transfers: {
+        /**
+         * Retrieve a list of transfer documents with optional filtering
+         * @description Returns transfer documents with pagination and filtering by reference number or status
+         * @param params Optional filtering and pagination parameters
+         * @returns Array of transfer documents
+         * @throws ValidationError When parameters are invalid or response is malformed
+         * @example
+         * ```typescript
+         * const transfers = await client.transfers.list({ limit: 25, referenceNo: 'TRF001' });
+         * transfers.data.forEach(transfer => {
+         *   console.log(`Transfer ${transfer.transferUid}: ${transfer.referenceNo}`);
+         * });
+         * ```
+         */
+        list: (params?: {
+            edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
+            limit?: number | undefined;
+            offset?: number | undefined;
+            statusCd?: number | undefined;
+            referenceNo?: string | undefined;
+        } | undefined) => Promise<{
+            data: {
+                transferUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            }[];
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Retrieve details for a specific transfer document
+         * @description Returns complete details for a transfer document including JSON data
+         * @param transferUid Transfer unique identifier
+         * @returns Complete transfer document details
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const transfer = await client.transfers.get(98765);
+         * console.log('Transfer details:', transfer.data.jsonData);
+         * console.log('Reference:', transfer.data.referenceNo);
+         * ```
+         */
+        get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
+            data: {
+                transferUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Create a new transfer document
+         * @description Creates a transfer document for inventory movement between locations
+         * @param transferData Complete transfer data including reference and location details
+         * @returns Created transfer document details
+         * @throws ValidationError When request is invalid or response is malformed
+         * @example
+         * ```typescript
+         * const transfer = await client.transfers.create({
+         *   referenceNo: 'TRF002',
+         *   requestId: 'req_trf_002',
+         *   jsonData: JSON.stringify({ fromLocation: 'WAREHOUSE_A', toLocation: 'WAREHOUSE_B' }),
+         *   processMessage: 'Initial transfer request'
+         * });
+         * ```
+         */
+        create: (data: {
+            jsonData?: string | undefined;
+            requestId?: string | undefined;
+            referenceNo?: string | undefined;
+            processMessage?: string | undefined;
+        }) => Promise<{
+            data: {
+                transferUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Update an existing transfer document
+         * @description Updates transfer status, process codes, and messages
+         * @param transferUid Transfer unique identifier
+         * @param updateData Fields to update on the transfer document
+         * @returns Updated transfer details
+         * @throws ValidationError When request is invalid or response is malformed
+         * @example
+         * ```typescript
+         * const updated = await client.transfers.update(98766, {
+         *   statusCd: 705,
+         *   processMessage: 'Transfer in progress'
+         * });
+         * ```
+         */
+        update: (id: string | number, data: {
+            statusCd?: number | undefined;
+            processCd?: number | undefined;
+            jsonData?: string | undefined;
+            processMessage?: string | undefined;
+        }) => Promise<{
+            data: {
+                transferUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Soft delete a transfer document
+         * @description Marks a transfer document as deleted by setting status code to 700
+         * @param transferUid Transfer unique identifier
+         * @returns Deleted transfer details with updated status
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const deleted = await client.transfers.delete(98766);
+         * console.log('Transfer deleted, status:', deleted.data.statusCd); // Should be 700
+         * ```
+         */
+        delete: (id: string | number) => Promise<{
+            data: {
+                transferUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+    /**
+     * Purchase Order Receipt endpoints
+     * @description Methods for managing purchase order receipt documents
+     */
+    purchaseOrderReceipts: {
+        /**
+         * Retrieve a list of purchase order receipt documents
+         * @description Returns purchase order receipts with pagination and filtering support
+         * @param params Optional filtering and pagination parameters
+         * @returns Array of purchase order receipt documents
+         * @throws ValidationError When parameters are invalid or response is malformed
+         */
+        list: (params?: {
+            edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
+            limit?: number | undefined;
+            offset?: number | undefined;
+            statusCd?: number | undefined;
+            referenceNo?: string | undefined;
+        } | undefined) => Promise<{
+            data: {
+                purchaseOrderReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            }[];
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Retrieve details for a specific purchase order receipt
+         * @description Returns complete details for a purchase order receipt document
+         * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
+         * @returns Complete purchase order receipt details
+         * @throws ValidationError When response is malformed
+         */
+        get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
+            data: {
+                purchaseOrderReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Create a new purchase order receipt document
+         * @description Creates a purchase order receipt document for tracking
+         * @param receiptData Complete purchase order receipt data
+         * @returns Created purchase order receipt details
+         * @throws ValidationError When request is invalid or response is malformed
+         */
+        create: (data: {
+            properties?: string | undefined;
+            jsonData?: string | undefined;
+            requestId?: string | undefined;
+            referenceNo?: string | undefined;
+        }) => Promise<{
+            data: {
+                purchaseOrderReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Update an existing purchase order receipt
+         * @description Updates purchase order receipt status and properties
+         * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
+         * @param updateData Fields to update on the purchase order receipt
+         * @returns Updated purchase order receipt details
+         * @throws ValidationError When request is invalid or response is malformed
+         */
+        update: (id: string | number, data: {
+            statusCd?: number | undefined;
+            processCd?: number | undefined;
+            properties?: string | undefined;
+            jsonData?: string | undefined;
+        }) => Promise<{
+            data: {
+                purchaseOrderReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Soft delete a purchase order receipt
+         * @description Marks a purchase order receipt as deleted
+         * @param purchaseOrderReceiptUid Purchase order receipt unique identifier
+         * @returns Deleted purchase order receipt details with updated status
+         * @throws ValidationError When response is malformed
+         */
+        delete: (id: string | number) => Promise<{
+            data: {
+                purchaseOrderReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+    /**
+     * Transfer Receipt endpoints
+     * @description Methods for managing transfer receipt documents
+     */
+    transferReceipts: {
+        /**
+         * Retrieve a list of transfer receipt documents
+         * @description Returns transfer receipts with pagination and filtering support
+         * @param params Optional filtering and pagination parameters
+         * @returns Array of transfer receipt documents
+         * @throws ValidationError When parameters are invalid or response is malformed
+         */
+        list: (params?: {
+            edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
+            limit?: number | undefined;
+            offset?: number | undefined;
+            statusCd?: number | undefined;
+            referenceNo?: string | undefined;
+        } | undefined) => Promise<{
+            data: {
+                transferReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            }[];
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Retrieve details for a specific transfer receipt
+         * @description Returns complete details for a transfer receipt document
+         * @param transferReceiptUid Transfer receipt unique identifier
+         * @returns Complete transfer receipt details
+         * @throws ValidationError When response is malformed
+         */
+        get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
+            data: {
+                transferReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Create a new transfer receipt document
+         * @description Creates a transfer receipt document for tracking
+         * @param receiptData Complete transfer receipt data
+         * @returns Created transfer receipt details
+         * @throws ValidationError When request is invalid or response is malformed
+         */
+        create: (data: {
+            properties?: string | undefined;
+            jsonData?: string | undefined;
+            requestId?: string | undefined;
+            referenceNo?: string | undefined;
+        }) => Promise<{
+            data: {
+                transferReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Update an existing transfer receipt
+         * @description Updates transfer receipt status and properties
+         * @param transferReceiptUid Transfer receipt unique identifier
+         * @param updateData Fields to update on the transfer receipt
+         * @returns Updated transfer receipt details
+         * @throws ValidationError When request is invalid or response is malformed
+         */
+        update: (id: string | number, data: {
+            statusCd?: number | undefined;
+            processCd?: number | undefined;
+            properties?: string | undefined;
+            jsonData?: string | undefined;
+        }) => Promise<{
+            data: {
+                transferReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Soft delete a transfer receipt
+         * @description Marks a transfer receipt as deleted
+         * @param transferReceiptUid Transfer receipt unique identifier
+         * @returns Deleted transfer receipt details with updated status
+         * @throws ValidationError When response is malformed
+         */
+        delete: (id: string | number) => Promise<{
+            data: {
+                transferReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+    /**
+     * Transfer Shipping endpoints
+     * @description Methods for managing transfer shipping documents
+     */
+    transferShippings: {
+        /**
+         * Retrieve a list of transfer shipping documents
+         * @description Returns transfer shippings with pagination and filtering support
+         * @param params Optional filtering and pagination parameters
+         * @returns Array of transfer shipping documents
+         * @throws ValidationError When parameters are invalid or response is malformed
+         */
+        list: (params?: {
+            edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
+            limit?: number | undefined;
+            offset?: number | undefined;
+            statusCd?: number | undefined;
+            referenceNo?: string | undefined;
+        } | undefined) => Promise<{
+            data: {
+                transferReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            }[];
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Retrieve details for a specific transfer shipping document
+         * @description Returns complete details for a transfer shipping document
+         * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
+         * @returns Complete transfer shipping details
+         * @throws ValidationError When response is malformed
+         * @example
+         * ```typescript
+         * const shipping = await client.transferShippings.get(12345);
+         * console.log('Shipping details:', shipping.data.jsonData);
+         * ```
+         */
+        get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
+            data: {
+                transferReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Create a new transfer shipping document
+         * @description Creates a transfer shipping document for tracking
+         * @param shippingData Complete transfer shipping data
+         * @returns Created transfer shipping details
+         * @throws ValidationError When request is invalid or response is malformed
+         */
+        create: (data: {
+            properties?: string | undefined;
+            jsonData?: string | undefined;
+            requestId?: string | undefined;
+            referenceNo?: string | undefined;
+        }) => Promise<{
+            data: {
+                transferReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Update an existing transfer shipping document
+         * @description Updates transfer shipping status and properties
+         * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
+         * @param updateData Fields to update on the transfer shipping
+         * @returns Updated transfer shipping details
+         * @throws ValidationError When request is invalid or response is malformed
+         */
+        update: (id: string | number, data: {
+            statusCd?: number | undefined;
+            processCd?: number | undefined;
+            properties?: string | undefined;
+            jsonData?: string | undefined;
+        }) => Promise<{
+            data: {
+                transferReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+        /**
+         * Soft delete a transfer shipping document
+         * @description Marks a transfer shipping document as deleted
+         * @param transferReceiptUid Transfer receipt unique identifier (used for transfer shipping operations)
+         * @returns Deleted transfer shipping details with updated status
+         * @throws ValidationError When response is malformed
+         */
+        delete: (id: string | number) => Promise<{
+            data: {
+                transferReceiptUid: number;
+                dateCreated?: string | undefined;
+                dateLastModified?: string | undefined;
+                statusCd?: number | undefined;
+                updateCd?: number | undefined;
+                processCd?: number | undefined;
+                properties?: string | null | undefined;
+                jsonData?: string | null | undefined;
+                importState?: string | undefined;
+                requestId?: string | undefined;
+                referenceNo?: string | undefined;
+                processMessage?: string | null | undefined;
+            };
+            status: number;
+            options?: Record<string, unknown>[] | undefined;
+            message?: string | undefined;
+            totalResults?: number | undefined;
+            count?: number | undefined;
+        }>;
+    };
+}
+//# sourceMappingURL=client.d.ts.map