UNPKG

@simpleapps-com/augur-api

Version:

TypeScript client library for Augur microservices API endpoints

70 lines 2.98 kB
import { BaseServiceClient } from '../../core/base-client'; import type { HTTPClient } from '../../core/client'; import { type HealthCheckResource, type HealthCheckDataResource, type InvMastResource, type InvMastDataResource, type ItemCategoryResource, type ItemCategoryDataResource, type OrdersResource, type OrdersDataResource, type StateResource, type StateDataResource } from './resources'; /** * Legacy API Client * @description Client for interacting with Legacy microservice API endpoints following OpenAPI Path Mirroring Pattern * @fullPath api.legacy * @service legacy * @domain legacy-data-management * @discoverable true * @searchTerms ["legacy", "states", "inventory", "orders", "tags", "categories"] * @relatedEndpoints ["items", "customers", "orders"] * @commonPatterns ["CRUD operations", "state management", "inventory tagging"] * @example * ```typescript * import { HTTPClient } from '@augur/api-client/core'; * import { LegacyClient } from '@augur/api-client/services/legacy'; * * const http = new HTTPClient('legacy', { siteId: 'your-site-id', bearerToken: 'your-token' }); * const legacy = new LegacyClient(http); * * // Health check * const health = await legacy.healthCheck.get(); * * // Inventory operations * const alsoBought = await legacy.invMast.alsoBought.list(12345); * const tags = await legacy.invMast.tags.list(12345); * const webDesc = await legacy.invMast.webDesc.list(12345); * * // State management * const states = await legacy.legacy.state.list({ limit: 25, twoLetterCode: 'CA' }); * * // Categories and orders * const category = await legacy.itemCategory.get(67890); * const resetResult = await legacy.orders.reset.get(98765); * ``` */ export declare class LegacyClient extends BaseServiceClient { /** Health check resource */ readonly healthCheck: HealthCheckResource; /** Health check data resource (data-only) */ readonly healthCheckData: HealthCheckDataResource; /** Inventory master resource */ readonly invMast: InvMastResource; /** Inventory master data resource (data-only) */ readonly invMastData: InvMastDataResource; /** Item category resource */ readonly itemCategory: ItemCategoryResource; /** Item category data resource (data-only) */ readonly itemCategoryData: ItemCategoryDataResource; /** Orders resource */ readonly orders: OrdersResource; /** Orders data resource (data-only) */ readonly ordersData: OrdersDataResource; /** Legacy namespace (for /legacy/* paths) */ readonly legacy: { state: StateResource; }; /** Legacy data namespace */ readonly legacyData: { state: StateDataResource; }; /** * Create a new LegacyClient instance * @param http Configured HTTPClient instance * @param baseUrl Base URL for the Legacy API (default: https://legacy.augur-api.com) */ constructor(http: HTTPClient, baseUrl?: string); } //# sourceMappingURL=client.d.ts.map