@simpleapps-com/augur-api 0.3.0 → 0.3.1

package/dist/types/services/p21-apis/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../../src/services/p21-apis/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB;;GAEG;AACH,eAAO,MAAM,iCAAiC;;;;;;EAE5C,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;EAE7C,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;EAElC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;EAIpC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;EAE1C,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;EAInC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,8BAA8B;;;;;;EAEzC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;;EAGhD,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;EAIhC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;EAEtC,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;EAI1C,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,qCAAqC;;;;;;EAEhD,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,uCAAuC;;;;;;EAElD,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,yCAAyC;;;;;;EAEpD,CAAC;AAIH;;GAEG;AACH,eAAO,MAAM,qBAAqB,cAA0D,CAAC;AAE7F;;GAEG;AACH,eAAO,MAAM,uBAAuB,cAA0D,CAAC;AAE/F;;GAEG;AACH,eAAO,MAAM,uBAAuB,cAA2D,CAAC;AAEhG;;GAEG;AACH,eAAO,MAAM,sBAAsB,cAA0D,CAAC;AAE9F;;GAEG;AACH,eAAO,MAAM,mCAAmC,cAEC,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,mBAAmB,cAAuD,CAAC;AAExF;;GAEG;AACH,eAAO,MAAM,6BAA6B,cAAuD,CAAC;AAElG;;GAEG;AACH,eAAO,MAAM,qCAAqC,cAEJ,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,uCAAuC,cAEF,CAAC;AAInD;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA4C,CAAC;AAEnF;;GAEG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA8C,CAAC;AAE/F;;GAEG;AACH,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA8C,CAAC;AAEhG;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA8C,CAAC;AAEvF;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA6C,CAAC;AAErF;;GAEG;AACH,eAAO,MAAM,uCAAuC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEnD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA0C,CAAC;AAE/E;;GAEG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAoD,CAAC;AAEnG;;GAEG;AACH,eAAO,MAAM,yCAAyC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAErD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEvD,CAAC;AAIF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAC5F,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAC9F,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AACxF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACtF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC;AACpG,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAChF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AACxF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC;AACpG,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,uCAAuC,CAC/C,CAAC;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,yCAAyC,CACjD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAChG,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AACpF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC;AACpG,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,uCAAuC,CAC/C,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAChG,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAC;AAClG,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAChF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,uCAAuC,CAC/C,CAAC;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAC5F,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,yCAAyC,CACjD,CAAC;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,2CAA2C,CACnD,CAAC"}

package/dist/types/services/shipping/client.d.ts

