@simpleapps-com/augur-api 0.3.0 → 0.3.1

package/dist/esm/services/logistics/client.js

@@ -0,0 +1,241 @@
+import { BaseServiceClient } from '../../core/base-client';
+import { HealthCheckResponseSchema, PingResponseSchema, SpeedshipFreightRequestParamsSchema, SpeedshipFreightResponseSchema, } from './schemas';
+/**
+ * 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
+ */
+export class LogisticsClient extends BaseServiceClient {
+    constructor(http, baseUrl) {
+        super('logistics', http, baseUrl || 'https://logistics.augur-api.com');
+        /**
+         * Check service health and availability
+         *
+         * @fullPath api.logistics.healthCheck.get
+         * @service logistics
+         * @domain system-health
+         * @dataMethod healthCheckData
+         * @discoverable true
+         * @searchTerms ["health", "status", "availability", "ping", "check", "shipping service", "logistics"]
+         * @relatedEndpoints ["api.logistics.ping.get", "api.logistics.speedship.freight.get", "api.commerce.healthCheck.get", "api.orders.healthCheck.get"]
+         * @commonPatterns ["Health check", "Service status", "Shipping service availability", "System monitoring"]
+         * @workflow ["system-monitoring", "health-checks", "service-discovery", "logistics-service-verification"]
+         * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header"]
+         * @nextSteps ["Use shipping endpoints if healthy", "Verify logistics service connectivity", "Monitor service metrics"]
+         * @businessRules ["Returns service status and basic info", "Requires standard authentication", "Standard health check format"]
+         * @functionalArea "system-monitoring"
+         * @caching "No caching - real-time status required"
+         * @performance "Fast response, minimal processing, use for logistics service monitoring"
+         *
+         * @returns Promise<HealthCheckResponse> Service health status
+         *
+         * @example
+         * ```typescript
+         * // Check if logistics service is healthy
+         * const response = await client.healthCheck();
+         * console.log(response.data); // Health status string
+         * console.log(response.status); // HTTP status code
+         *
+         * // Get just the health status
+         * const status = await client.healthCheckData();
+         * console.log(status); // Direct string access
+         * ```
+         */
+        this.healthCheck = this.createHealthCheckMethod(HealthCheckResponseSchema);
+        /**
+         * Ping the logistics service for basic connectivity testing
+         *
+         * @fullPath api.logistics.ping.get
+         * @service logistics
+         * @domain system-connectivity
+         * @dataMethod pingData
+         * @discoverable true
+         * @searchTerms ["ping", "pong", "connectivity", "test", "network", "response", "logistics"]
+         * @relatedEndpoints ["api.logistics.healthCheck.get", "api.logistics.speedship.freight.get", "api.commerce.ping.get"]
+         * @commonPatterns ["Ping test", "Network connectivity", "Service response test", "Basic connectivity check"]
+         * @workflow ["connectivity-testing", "network-diagnostics", "service-verification", "latency-measurement"]
+         * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header", "Network connectivity"]
+         * @nextSteps ["Measure response time", "Verify network stability", "Test full service endpoints"]
+         * @businessRules ["Returns pong response", "Requires standard authentication", "Minimal response format"]
+         * @functionalArea "system-monitoring"
+         * @caching "No caching - real-time connectivity test required"
+         * @performance "Extremely fast response, use for latency testing and connectivity verification"
+         *
+         * @returns Promise<PingResponse> Pong response confirming connectivity
+         *
+         * @example
+         * ```typescript
+         * // Test logistics service connectivity
+         * const response = await client.ping();
+         * console.log(response.data); // "pong" response
+         * console.log(response.status); // HTTP status code
+         *
+         * // Get just the ping response
+         * const pong = await client.pingData();
+         * console.log(pong); // Direct pong string
+         *
+         * // Measure response time
+         * const start = Date.now();
+         * await client.ping();
+         * const responseTime = Date.now() - start;
+         * console.log(`Logistics service response time: ${responseTime}ms`);
+         * ```
+         */
+        this.ping = this.createPingMethod(PingResponseSchema);
+        /**
+         * Get freight shipping rates from Speedship carriers
+         *
+         * @fullPath api.logistics.speedship.freight.get
+         * @service logistics
+         * @domain freight-shipping
+         * @dataMethod speedshipFreightData
+         * @discoverable true
+         * @searchTerms ["freight", "shipping", "rates", "speedship", "carriers", "logistics", "delivery", "transportation", "ltl", "smallpack"]
+         * @relatedEndpoints ["api.commerce.orders.create", "api.commerce.cartHeaders.checkout", "api.customers.addresses.validate", "api.avalara.rates.calculate"]
+         * @commonPatterns ["Get shipping rates", "Compare freight carriers", "Calculate shipping costs", "Freight quote", "Logistics pricing", "Carrier comparison"]
+         * @workflow ["order-fulfillment", "shipping-calculation", "carrier-selection", "cost-optimization", "freight-management"]
+         * @prerequisites ["Valid shipping addresses", "Package dimensions and weight", "Public bearer token", "x-site-id header"]
+         * @nextSteps ["Select carrier and service", "Create shipping label", "Process order fulfillment", "Track shipment"]
+         * @businessRules ["Requires valid origin and destination addresses", "Supports LTL and SMALLPACK product types", "Multiple response formats available", "Weight and dimension validation", "Carrier-specific requirements"]
+         * @functionalArea "shipping-and-fulfillment"
+         * @crossSite "Multi-site shipping rate calculation support"
+         * @caching "Cache for 30 minutes for identical shipments, rates change throughout the day"
+         * @performance "Response time varies by carrier availability, use response format optimization for faster results"
+         *
+         * @param params Comprehensive freight shipping parameters including addresses, package details, and service preferences
+         * @returns Promise<SpeedshipFreightResponse> Complete freight rate information with carrier options and pricing details
+         *
+         * @example
+         * ```typescript
+         * // Get freight rates for LTL shipment
+         * const freightRequest = {
+         *   // Origin address
+         *   fromAddressLine: '123 Warehouse St',
+         *   fromCity: 'Los Angeles',
+         *   fromState: 'CA',
+         *   fromPostalCode: '90210',
+         *   fromCountryCode: 'US',
+         *   fromCompanyName: 'ABC Logistics',
+         *   fromFirstName: 'John',
+         *   fromLastName: 'Doe',
+         *   fromPhone: '555-0123',
+         *
+         *   // Destination address
+         *   toAddressLine: '456 Customer Ave',
+         *   toCity: 'New York',
+         *   toRegion: 'NY',
+         *   toPostalCode: '10001',
+         *   toCountryCode: 'US',
+         *   toCompanyName: 'Customer Corp',
+         *   toFirstName: 'Jane',
+         *   toLastName: 'Smith',
+         *   toPhone: '555-0456',
+         *
+         *   // Package details
+         *   packageLength: 48,
+         *   packageWidth: 40,
+         *   packageHeight: 36,
+         *   totalWeight: 500,
+         *   quantity: 1,
+         *
+         *   // Service configuration
+         *   productType: 'LTL',
+         *   responseFormat: 'detailed',
+         *   dimensionUnit: 'IN',
+         *   weightUnit: 'LB'
+         * };
+         *
+         * const response = await client.speedshipFreight(freightRequest);
+         * console.log(response.data); // Detailed freight rates
+         *
+         * // Get just the rate data
+         * const rates = await client.speedshipFreightData(freightRequest);
+         * console.log(rates); // Direct access to freight rates
+         *
+         * // Get cheapest rate only
+         * const cheapestRequest = {
+         *   ...freightRequest,
+         *   responseFormat: 'cheapest' as const
+         * };
+         * const cheapest = await client.speedshipFreightData(cheapestRequest);
+         *
+         * // Small package shipment
+         * const smallPackRequest = {
+         *   fromAddressLine: '789 Ship St',
+         *   fromCity: 'Chicago',
+         *   fromState: 'IL',
+         *   fromPostalCode: '60601',
+         *   fromCountryCode: 'US',
+         *   fromCompanyName: 'Small Biz',
+         *   fromFirstName: 'Bob',
+         *   fromLastName: 'Wilson',
+         *   fromPhone: '555-0789',
+         *
+         *   toAddressLine: '321 Delivery Ln',
+         *   toCity: 'Miami',
+         *   toRegion: 'FL',
+         *   toPostalCode: '33101',
+         *   toCountryCode: 'US',
+         *   toCompanyName: 'Customer LLC',
+         *   toFirstName: 'Alice',
+         *   toLastName: 'Johnson',
+         *   toPhone: '555-0321',
+         *
+         *   packageLength: 12,
+         *   packageWidth: 8,
+         *   packageHeight: 6,
+         *   totalWeight: 5,
+         *   quantity: 1,
+         *   productType: 'SMALLPACK',
+         *   responseFormat: 'summary',
+         *   dimensionUnit: 'IN',
+         *   weightUnit: 'LB'
+         * };
+         *
+         * const smallPackRates = await client.speedshipFreightData(smallPackRequest);
+         * ```
+         */
+        this.speedshipFreight = async (params) => {
+            return this.executeRequest({
+                method: 'GET',
+                path: '/speedship/freight',
+                paramsSchema: SpeedshipFreightRequestParamsSchema,
+                responseSchema: SpeedshipFreightResponseSchema,
+            }, params);
+        };
+        // Data-only methods for direct access to response data
+        /**
+         * Get health check status data only
+         * @returns Promise<string> Health status string
+         */
+        this.healthCheckData = async () => {
+            const response = await this.healthCheck();
+            return response.data;
+        };
+        /**
+         * Get ping response data only
+         * @returns Promise<string> Pong response string
+         */
+        this.pingData = async () => {
+            const response = await this.ping();
+            return response.data;
+        };
+        /**
+         * Get freight shipping rates data only
+         * @param params Freight shipping request parameters
+         * @returns Promise<SpeedshipFreightResult> Freight rate data with carrier options and pricing
+         */
+        this.speedshipFreightData = async (params) => {
+            const response = await this.speedshipFreight(params);
+            return response.data;
+        };
+    }
+    getServiceDescription() {
+        return 'Shipping and logistics service for freight rate calculation and carrier comparison';
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/esm/services/logistics/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/services/logistics/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,mCAAmC,EAEnC,8BAA8B,GAG/B,MAAM,WAAW,CAAC;AAEnB;;;;;;;;GAQG;AACH,MAAM,OAAO,eAAgB,SAAQ,iBAAiB;IACpD,YAAY,IAAgB,EAAE,OAAgB;QAC5C,KAAK,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,IAAI,iCAAiC,CAAC,CAAC;QAOzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgCG;QACM,gBAAW,GAAG,IAAI,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;QAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAsCG;QACM,SAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;QAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgHG;QACM,qBAAgB,GAAG,KAAK,EAC/B,MAAqC,EACF,EAAE;YACrC,OAAO,IAAI,CAAC,cAAc,CACxB;gBACE,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,oBAAoB;gBAC1B,YAAY,EAAE,mCAAmC;gBACjD,cAAc,EAAE,8BAA8B;aAC/C,EACD,MAAM,CACP,CAAC;QACJ,CAAC,CAAC;QAEF,uDAAuD;QAEvD;;;WAGG;QACM,oBAAe,GAAG,KAAK,IAAqB,EAAE;YACrD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC,CAAC;QAEF;;;WAGG;QACM,aAAQ,GAAG,KAAK,IAAqB,EAAE;YAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC,CAAC;QAEF;;;;WAIG;QACM,yBAAoB,GAAG,KAAK,EACnC,MAAqC,EACJ,EAAE;YACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC,CAAC;IA/OF,CAAC;IAES,qBAAqB;QAC7B,OAAO,oFAAoF,CAAC;IAC9F,CAAC;CA4OF"}

package/dist/esm/services/logistics/index.d.ts

@@ -0,0 +1,4 @@
+export { LogisticsClient } from './client';
+export type { HealthCheckResponse, PingResponse, SpeedshipFreightRequestParams, SpeedshipFreightResponse, SpeedshipFreightResult, FreightRateResult, FreightSummaryResult, FreightDetailedResult, } from './schemas';
+export { HealthCheckResponseSchema, PingResponseSchema, SpeedshipFreightRequestParamsSchema, SpeedshipFreightResponseSchema, SpeedshipFreightResultSchema, FreightRateResultSchema, FreightSummaryResultSchema, FreightDetailedResultSchema, } from './schemas';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/services/logistics/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/logistics/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,YAAY,EACV,mBAAmB,EACnB,YAAY,EACZ,6BAA6B,EAC7B,wBAAwB,EACxB,sBAAsB,EACtB,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,mCAAmC,EACnC,8BAA8B,EAC9B,4BAA4B,EAC5B,uBAAuB,EACvB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,WAAW,CAAC"}

package/dist/esm/services/logistics/index.js

@@ -0,0 +1,4 @@
+// Logistics Service Exports
+export { LogisticsClient } from './client';
+export { HealthCheckResponseSchema, PingResponseSchema, SpeedshipFreightRequestParamsSchema, SpeedshipFreightResponseSchema, SpeedshipFreightResultSchema, FreightRateResultSchema, FreightSummaryResultSchema, FreightDetailedResultSchema, } from './schemas';
+//# sourceMappingURL=index.js.map

package/dist/esm/services/logistics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/logistics/index.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAW3C,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,mCAAmC,EACnC,8BAA8B,EAC9B,4BAA4B,EAC5B,uBAAuB,EACvB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,WAAW,CAAC"}