@simpleapps-com/augur-api/dist/types/services/shipping/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 RatesResource, type RatesDataResource } from './resources';
/**
 * Shipping Service Client
 *
 * Provides access to comprehensive shipping rate calculation, carrier comparison,
 * and shipping cost optimization across multiple carriers and service types.
 * Supports domestic and international shipping with detailed rate analysis.
 *
 * @service shipping
 * @domain shipping-and-logistics
 * @discoverable true
 * @searchTerms ["shipping", "carriers", "rates", "freight", "delivery", "logistics"]
 * @relatedEndpoints ["api.logistics.speedship.freight.get", "api.commerce.cart.shipping.calculate", "api.orders.shipping.estimate"]
 * @commonPatterns ["Shipping rate calculation", "Carrier comparison", "Freight quotes", "Delivery estimation"]
 * @workflow ["e-commerce-checkout", "order-fulfillment", "shipping-estimation", "cost-analysis"]
 * @functionalArea "shipping-and-logistics"
 * @businessRules ["Requires valid bearer authentication", "Multi-carrier support", "Real-time rate calculation", "Address validation"]
 * @performance "Optimized for multi-carrier rate comparison and shipping workflows"
 * @example
 * ```typescript
 * import { HTTPClient } from '@augur/api-client/core';
 * import { ShippingClient } from '@augur/api-client/services/shipping';
 *
 * const http = new HTTPClient('shipping', { siteId: 'your-site-id', bearerToken: 'your-token' });
 * const shipping = new ShippingClient(http);
 *
 * // Check service health
 * const health = await shipping.healthCheck.get({ siteId: 1 });
 * const healthData = await shipping.healthCheckData.get({ siteId: 1 });
 *
 * // Get shipping rates
 * const rates = await shipping.rates.create({
 *   origin: { zip: '10001', country: 'US' },
 *   destination: { zip: '90210', country: 'US' },
 *   packages: [{ weight: 5, length: 10, width: 8, height: 6, unit: 'lb' }]
 * });
 *
 * // Get rates data only
 * const ratesData = await shipping.ratesData.create({ ... });
 * ```
 */
export declare class ShippingClient extends BaseServiceClient {
    /** Health check resource */
    readonly healthCheck: HealthCheckResource;
    /** Health check data resource (data-only) */
    readonly healthCheckData: HealthCheckDataResource;
    /** Rates resource */
    readonly rates: RatesResource;
    /** Rates data resource (data-only) */
    readonly ratesData: RatesDataResource;
    constructor(http: HTTPClient, baseUrl?: string);
    protected getServiceDescription(): string;
}
//# sourceMappingURL=client.d.ts.map