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

TypeScript client library for Augur microservices API endpoints

import { BinTransferListParamsSchema, BinTransferCreateRequestSchema, BinTransferUpdateRequestSchema } from '../schemas';
import type { z } from 'zod';
import type { NexusClient } from '../client';
type ExecuteRequest = NexusClient['executeRequest'];
type BinTransferListParams = z.infer<typeof BinTransferListParamsSchema>;
type BinTransferCreateRequest = z.infer<typeof BinTransferCreateRequestSchema>;
type BinTransferUpdateRequest = z.infer<typeof BinTransferUpdateRequestSchema>;
/**
 * Creates the binTransfer resource methods
 * OpenAPI Path: /bin-transfer → binTransfer.*
 * @description Methods for managing bin transfers - movement of inventory between bins within the same location
 */
export declare function createBinTransferResource(executeRequest: ExecuteRequest): {
    /**
     * Retrieve a list of bin transfer headers with optional filtering
     * @description Returns all bin transfer headers with pagination and status filtering support
     * @fullPath api.nexus.binTransfer.list
     * @service nexus
     * @domain warehouse-management
     * @dataMethod binTransferData.list
     * @discoverable true
     */
    list: (params?: BinTransferListParams) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: z.objectInputType<{
            binTransferHdrUid: 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 bin transfer header
     * @description Returns complete details for a bin transfer including JSON data and properties
     * @fullPath api.nexus.binTransfer.get
     * @service nexus
     * @domain warehouse-management
     * @dataMethod binTransferData.get
     * @discoverable true
     */
    get: (binTransferHdrUid: number | string) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            binTransferHdrUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Status sub-endpoints for bin transfers
     * @description Methods for retrieving bin transfer status and line item details
     */
    status: {
        /**
         * Retrieve bin transfer status with detailed line items
         * @description Returns complete bin transfer header with associated line items for status checking
         * @fullPath api.nexus.binTransfer.status.get
         * @service nexus
         * @domain warehouse-management
         * @dataMethod binTransferData.status.get
         * @discoverable true
         */
        get: (binTransferHdrUid: number | string) => Promise<{
            params: Record<string, unknown> | unknown[];
            data: {
                binTransferHdrUid: number;
                lines?: z.objectInputType<{
                    lineNo: z.ZodNumber;
                }, z.ZodTypeAny, "passthrough">[] | undefined;
            } & {
                [k: string]: unknown;
            };
            options: Record<string, unknown> | unknown[];
            status: number;
            message: string;
            count: number;
            total: number;
            totalResults: number;
        }>;
    };
    /**
     * Create a new bin transfer header with associated line items
     * @description Creates a bin transfer with complete transfer line items for inventory movement
     * @fullPath api.nexus.binTransfer.create
     * @service nexus
     * @domain warehouse-management
     * @dataMethod binTransferData.create
     * @discoverable true
     */
    create: (transferData: BinTransferCreateRequest) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            binTransferHdrUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Update an existing bin transfer header
     * @description Updates bin transfer status, process codes, and additional data
     * @fullPath api.nexus.binTransfer.update
     * @service nexus
     * @domain warehouse-management
     * @dataMethod binTransferData.update
     * @discoverable true
     */
    update: (binTransferHdrUid: number | string, updateData: BinTransferUpdateRequest) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            binTransferHdrUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
    /**
     * Soft delete a bin transfer header
     * @description Marks a bin transfer as deleted by setting status code to 700
     * @fullPath api.nexus.binTransfer.delete
     * @service nexus
     * @domain warehouse-management
     * @dataMethod binTransferData.delete
     * @discoverable true
     */
    delete: (binTransferHdrUid: number | string) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            binTransferHdrUid: number;
        } & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
};
/**
 * Creates the binTransferData resource methods (data-only versions)
 */
export declare function createBinTransferDataResource(binTransfer: ReturnType<typeof createBinTransferResource>): {
    list: (params?: BinTransferListParams) => Promise<z.objectInputType<{
        binTransferHdrUid: z.ZodNumber;
    }, z.ZodTypeAny, "passthrough">[]>;
    get: (binTransferHdrUid: number | string) => Promise<{
        binTransferHdrUid: number;
    } & {
        [k: string]: unknown;
    }>;
    status: {
        get: (binTransferHdrUid: number | string) => Promise<{
            binTransferHdrUid: number;
            lines?: z.objectInputType<{
                lineNo: z.ZodNumber;
            }, z.ZodTypeAny, "passthrough">[] | undefined;
        } & {
            [k: string]: unknown;
        }>;
    };
    create: (transferData: BinTransferCreateRequest) => Promise<{
        binTransferHdrUid: number;
    } & {
        [k: string]: unknown;
    }>;
    update: (binTransferHdrUid: number | string, updateData: BinTransferUpdateRequest) => Promise<{
        binTransferHdrUid: number;
    } & {
        [k: string]: unknown;
    }>;
    delete: (binTransferHdrUid: number | string) => Promise<{
        binTransferHdrUid: number;
    } & {
        [k: string]: unknown;
    }>;
};
export type BinTransferResource = ReturnType<typeof createBinTransferResource>;
export type BinTransferDataResource = ReturnType<typeof createBinTransferDataResource>;
export {};
//# sourceMappingURL=bin-transfer.d.ts.map