@simpleapps-com/augur-api/dist/esm/services/nexus/resources/transfer-receipt.js

TypeScript client library for Augur microservices API endpoints

import { TransferReceiptListParamsSchema, TransferReceiptListResponseSchema, TransferReceiptGetResponseSchema, TransferReceiptCreateRequestSchema, TransferReceiptCreateResponseSchema, TransferReceiptUpdateRequestSchema, TransferReceiptUpdateResponseSchema, TransferReceiptDeleteResponseSchema, } from '../schemas';
/**
 * Creates the transferReceipt resource methods
 * OpenAPI Path: /transfer-receipt → transferReceipt.*
 * @description Methods for managing transfer receipt documents for comprehensive transfer tracking and confirmation
 */
export function createTransferReceiptResource(executeRequest) {
    return {
        /**
         * Retrieve a list of transfer receipt documents with optional filtering
         * @description Returns transfer receipts with pagination and filtering by transfer number, status, or receipt date
         * @fullPath api.nexus.transferReceipt.list
         * @service nexus
         * @domain warehouse-management
         * @dataMethod transferReceiptData.list
         * @discoverable true
         */
        list: async (params) => {
            return executeRequest({
                method: 'GET',
                path: '/transfer-receipt',
                paramsSchema: TransferReceiptListParamsSchema,
                responseSchema: TransferReceiptListResponseSchema,
            }, params);
        },
        /**
         * Retrieve details for a specific transfer receipt document
         * @description Returns complete details for a transfer receipt including JSON data and confirmation information
         * @fullPath api.nexus.transferReceipt.get
         * @service nexus
         * @domain warehouse-management
         * @dataMethod transferReceiptData.get
         * @discoverable true
         */
        get: async (transferReceiptUid) => {
            return executeRequest({
                method: 'GET',
                path: '/transfer-receipt/{transferReceiptUid}',
                responseSchema: TransferReceiptGetResponseSchema,
            }, undefined, { transferReceiptUid: String(transferReceiptUid) });
        },
        /**
         * Create a new transfer receipt document
         * @description Creates a transfer receipt document for comprehensive tracking and confirmation of transfer completion
         * @fullPath api.nexus.transferReceipt.create
         * @service nexus
         * @domain warehouse-management
         * @dataMethod transferReceiptData.create
         * @discoverable true
         */
        create: async (receiptData) => {
            return executeRequest({
                method: 'POST',
                path: '/transfer-receipt',
                paramsSchema: TransferReceiptCreateRequestSchema,
                responseSchema: TransferReceiptCreateResponseSchema,
            }, receiptData);
        },
        /**
         * Update an existing transfer receipt
         * @description Updates transfer receipt status and properties
         * @fullPath api.nexus.transferReceipt.update
         * @service nexus
         * @domain warehouse-management
         * @dataMethod transferReceiptData.update
         * @discoverable true
         */
        update: async (transferReceiptUid, updateData) => {
            return executeRequest({
                method: 'PUT',
                path: '/transfer-receipt/{transferReceiptUid}',
                paramsSchema: TransferReceiptUpdateRequestSchema,
                responseSchema: TransferReceiptUpdateResponseSchema,
            }, updateData, { transferReceiptUid: String(transferReceiptUid) });
        },
        /**
         * Soft delete a transfer receipt
         * @description Marks a transfer receipt as deleted
         * @fullPath api.nexus.transferReceipt.delete
         * @service nexus
         * @domain warehouse-management
         * @dataMethod transferReceiptData.delete
         * @discoverable true
         */
        delete: async (transferReceiptUid) => {
            return executeRequest({
                method: 'DELETE',
                path: '/transfer-receipt/{transferReceiptUid}',
                responseSchema: TransferReceiptDeleteResponseSchema,
            }, undefined, { transferReceiptUid: String(transferReceiptUid) });
        },
    };
}
/**
 * Creates the transferReceiptData resource methods (data-only versions)
 */
export function createTransferReceiptDataResource(transferReceipt) {
    return {
        list: async (params) => {
            const response = await transferReceipt.list(params);
            return response.data;
        },
        get: async (transferReceiptUid) => {
            const response = await transferReceipt.get(transferReceiptUid);
            return response.data;
        },
        create: async (receiptData) => {
            const response = await transferReceipt.create(receiptData);
            return response.data;
        },
        update: async (transferReceiptUid, updateData) => {
            const response = await transferReceipt.update(transferReceiptUid, updateData);
            return response.data;
        },
        delete: async (transferReceiptUid) => {
            const response = await transferReceipt.delete(transferReceiptUid);
            return response.data;
        },
    };
}
//# sourceMappingURL=transfer-receipt.js.map