@simpleapps-com/augur-api/dist/types/services/logistics/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 SpeedshipResource, type SpeedshipDataResource, type ShipviaResource, type ShipviaDataResource } from './resources';
/**
 * Logistics Service Client
 *
 * Provides access to shipping and logistics endpoints for freight rate calculation,
 * carrier comparison, and shipping cost optimization.
 *
 * @service logistics
 * @domain shipping-and-logistics
 * @discoverable true
 * @searchTerms ["logistics", "shipping", "freight", "carriers", "delivery", "speedship"]
 * @relatedEndpoints ["api.commerce.orders.create", "api.commerce.cartHeaders.checkout", "api.customers.addresses.validate"]
 * @commonPatterns ["Freight shipping", "Rate calculation", "Carrier comparison", "Shipping cost optimization"]
 * @workflow ["order-fulfillment", "shipping-calculation", "carrier-selection", "freight-management"]
 * @functionalArea "shipping-and-logistics"
 * @performance "Optimized for freight rate calculation and carrier comparison"
 * @example
 * ```typescript
 * import { HTTPClient } from '@augur/api-client/core';
 * import { LogisticsClient } from '@augur/api-client/services/logistics';
 *
 * const http = new HTTPClient('logistics', { siteId: 'your-site-id', bearerToken: 'your-token' });
 * const logistics = new LogisticsClient(http);
 *
 * // Check service health
 * const health = await logistics.healthCheck.get();
 * const healthData = await logistics.healthCheckData.get();
 *
 * // Test connectivity
 * const pong = await logistics.ping.get();
 *
 * // Get freight rates
 * const rates = await logistics.speedship.freight.get({
 *   fromAddressLine: '123 Warehouse St',
 *   fromCity: 'Los Angeles',
 *   fromState: 'CA',
 *   fromPostalCode: '90210',
 *   fromCountryCode: 'US',
 *   toAddressLine: '456 Customer Ave',
 *   toCity: 'New York',
 *   toRegion: 'NY',
 *   toPostalCode: '10001',
 *   toCountryCode: 'US',
 *   packageLength: 48,
 *   packageWidth: 40,
 *   packageHeight: 36,
 *   totalWeight: 500,
 *   productType: 'LTL'
 * });
 * ```
 */
export declare class LogisticsClient 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;
    /** Speedship resource */
    readonly speedship: SpeedshipResource;
    /** Speedship data resource (data-only) */
    readonly speedshipData: SpeedshipDataResource;
    /** ShipVia resource */
    readonly shipvia: ShipviaResource;
    /** ShipVia data resource (data-only) */
    readonly shipviaData: ShipviaDataResource;
    constructor(http: HTTPClient, baseUrl?: string);
    protected getServiceDescription(): string;
}
//# sourceMappingURL=client.d.ts.map