@simpleapps-com/augur-api/dist/esm/services/nexus/resources/transfer.d.ts

TypeScript client library for Augur microservices API endpoints

import { TransferListParamsSchema, TransferCreateRequestSchema, TransferUpdateRequestSchema } from '../schemas';
import type { z } from 'zod';
import type { NexusClient } from '../client';
type ExecuteRequest = NexusClient['executeRequest'];
type TransferListParams = z.infer<typeof TransferListParamsSchema>;
type TransferCreateRequest = z.infer<typeof TransferCreateRequestSchema>;
type TransferUpdateRequest = z.infer<typeof TransferUpdateRequestSchema>;
/**
 * Creates the transfer resource methods
 * OpenAPI Path: /transfer → transfer.*
 * @description Methods for managing general transfer operations for inventory movement between locations
 */
export declare function createTransferResource(executeRequest: ExecuteRequest): {
    /**
     * Retrieve a list of transfer documents with optional filtering
     * @description Returns transfer documents with pagination and filtering by reference number or status
     * @fullPath api.nexus.transfer.list
     * @service nexus
     * @domain warehouse-management
     * @dataMethod transferData.list
     * @discoverable true
     */
    list: (params?: TransferListParams) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: z.objectInputType<{
            transferUid: z.ZodNumber;
        }, z.ZodTypeAny, "passthrough">[];
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Retrieve details for a specific transfer document
     * @description Returns complete details for a transfer document including JSON data
     * @fullPath api.nexus.transfer.get
     * @service nexus
     * @domain warehouse-management
     * @dataMethod transferData.get
     * @discoverable true
     */
    get: (transferUid: number | string) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            transferUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Create a new transfer document
     * @description Creates a transfer document for inventory movement between locations
     * @fullPath api.nexus.transfer.create
     * @service nexus
     * @domain warehouse-management
     * @dataMethod transferData.create
     * @discoverable true
     */
    create: (transferData: TransferCreateRequest) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            transferUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Update an existing transfer document
     * @description Updates transfer status, process codes, and messages
     * @fullPath api.nexus.transfer.update
     * @service nexus
     * @domain warehouse-management
     * @dataMethod transferData.update
     * @discoverable true
     */
    update: (transferUid: number | string, updateData: TransferUpdateRequest) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            transferUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Soft delete a transfer document
     * @description Marks a transfer document as deleted by setting status code to 700
     * @fullPath api.nexus.transfer.delete
     * @service nexus
     * @domain warehouse-management
     * @dataMethod transferData.delete
     * @discoverable true
     */
    delete: (transferUid: number | string) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            transferUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
};
/**
 * Creates the transferData resource methods (data-only versions)
 */
export declare function createTransferDataResource(transfer: ReturnType<typeof createTransferResource>): {
    list: (params?: TransferListParams) => Promise<z.objectInputType<{
        transferUid: z.ZodNumber;
    }, z.ZodTypeAny, "passthrough">[]>;
    get: (transferUid: number | string) => Promise<{
        transferUid: number;
    } & {
        [k: string]: unknown;
    }>;
    create: (transferData: TransferCreateRequest) => Promise<{
        transferUid: number;
    } & {
        [k: string]: unknown;
    }>;
    update: (transferUid: number | string, updateData: TransferUpdateRequest) => Promise<{
        transferUid: number;
    } & {
        [k: string]: unknown;
    }>;
    delete: (transferUid: number | string) => Promise<{
        transferUid: number;
    } & {
        [k: string]: unknown;
    }>;
};
export type TransferResource = ReturnType<typeof createTransferResource>;
export type TransferDataResource = ReturnType<typeof createTransferDataResource>;
export {};
//# sourceMappingURL=transfer.d.ts.map