@@ -0,0 +1,201 @@
+import { BaseServiceClient } from '../../core/base-client';
+import type { HTTPClient } from '../../core/client';
+import { HealthCheckParams, HealthCheckResponse, RatesRequestParams, RatesResponse, RatesData } from './schemas';
+/**
+ * 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
+ */
+export declare class ShippingClient extends BaseServiceClient {
+    constructor(http: HTTPClient, baseUrl?: string);
+    protected getServiceDescription(): string;
+    /**
+     * Check shipping service health and availability
+     *
+     * @fullPath api.shipping.healthCheck.get
+     * @service shipping
+     * @domain system-health
+     * @dataMethod healthCheckData
+     * @discoverable true
+     * @searchTerms ["health", "status", "availability", "ping", "check", "shipping service", "carriers", "rates"]
+     * @relatedEndpoints ["api.shipping.rates.calculate", "api.logistics.healthCheck.get", "api.commerce.healthCheck.get", "api.orders.healthCheck.get"]
+     * @commonPatterns ["Health check", "Service status", "Shipping service availability", "System monitoring", "Carrier connectivity"]
+     * @workflow ["system-monitoring", "health-checks", "service-discovery", "shipping-service-verification", "carrier-status-check"]
+     * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header", "Carrier API connections"]
+     * @nextSteps ["Use shipping rate endpoints if healthy", "Verify carrier API connectivity", "Monitor shipping service metrics"]
+     * @businessRules ["Returns service and carrier status", "Requires standard authentication", "Standard health check format"]
+     * @functionalArea "system-monitoring"
+     * @caching "No caching - real-time status required"
+     * @performance "Fast response, minimal processing, use for shipping service monitoring"
+     *
+     * @param params Health check parameters with site ID
+     * @returns Promise<HealthCheckResponse> Service health status with carrier availability
+     *
+     * @example
+     * ```typescript
+     * // Check if shipping service is healthy
+     * const response = await client.healthCheck({ 'x-site-id': 'SITE123' });
+     * console.log(response.data.status); // 'healthy'
+     * console.log(response.data.service); // 'shipping'
+     * console.log(response.status); // HTTP status code
+     *
+     * // Get just the health status
+     * const status = await client.healthCheckData({ 'x-site-id': 'SITE123' });
+     * console.log(status); // Health data object
+     * ```
+     */
+    healthCheck(params: HealthCheckParams): Promise<HealthCheckResponse>;
+    /**
+     * Get comprehensive shipping rates from multiple carriers
+     *
+     * @fullPath api.shipping.rates.calculate
+     * @service shipping
+     * @domain shipping-and-logistics
+     * @dataMethod ratesData
+     * @discoverable true
+     * @searchTerms ["shipping rates", "calculate cost", "carrier comparison", "freight quotes", "delivery cost", "ups", "fedex", "usps", "dhl", "shipping options"]
+     * @relatedEndpoints ["api.logistics.speedship.freight.get", "api.commerce.cart.shipping.calculate", "api.orders.shipping.estimate", "api.customers.addresses.validate"]
+     * @commonPatterns ["Calculate shipping cost", "Compare carrier rates", "Get delivery options", "Estimate shipping", "Find cheapest option", "Get fastest delivery"]
+     * @workflow ["e-commerce-checkout", "order-fulfillment", "shipping-estimation", "cost-analysis", "carrier-selection", "delivery-planning"]
+     * @prerequisites ["Valid shipping addresses", "Package dimensions and weight", "Valid authentication token", "x-site-id header", "Carrier API access"]
+     * @nextSteps ["Select shipping option", "Create shipping label", "Track shipment", "Update order with shipping cost", "Process payment with shipping"]
+     * @businessRules ["Requires complete address information", "Package weight/dimensions mandatory", "Supports multiple packages", "Returns carrier-specific rates", "Includes all fees and surcharges"]
+     * @functionalArea "shipping-and-logistics"
+     * @crossSite "Supports multi-site shipping configurations and carrier accounts"
+     * @caching "Cache rates for 15 minutes, invalidate on address or package changes"
+     * @performance "Parallel carrier API calls, use response format to optimize data size, supports pagination for large results"
+     *
+     * @param params Comprehensive shipping rate request with origin, destination, and package details
+     * @returns Promise<RatesResponse> Complete shipping rates from multiple carriers with detailed analysis
+     *
+     * @example
+     * ```typescript
+     * // Calculate shipping rates for e-commerce order
+     * const rateRequest = {
+     *   // Origin address (warehouse/fulfillment center)
+     *   fromAddressLine: '123 Warehouse Blvd',
+     *   fromCity: 'Los Angeles',
+     *   fromState: 'CA',
+     *   fromPostalCode: '90210',
+     *   fromCountryCode: 'US',
+     *   fromCompanyName: 'E-Commerce Fulfillment',
+     *
+     *   // Customer delivery address
+     *   toAddressLine: '456 Customer St',
+     *   toCity: 'New York',
+     *   toState: 'NY',
+     *   toPostalCode: '10001',
+     *   toCountryCode: 'US',
+     *   toCompanyName: 'Customer Corp',
+     *
+     *   // Package information
+     *   packages: [{
+     *     length: 12,
+     *     width: 8,
+     *     height: 6,
+     *     weight: 2.5,
+     *     dimensionUnit: 'in',
+     *     weightUnit: 'lb',
+     *     value: 150.00,
+     *     description: 'Electronics order'
+     *   }],
+     *
+     *   // Shipping preferences
+     *   serviceType: 'ground',
+     *   carriers: ['ups', 'fedex', 'usps'],
+     *   responseFormat: 'detailed',
+     *   'x-site-id': 'SITE123'
+     * };
+     *
+     * const response = await client.rates(rateRequest);
+     * console.log(response.data.rates); // Array of shipping rates
+     * console.log(response.data.comparison.cheapest); // Cheapest option
+     * console.log(response.data.comparison.fastest); // Fastest option
+     *
+     * // Get just the rates data
+     * const rates = await client.ratesData(rateRequest);
+     * console.log(rates); // Direct rates data access
+     *
+     * // Find cheapest ground shipping
+     * const cheapestGround = await client.rates({
+     *   ...rateRequest,
+     *   serviceType: 'ground',
+     *   responseFormat: 'cheapest'
+     * });
+     *
+     * // Compare overnight options
+     * const overnightOptions = await client.rates({
+     *   ...rateRequest,
+     *   serviceType: 'overnight',
+     *   responseFormat: 'all'
+     * });
+     *
+     * // International shipping with insurance
+     * const internationalRates = await client.rates({
+     *   ...rateRequest,
+     *   toCountryCode: 'CA', // Canada
+     *   serviceType: 'international',
+     *   insuranceValue: 500.00,
+     *   signatureRequired: true
+     * });
+     * ```
+     */
+    rates(params: RatesRequestParams): Promise<RatesResponse>;
+    /**
+     * Get shipping service health data without full response metadata
+     *
+     * @fullPath api.shipping.healthCheckData.get
+     * @service shipping
+     * @domain system-health
+     * @dataMethod healthCheckData
+     * @discoverable true
+     * @searchTerms ["health data", "service status", "shipping availability", "carrier status"]
+     * @relatedEndpoints ["api.shipping.healthCheck.get", "api.shipping.rates.calculate"]
+     * @commonPatterns ["Get health status", "Check carrier availability", "Service monitoring"]
+     * @workflow ["system-monitoring", "health-checks", "service-verification"]
+     * @prerequisites ["Valid authentication token", "x-site-id header"]
+     * @nextSteps ["Use shipping endpoints if healthy", "Monitor service metrics"]
+     * @businessRules ["Returns only health data object", "No response metadata included"]
+     * @functionalArea "system-monitoring"
+     * @caching "No caching - real-time status required"
+     * @performance "Direct data access, faster for simple health checks"
+     *
+     * @param params Health check parameters with site ID
+     * @returns Promise<HealthCheckData> Direct health status data object
+     */
+    healthCheckData(params: HealthCheckParams): Promise<{
+        status: string;
+        service: string;
+        timestamp?: string | undefined;
+        version?: string | undefined;
+    }>;
+    /**
+     * Get shipping rates data without full response metadata
+     *
+     * @fullPath api.shipping.ratesData.calculate
+     * @service shipping
+     * @domain shipping-and-logistics
+     * @dataMethod ratesData
+     * @discoverable true
+     * @searchTerms ["rates data", "shipping cost", "carrier quotes", "delivery prices", "freight data"]
+     * @relatedEndpoints ["api.shipping.rates.calculate", "api.logistics.speedship.freight.get"]
+     * @commonPatterns ["Get rates data", "Calculate shipping cost", "Compare carrier options"]
+     * @workflow ["e-commerce-checkout", "order-fulfillment", "shipping-estimation"]
+     * @prerequisites ["Valid shipping addresses", "Package details", "Valid authentication token"]
+     * @nextSteps ["Select shipping option", "Create shipping label", "Process payment"]
+     * @businessRules ["Returns only rates data", "No response metadata included", "Direct access to rate comparison"]
+     * @functionalArea "shipping-and-logistics"
+     * @caching "Cache rates for 15 minutes"
+     * @performance "Direct data access, optimal for rate comparisons and integrations"
+     *
+     * @param params Comprehensive shipping rate request parameters
+     * @returns Promise<RatesData> Direct shipping rates data without response wrapper
+     */
+    ratesData(params: RatesRequestParams): Promise<RatesData>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/types/services/shipping/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/services/shipping/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAEL,iBAAiB,EAEjB,mBAAmB,EAEnB,kBAAkB,EAElB,aAAa,EACb,SAAS,EACV,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;GASG;AACH,qBAAa,cAAe,SAAQ,iBAAiB;gBACvC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM;IAI9C,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAY1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8FG;IACG,KAAK,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAc/D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,eAAe,CAAC,MAAM,EAAE,iBAAiB;;;;;;IAK/C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;CAIhE"}

package/dist/types/services/shipping/index.d.ts

@@ -0,0 +1,4 @@
+export { ShippingClient } from './client';
+export type { HealthCheckParams, RatesRequestParams, HealthCheckData, ShippingRate, ShippingRatesSummary, ShippingRatesDetailed, ShippingRatesResult, RatesData, HealthCheckResponse, RatesResponse, } from './schemas';
+export { HealthCheckParamsSchema, RatesRequestParamsSchema, HealthCheckDataSchema, ShippingRateSchema, ShippingRatesSummarySchema, ShippingRatesDetailedSchema, ShippingRatesResultSchema, RatesDataSchema, HealthCheckResponseSchema, RatesResponseSchema, } from './schemas';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/services/shipping/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/shipping/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,YAAY,EACV,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,SAAS,EACT,mBAAmB,EACnB,aAAa,GACd,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,qBAAqB,EACrB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,yBAAyB,EACzB,eAAe,EACf,yBAAyB,EACzB,mBAAmB,GACpB,MAAM,WAAW,CAAC"}