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

TypeScript client library for Augur microservices API endpoints

import { BaseServiceClient } from '../../core/base-client';
import type { HTTPClient } from '../../core/client';
import { type HealthCheckResource, type HealthCheckDataResource, type PingResource, type PingDataResource, type BinTransferResource, type BinTransferDataResource, type ReceivingResource, type ReceivingDataResource, type TransferResource, type TransferDataResource, type PurchaseOrderReceiptResource, type PurchaseOrderReceiptDataResource, type TransferReceiptResource, type TransferReceiptDataResource, type TransferShippingResource, type TransferShippingDataResource } from './resources';
/**
 * Nexus API Client
 * @description Client for interacting with Nexus microservice API endpoints for comprehensive warehouse management
 * @fullPath api.nexus
 * @service nexus
 * @domain warehouse-management
 * @discoverable true
 * @searchTerms ["nexus", "warehouse management", "inventory transfers", "receiving", "bin transfers", "warehouse operations"]
 * @relatedEndpoints ["api.nexus.binTransfer", "api.nexus.receiving", "api.nexus.transfer", "api.nexus.health"]
 * @commonPatterns ["Warehouse management operations", "Inventory movement tracking", "Receiving and transfer processing"]
 * @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.binTransfer.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.receiving.create({
 *   poNo: 12345.0,
 *   referenceNo: 'REF001',
 *   jsonData: JSON.stringify({ items: [{ itemId: 'ITEM001', quantity: 100 }] })
 * });
 * ```
 */
export declare class NexusClient extends BaseServiceClient {
    /** Health check resource */
    readonly healthCheck: HealthCheckResource;
    /** Health check data resource (data-only) */
    readonly healthCheckData: HealthCheckDataResource;
    /** Ping resource */
    readonly ping: PingResource;
    /** Ping data resource (data-only) */
    readonly pingData: PingDataResource;
    /** Bin transfer resource */
    readonly binTransfer: BinTransferResource;
    /** Bin transfer data resource (data-only) */
    readonly binTransferData: BinTransferDataResource;
    /** Receiving resource */
    readonly receiving: ReceivingResource;
    /** Receiving data resource (data-only) */
    readonly receivingData: ReceivingDataResource;
    /** Transfer resource */
    readonly transfer: TransferResource;
    /** Transfer data resource (data-only) */
    readonly transferData: TransferDataResource;
    /** Purchase order receipt resource */
    readonly purchaseOrderReceipt: PurchaseOrderReceiptResource;
    /** Purchase order receipt data resource (data-only) */
    readonly purchaseOrderReceiptData: PurchaseOrderReceiptDataResource;
    /** Transfer receipt resource */
    readonly transferReceipt: TransferReceiptResource;
    /** Transfer receipt data resource (data-only) */
    readonly transferReceiptData: TransferReceiptDataResource;
    /** Transfer shipping resource */
    readonly transferShipping: TransferShippingResource;
    /** Transfer shipping data resource (data-only) */
    readonly transferShippingData: TransferShippingDataResource;
    /**
     * 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);
}
//# sourceMappingURL=client.d.ts.map