@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
46 lines • 2.34 kB
TypeScript
import { BaseServiceClient } from '../../core/base-client';
import type { HTTPClient } from '../../core/client';
import { type HealthCheckResource, type HealthCheckDataResource, type PingResource, type PingDataResource, type WarehouseResource, type WarehouseDataResource, type DistributorsResource, type DistributorsDataResource, type ProductsResource, type ProductsDataResource, type InvProfileHdrResource, type InvProfileHdrDataResource, type RestockHdrResource, type RestockHdrDataResource, type SectionsResource, type SectionsDataResource } from './resources';
/**
* VMI (Vendor Managed Inventory) API Client
* @description Client for interacting with VMI microservice API endpoints for warehouse and inventory management
* @example
* ```typescript
* import { HTTPClient } from '@augur/api-client/core';
* import { VMIClient } from '@augur/api-client/services/vmi';
*
* const http = new HTTPClient('vmi', { siteId: 'your-site-id', bearerToken: 'your-token' });
* const vmi = new VMIClient(http);
*
* // List warehouses
* const warehouses = await vmi.warehouse.list({ customerId: 12345 });
*
* // Check inventory availability
* const inventory = await vmi.warehouse.availability.get(123, { q: 'wire' });
* ```
*/
export declare class VMIClient extends BaseServiceClient {
readonly healthCheck: HealthCheckResource;
readonly ping: PingResource;
readonly warehouse: WarehouseResource;
readonly distributors: DistributorsResource;
readonly products: ProductsResource;
readonly invProfileHdr: InvProfileHdrResource;
readonly restockHdr: RestockHdrResource;
readonly sections: SectionsResource;
readonly healthCheckData: HealthCheckDataResource;
readonly pingData: PingDataResource;
readonly warehouseData: WarehouseDataResource;
readonly distributorsData: DistributorsDataResource;
readonly productsData: ProductsDataResource;
readonly invProfileHdrData: InvProfileHdrDataResource;
readonly restockHdrData: RestockHdrDataResource;
readonly sectionsData: SectionsDataResource;
/**
* Create a new VMIClient instance
* @param http Configured HTTPClient instance
* @param baseUrl Base URL for the VMI API (default: https://vmi.augur-api.com)
*/
constructor(http: HTTPClient, baseUrl?: string);
}
//# sourceMappingURL=client.d.ts.map