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

TypeScript client library for Augur microservices API endpoints

import { TransferShippingListParamsSchema, TransferShippingListResponseSchema, TransferShippingGetResponseSchema, TransferShippingCreateRequestSchema, TransferShippingCreateResponseSchema, TransferShippingUpdateRequestSchema, TransferShippingUpdateResponseSchema, TransferShippingDeleteResponseSchema, } from '../schemas';
/**
 * Creates the transferShipping resource methods
 * OpenAPI Path: /transfer-shipping → transferShipping.*
 * @description Methods for managing transfer shipping documents for comprehensive outbound transfer tracking and logistics
 */
export function createTransferShippingResource(executeRequest) {
    return {
        /**
         * Retrieve a list of transfer shipping documents with optional filtering
         * @description Returns transfer shipping documents with pagination and filtering by shipping reference, status, or shipping date
         * @fullPath api.nexus.transferShipping.list
         * @service nexus
         * @domain warehouse-management
         * @dataMethod transferShippingData.list
         * @discoverable true
         */
        list: async (params) => {
            return executeRequest({
                method: 'GET',
                path: '/transfer-shipping',
                paramsSchema: TransferShippingListParamsSchema,
                responseSchema: TransferShippingListResponseSchema,
            }, params);
        },
        /**
         * Retrieve details for a specific transfer shipping document
         * @description Returns complete details for a transfer shipping document including JSON data and tracking information
         * @fullPath api.nexus.transferShipping.get
         * @service nexus
         * @domain warehouse-management
         * @dataMethod transferShippingData.get
         * @discoverable true
         */
        get: async (transferReceiptUid) => {
            return executeRequest({
                method: 'GET',
                path: '/transfer-shipping/{transferReceiptUid}',
                responseSchema: TransferShippingGetResponseSchema,
            }, undefined, { transferReceiptUid: String(transferReceiptUid) });
        },
        /**
         * Create a new transfer shipping document
         * @description Creates a transfer shipping document for comprehensive outbound tracking and logistics management
         * @fullPath api.nexus.transferShipping.create
         * @service nexus
         * @domain warehouse-management
         * @dataMethod transferShippingData.create
         * @discoverable true
         */
        create: async (shippingData) => {
            return executeRequest({
                method: 'POST',
                path: '/transfer-shipping',
                paramsSchema: TransferShippingCreateRequestSchema,
                responseSchema: TransferShippingCreateResponseSchema,
            }, shippingData);
        },
        /**
         * Update an existing transfer shipping document
         * @description Updates transfer shipping status and properties
         * @fullPath api.nexus.transferShipping.update
         * @service nexus
         * @domain warehouse-management
         * @dataMethod transferShippingData.update
         * @discoverable true
         */
        update: async (transferReceiptUid, updateData) => {
            return executeRequest({
                method: 'PUT',
                path: '/transfer-shipping/{transferReceiptUid}',
                paramsSchema: TransferShippingUpdateRequestSchema,
                responseSchema: TransferShippingUpdateResponseSchema,
            }, updateData, { transferReceiptUid: String(transferReceiptUid) });
        },
        /**
         * Soft delete a transfer shipping document
         * @description Marks a transfer shipping document as deleted
         * @fullPath api.nexus.transferShipping.delete
         * @service nexus
         * @domain warehouse-management
         * @dataMethod transferShippingData.delete
         * @discoverable true
         */
        delete: async (transferReceiptUid) => {
            return executeRequest({
                method: 'DELETE',
                path: '/transfer-shipping/{transferReceiptUid}',
                responseSchema: TransferShippingDeleteResponseSchema,
            }, undefined, { transferReceiptUid: String(transferReceiptUid) });
        },
    };
}
/**
 * Creates the transferShippingData resource methods (data-only versions)
 */
export function createTransferShippingDataResource(transferShipping) {
    return {
        list: async (params) => {
            const response = await transferShipping.list(params);
            return response.data;
        },
        get: async (transferReceiptUid) => {
            const response = await transferShipping.get(transferReceiptUid);
            return response.data;
        },
        create: async (shippingData) => {
            const response = await transferShipping.create(shippingData);
            return response.data;
        },
        update: async (transferReceiptUid, updateData) => {
            const response = await transferShipping.update(transferReceiptUid, updateData);
            return response.data;
        },
        delete: async (transferReceiptUid) => {
            const response = await transferShipping.delete(transferReceiptUid);
            return response.data;
        },
    };
}
//# sourceMappingURL=transfer-shipping.js.map