@oway/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,1410 @@
+interface OwayConfig {
+    /**
+     * M2M Client ID (REQUIRED for all integrations)
+     * Provided by Oway Sales Engineering team
+     */
+    clientId: string;
+    /**
+     * M2M Client Secret (REQUIRED for all integrations)
+     * Provided by Oway Sales Engineering team
+     */
+    clientSecret: string;
+    /**
+     * Default company API key (optional)
+     *
+     * Single-company: Set this to your company's API key
+     * Multi-company: Omit this and provide per-request
+     *
+     * Get from: https://app.oway.io/settings/api
+     */
+    apiKey?: string;
+    /**
+     * Base URL for the Oway API
+     * @default "https://rest-api.sandbox.oway.io"
+     */
+    baseUrl?: string;
+    /**
+     * Token endpoint for authentication
+     * @default "https://rest-api.sandbox.oway.io/v1/auth/token"
+     */
+    tokenUrl?: string;
+    /**
+     * Maximum number of retry attempts for failed requests
+     * @default 3
+     */
+    maxRetries?: number;
+    /**
+     * Timeout in milliseconds for API requests
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Enable debug logging (logs sanitized request/response metadata)
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Custom logger implementation
+     */
+    logger?: {
+        debug: (msg: string, meta?: Record<string, any>) => void;
+        info: (msg: string, meta?: Record<string, any>) => void;
+        warn: (msg: string, meta?: Record<string, any>) => void;
+        error: (msg: string, meta?: Record<string, any>) => void;
+    };
+}
+declare class OwayError extends Error {
+    code?: string | undefined;
+    statusCode?: number | undefined;
+    requestId?: string | undefined;
+    constructor(message: string, code?: string | undefined, statusCode?: number | undefined, requestId?: string | undefined);
+    /**
+     * Determines if this error represents a transient failure that should be retried
+     */
+    isRetryable(): boolean;
+}
+/**
+ * HTTP client for making authenticated requests to the Oway API
+ */
+declare class HttpClient {
+    private config;
+    private accessToken;
+    private tokenExpiry;
+    private tokenRefreshPromise;
+    constructor(config: OwayConfig);
+    /**
+     * Internal logging with sanitization
+     */
+    private log;
+    /**
+     * Sanitize objects for logging - remove sensitive fields
+     */
+    private sanitizeForLogging;
+    /**
+     * Get or refresh the access token using the API key
+     * Handles concurrent requests by queuing them behind a single refresh
+     */
+    private getAccessToken;
+    /**
+     * Perform the actual token refresh using M2M credentials
+     */
+    private refreshToken;
+    /**
+     * Generate a unique request ID
+     */
+    private generateRequestId;
+    /**
+     * Make an authenticated request to the Oway API
+     */
+    request<T>(method: string, path: string, options?: {
+        query?: Record<string, string | number | boolean>;
+        body?: unknown;
+        headers?: Record<string, string>;
+        requestId?: string;
+        companyApiKey?: string;
+    }): Promise<T>;
+    get<T>(path: string, query?: Record<string, string | number | boolean>, companyApiKey?: string): Promise<T>;
+    post<T>(path: string, body?: unknown, companyApiKey?: string): Promise<T>;
+    put<T>(path: string, body?: unknown, companyApiKey?: string): Promise<T>;
+    delete<T>(path: string, companyApiKey?: string): Promise<T>;
+}
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/v1/shipper/shipment/{orderNumber}/confirm": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Confirm a shipment by order number
+         * @description Confirms an existing shipment using its order number (PRO number).
+         *     Moves the shipment from INITIALIZED to CONFIRMED state.
+         *
+         *     **Prerequisites:**
+         *     - The order must be in INITIALIZED state
+         *     - The order must have an associated quote
+         *
+         *     **Validation Requirements:**
+         *
+         *     The following fields are validated during confirmation. If any are missing or invalid,
+         *     the shipment will remain in INITIALIZED state.
+         *
+         *     *Address Fields (required on BOTH pickup and delivery addresses):*
+         *     - `name` - Location/company name
+         *     - `address1` - Street address
+         *     - `zipCode` - ZIP code
+         *     - `contactPerson` - Contact name
+         *     - `phoneNumber` - Contact phone (E.164 format, e.g., "+15551234567")
+         *     - `openTime` - Opening time in HH:mm format (defaults to "10:00")
+         *     - `closeTime` - Closing time in HH:mm format (defaults to "16:00")
+         *
+         *     *Order Fields:*
+         *     - `description` - Must not be empty
+         *     - `totalPalletCount` - Must be between 1 and 51
+         *     - `totalPoundsWeight` - Must be between 1 and 2,500 lbs per pallet
+         *
+         *     *Order Component Fields (per component):*
+         *     - `palletCount` - Must be at least 1
+         *     - `poundsWeight` - Must be between 1 and 2,500 lbs per pallet
+         *     - `palletDimensions` - Must be valid dimensions within limits (subject to change, these are configurable):
+         *       - Standard: max 60×52×94 inches (L×W×H) - pallets exceeding these are charged as oversized
+         *       - Oversized maximum: 95×95×96 inches - no pallet can exceed this
+         *       - With liftgate: max 62×62×94 inches
+         *
+         *     *Component Totals:*
+         *     - Sum of component `palletCount` must equal order `totalPalletCount`
+         *     - Sum of component `poundsWeight` must equal order `totalPoundsWeight`
+         */
+        put: operations["confirmShipmentByOrderNumber"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/shipper/shipment/{orderNumber}/cancel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Cancel a shipment by order number
+         * @description Cancels an existing shipment using its order number (PRO number). Shipments can only be cancelled when they are in a cancellable state (e.g., before pickup).
+         */
+        put: operations["cancelShipmentByOrderNumber"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/shipper/shipment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create a new shipment
+         * @description Creates a new shipment order. Optionally reference a previously generated quote. The shipment must be confirmed after creation.
+         *
+         *     **Note:** The `companyId` is automatically extracted from your API key.
+         *     You do not need to provide this value in the request body.
+         *
+         *     For M2M (machine-to-machine) integrations, no user context is required.
+         */
+        post: operations["createShipment"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/shipper/quote": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Request a shipping quote
+         * @description Generates a price quote for a shipment based on origin, destination, and cargo details. The quote is valid for 2 days.
+         *
+         *     **Note:** The `companyId` is automatically extracted from your API key.
+         *     You do not need to provide this value in the request body.
+         *
+         *     For M2M (machine-to-machine) integrations, no user context is required.
+         */
+        post: operations["requestQuote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/shipper/shipment/{orderNumber}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a shipment by order number
+         * @description Retrieves a shipment by its order number (PRO number). The order number is a 5-character alphanumeric code (e.g., ZKYQ5) that uniquely identifies the shipment.
+         */
+        get: operations["getShipmentByOrderNumber"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/shipper/shipment/{orderNumber}/tracking": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Track a shipment by order number
+         * @description Retrieves tracking information for a shipment by its order number (PRO number). Returns status and estimated/actual pickup and delivery dates.
+         */
+        get: operations["trackShipmentByOrderNumber"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/shipper/shipment/{orderNumber}/invoice": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get itemized invoice for a delivered shipment
+         * @description Retrieves the itemized invoice for a delivered shipment.
+         *     The invoice includes all charges (base freight, accessorials) and line items.
+         *
+         *     **Note:** This endpoint is only available for shipments in DELIVERED state.
+         *     Invoices are finalized when a shipment is delivered.
+         */
+        get: operations["getInvoice"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/shipper/shipment/{orderNumber}/document/{documentType}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a shipment document by order number
+         * @description Retrieves a download link for a shipment document using the order number (PRO number). Supported document types: BILL_OF_LADING, INVOICE, SHIPPING_LABEL.
+         */
+        get: operations["getDocumentByOrderNumber"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/shipper/quote/{quoteId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a quote by ID
+         * @description Retrieves an existing quote by its unique identifier. Quotes are valid for 2 days from creation.
+         */
+        get: operations["getQuote"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+interface components {
+    schemas: {
+        /** @description Shipment/Order details */
+        Shipment: {
+            /**
+             * @description Unique identifier for the order
+             * @example 67b6c5fcfbf1be6b24127646
+             */
+            id?: string;
+            /**
+             * @description Company ID that owns this order
+             * @example 67c0dfa95bff090747660465
+             */
+            companyId?: string;
+            /**
+             * @description User ID who created this order
+             * @example 679410f5b074882a64b9ea7f
+             */
+            userId?: string;
+            /**
+             * @description Human-readable PRO number for the shipment (5-character alphanumeric)
+             * @example ZKYQ5
+             */
+            orderNumber?: string;
+            /**
+             * @description Current status of the order
+             * @example CONFIRMED
+             * @enum {string}
+             */
+            orderStatus?: "INITIALIZED" | "CONFIRMED" | "ACCEPTED" | "ASSIGNED" | "PICKED_UP" | "IN_TRANSIT" | "DELIVERED" | "CANCELLED";
+            /**
+             * Format: int32
+             * @description Total price of the order in cents (USD)
+             * @example 125000
+             */
+            totalPriceInCents?: number;
+            /**
+             * Format: date-time
+             * @description Time when the order was created (ISO 8601 format)
+             * @example 2025-02-20T17:31:10.43Z
+             */
+            createdAt?: string;
+            /**
+             * Format: date-time
+             * @description Time when the order was last updated (ISO 8601 format)
+             * @example 2025-02-27T22:51:49.865Z
+             */
+            updatedAt?: string;
+        };
+        /** @description Address information for pickup or delivery locations */
+        Address: {
+            /**
+             * @description Name of the location or business
+             * @example Fairgrounds Distribution Center
+             */
+            name: string;
+            /**
+             * @description Primary street address
+             * @example 1531 Junipero Avenue
+             */
+            address1: string;
+            /**
+             * @description Secondary address line (suite, unit, etc.)
+             * @example Dock 5
+             */
+            address2?: string;
+            /**
+             * @description City name
+             * @example Long Beach
+             */
+            city: string;
+            /**
+             * @description Two-letter state abbreviation
+             * @example CA
+             */
+            state: string;
+            /**
+             * @description 5-digit ZIP code
+             * @example 90804
+             */
+            zipCode: string;
+            /**
+             * @description Contact phone number in E.164 format
+             * @example +18087857650
+             */
+            phoneNumber: string;
+            /**
+             * @description Name of the contact person at this location
+             * @example Mike Johnson
+             */
+            contactPerson: string;
+            /**
+             * @description Opening time for the location in 24-hour format (HH:mm). Defaults to 10:00 if not provided.
+             * @example 10:00
+             */
+            openTime?: string;
+            /**
+             * @description Closing time for the location in 24-hour format (HH:mm). Defaults to 16:00 if not provided.
+             * @example 16:00
+             */
+            closeTime?: string;
+            /**
+             * @description Additional notes or instructions for the driver
+             * @example Dock 3, enter from back of building
+             */
+            notes?: string;
+            /**
+             * @description Whether a liftgate is required at this location
+             * @example false
+             */
+            liftgateRequired?: boolean;
+            /**
+             * @description Whether this is a limited access location (residential, construction site, etc.)
+             * @example false
+             */
+            limitedAccess?: boolean;
+            /**
+             * @description Whether an appointment is required for pickup/delivery
+             * @example true
+             */
+            appointmentRequired?: boolean;
+        };
+        /** @description Request to create a new shipment */
+        CreateShipmentRequest: {
+            /**
+             * @description Optional ID of a previously generated quote. If provided, the shipment must match the quote parameters.
+             * @example 507f1f77bcf86cd799439013
+             */
+            quoteId?: string;
+            pickupAddress: components["schemas"]["Address"];
+            deliveryAddress: components["schemas"]["Address"];
+            /** @description List of cargo components in the shipment */
+            orderComponents: components["schemas"]["OrderComponent"][];
+            /**
+             * @description Description of the shipment contents
+             * @example Electronics - fragile
+             */
+            description: string;
+            /**
+             * @description Purchase order number for reference
+             * @example PO-2024-12345
+             */
+            poNumber?: string;
+            /**
+             * @description Additional reference number
+             * @example REF-ABC-123
+             */
+            refNumber?: string;
+            /**
+             * Format: date-time
+             * @description Required pickup date (ISO 8601 format)
+             * @example 2024-12-24T08:00:00Z
+             */
+            requiredPickupDate?: string;
+            /**
+             * Format: date-time
+             * @description Required delivery by date (ISO 8601 format)
+             * @example 2024-12-26T17:00:00Z
+             */
+            requiredDeliveryBy?: string;
+        };
+        /**
+         * @description Individual cargo component in a shipment.
+         *
+         *     **Validation Rules:**
+         *     - Total weight across all components must equal order totalPoundsWeight
+         *     - Total pallet count across all components must equal order totalPalletCount
+         *     - Weight must be between 1 and 2,500 lbs per pallet
+         *     - Dimensions must be within limits (see palletDimensions field)
+         */
+        OrderComponent: {
+            /**
+             * Format: int32
+             * @description Number of pallets for this component
+             * @example 2
+             */
+            palletCount: number;
+            /**
+             * Format: double
+             * @description Total weight for this component in pounds. Must be between 1 and 2,500 lbs per pallet (e.g., 2 pallets = max 5,000 lbs).
+             * @example 1000
+             */
+            poundsWeight: number;
+            /**
+             * @description Pallet dimensions in inches as [length, width, height].
+             *
+             *     **Dimension Limits:**
+             *     - Standard shipments: max 95×95×94 inches
+             *     - With liftgate accessorial: max 62×62×94 inches
+             *     - Oversize rule: Both length AND width cannot exceed 60 inches
+             *     - Minimum: 1×1×1 inches
+             * @example [
+             *       48,
+             *       40,
+             *       48
+             *     ]
+             */
+            palletDimensions: number[];
+        };
+        /** @description Request to generate a shipping quote. Quotes are valid for 2 days from creation. */
+        QuoteRequest: {
+            pickupAddress: components["schemas"]["Address"];
+            deliveryAddress: components["schemas"]["Address"];
+            /** @description List of pallets or freight pieces. Quote will be based on total pallet count and weight. */
+            orderComponents: components["schemas"]["OrderComponent"][];
+        };
+        /** @description Response containing quote details */
+        QuoteResponse: {
+            /**
+             * @description Unique identifier for the quote
+             * @example 507f1f77bcf86cd799439011
+             */
+            id?: string;
+            /**
+             * Format: int32
+             * @description Total quoted price in cents (USD)
+             * @example 125000
+             */
+            quotedPriceInCents?: number;
+            /**
+             * Format: date-time
+             * @description Time when the quote expires (ISO 8601 format). Quotes are valid for 2 days.
+             * @example 2024-12-25T00:00:00Z
+             */
+            quoteExpirationTime?: string;
+        };
+        /** @description Shipment tracking information */
+        Tracking: {
+            /**
+             * @description Unique identifier for the order
+             * @example 507f1f77bcf86cd799439011
+             */
+            id?: string;
+            /**
+             * @description Human-readable PRO number for the shipment (5-character alphanumeric)
+             * @example ZKYQ5
+             */
+            orderNumber?: string;
+            /**
+             * @description Current status of the order
+             * @example PICKED_UP
+             * @enum {string}
+             */
+            orderStatus?: "INITIALIZED" | "CONFIRMED" | "ACCEPTED" | "ASSIGNED" | "PICKED_UP" | "IN_TRANSIT" | "DELIVERED" | "CANCELLED";
+            /**
+             * Format: date-time
+             * @description Actual pickup date/time (ISO 8601 format)
+             * @example 2024-12-23T10:30:00Z
+             */
+            actualPickupDate?: string;
+            /**
+             * Format: date-time
+             * @description Actual delivery date/time (ISO 8601 format)
+             * @example 2024-12-25T14:00:00Z
+             */
+            actualDeliveryDate?: string;
+            /**
+             * Format: date-time
+             * @description Estimated pickup date/time (ISO 8601 format)
+             * @example 2024-12-23T09:00:00Z
+             */
+            estimatedPickupDate?: string;
+            /**
+             * Format: date-time
+             * @description Estimated delivery date/time (ISO 8601 format)
+             * @example 2024-12-25T12:00:00Z
+             */
+            estimatedDeliveryDate?: string;
+        };
+        /** @description An individual charge/fee on the invoice */
+        InvoiceCharge: {
+            /**
+             * @description Type of charge (e.g., BASE_FREIGHT, LIFTGATE_PICKUP, LIFTGATE_DELIVERY)
+             * @example LIFTGATE_PICKUP
+             */
+            chargeType?: string;
+            /**
+             * @description Human-readable description of the charge
+             * @example Liftgate Pickup
+             */
+            description?: string;
+            /**
+             * Format: int32
+             * @description Charge amount in cents (USD)
+             * @example 7500
+             */
+            amountInCents?: number;
+        };
+        /** @description A line item on the invoice representing shipped goods */
+        InvoiceLineItem: {
+            /**
+             * @description Description of the goods
+             * @example General Freight
+             */
+            description?: string;
+            /**
+             * @description Freight class (NMFC)
+             * @example 70
+             */
+            freightClass?: string;
+            /**
+             * Format: int32
+             * @description Weight in pounds
+             * @example 1500
+             */
+            weight?: number;
+            /**
+             * Format: int32
+             * @description Number of pieces/pallets
+             * @example 4
+             */
+            quantity?: number;
+            /**
+             * @description Type of packaging (e.g., PLT for pallet, CTN for carton)
+             * @example PLT
+             */
+            packageType?: string;
+        };
+        /** @description Itemized invoice for a delivered shipment */
+        InvoiceResponse: {
+            /**
+             * @description Unique identifier for the order
+             * @example 507f1f77bcf86cd799439011
+             */
+            orderId?: string;
+            /**
+             * @description Order number (PRO number)
+             * @example ZKYQ5
+             */
+            orderNumber?: string;
+            /**
+             * Format: date-time
+             * @description Invoice date (when the shipment was delivered)
+             * @example 2024-12-20T15:30:00Z
+             */
+            invoiceDate?: string;
+            /**
+             * Format: date-time
+             * @description Ship date (when the shipment was picked up)
+             * @example 2024-12-18T09:00:00Z
+             */
+            shipDate?: string;
+            /**
+             * Format: date-time
+             * @description Delivery date (when the shipment was delivered)
+             * @example 2024-12-20T15:30:00Z
+             */
+            deliveryDate?: string;
+            /**
+             * @description Purchase order number (if provided)
+             * @example PO-12345
+             */
+            poNumber?: string;
+            /**
+             * @description Reference number (BOL number)
+             * @example BOL-67890
+             */
+            refNumber?: string;
+            /** @description Line items representing the shipped goods */
+            lineItems?: components["schemas"]["InvoiceLineItem"][];
+            /** @description Itemized charges and fees */
+            charges?: components["schemas"]["InvoiceCharge"][];
+            /**
+             * Format: int32
+             * @description Total of all charges in cents (USD)
+             * @example 125000
+             */
+            totalChargesInCents?: number;
+            /**
+             * Format: int32
+             * @description Total weight of the shipment in pounds
+             * @example 1500
+             */
+            totalWeight?: number;
+            /**
+             * Format: int32
+             * @description Total number of pieces/pallets
+             * @example 4
+             */
+            totalPieces?: number;
+            shipper?: components["schemas"]["Address"];
+            consignee?: components["schemas"]["Address"];
+            billTo?: components["schemas"]["Address"];
+        };
+        /** @description Response containing document download information */
+        DocumentResponse: {
+            /**
+             * @description Name of the document file
+             * @example BOL-12345.pdf
+             */
+            filename?: string;
+            /**
+             * @description MIME type of the document
+             * @example application/pdf
+             */
+            fileType?: string;
+            /**
+             * @description Pre-signed URL to download the document. Link expires after a short time.
+             * @example https://s3.amazonaws.com/bucket/file?...
+             */
+            downloadLink?: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+interface operations {
+    confirmShipmentByOrderNumber: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description Order number (5-character alphanumeric code, commonly called PRO number)
+                 * @example ZKYQ5
+                 */
+                orderNumber: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Shipment confirmed successfully. Verify the response contains `orderStatus: CONFIRMED` to ensure confirmation succeeded. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Invalid request: orderNumber is required, order is not in INITIALIZED state, or is missing a quote */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Unauthorized: missing or invalid Bearer token (authentication failed) */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Forbidden: missing/invalid API key, or shipment does not belong to your company */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Shipment not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+        };
+    };
+    cancelShipmentByOrderNumber: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description Order number (5-character alphanumeric code, commonly called PRO number)
+                 * @example ZKYQ5
+                 */
+                orderNumber: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Shipment cancelled successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Invalid request: orderNumber is required, or order cannot be cancelled in its current state */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Unauthorized: missing or invalid Bearer token (authentication failed) */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Forbidden: missing/invalid API key, or shipment does not belong to your company */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Shipment not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+        };
+    };
+    createShipment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateShipmentRequest"];
+            };
+        };
+        responses: {
+            /** @description Shipment created successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Invalid request: validation error, quote mismatch, or expired quote */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Unauthorized: missing or invalid Bearer token (authentication failed) */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Forbidden: missing/invalid API key, user not in company, or quote not owned by company */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+        };
+    };
+    requestQuote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["QuoteRequest"];
+            };
+        };
+        responses: {
+            /** @description Quote generated successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["QuoteResponse"];
+                };
+            };
+            /** @description Invalid request: validation error */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["QuoteResponse"];
+                };
+            };
+            /** @description Unauthorized: missing or invalid Bearer token (authentication failed) */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["QuoteResponse"];
+                };
+            };
+            /** @description Forbidden: missing/invalid API key, or user does not belong to the authorized company */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["QuoteResponse"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["QuoteResponse"];
+                };
+            };
+        };
+    };
+    getShipmentByOrderNumber: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description Order number (5-character alphanumeric code, commonly called PRO number)
+                 * @example ZKYQ5
+                 */
+                orderNumber: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Shipment retrieved successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Invalid request: orderNumber is required */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Unauthorized: missing or invalid Bearer token (authentication failed) */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Forbidden: missing/invalid API key, or shipment does not belong to your company */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+            /** @description Shipment not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Shipment"];
+                };
+            };
+        };
+    };
+    trackShipmentByOrderNumber: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description Order number (5-character alphanumeric code, commonly called PRO number)
+                 * @example ZKYQ5
+                 */
+                orderNumber: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Tracking information retrieved successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Tracking"];
+                };
+            };
+            /** @description Invalid request: orderNumber is required */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Tracking"];
+                };
+            };
+            /** @description Unauthorized: missing or invalid Bearer token (authentication failed) */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Tracking"];
+                };
+            };
+            /** @description Forbidden: missing/invalid API key, or shipment does not belong to your company */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Tracking"];
+                };
+            };
+            /** @description Shipment not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["Tracking"];
+                };
+            };
+        };
+    };
+    getInvoice: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description Order number (5-character alphanumeric code, commonly called PRO number)
+                 * @example ZKYQ5
+                 */
+                orderNumber: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Invoice retrieved successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["InvoiceResponse"];
+                };
+            };
+            /** @description Invalid request: orderNumber is required, or shipment is not in DELIVERED state */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["InvoiceResponse"];
+                };
+            };
+            /** @description Unauthorized: missing or invalid Bearer token (authentication failed) */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["InvoiceResponse"];
+                };
+            };
+            /** @description Forbidden: missing/invalid API key, or shipment does not belong to your company */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["InvoiceResponse"];
+                };
+            };
+            /** @description Shipment not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["InvoiceResponse"];
+                };
+            };
+        };
+    };
+    getDocumentByOrderNumber: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description Order number (5-character alphanumeric code, commonly called PRO number)
+                 * @example ZKYQ5
+                 */
+                orderNumber: string;
+                /** @description Type of document to retrieve */
+                documentType: "BILL_OF_LADING" | "INVOICE" | "SHIPPING_LABEL";
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Document URL retrieved successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["DocumentResponse"];
+                };
+            };
+            /** @description Invalid request: orderNumber and documentType are required */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["DocumentResponse"];
+                };
+            };
+            /** @description Unauthorized: missing or invalid Bearer token (authentication failed) */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["DocumentResponse"];
+                };
+            };
+            /** @description Forbidden: missing/invalid API key, or shipment does not belong to your company */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["DocumentResponse"];
+                };
+            };
+            /** @description Shipment or document not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["DocumentResponse"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["DocumentResponse"];
+                };
+            };
+        };
+    };
+    getQuote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Unique quote ID */
+                quoteId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Quote retrieved successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["QuoteResponse"];
+                };
+            };
+            /** @description Invalid request: quote ID format is invalid */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["QuoteResponse"];
+                };
+            };
+            /** @description Unauthorized: missing or invalid Bearer token (authentication failed) */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["QuoteResponse"];
+                };
+            };
+            /** @description Forbidden: missing, invalid, or expired API key (authorization failed) */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["QuoteResponse"];
+                };
+            };
+            /** @description Quote not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/hal+json": components["schemas"]["QuoteResponse"];
+                };
+            };
+        };
+    };
+}
+
+/**
+ * Clean type aliases for the Oway SDK
+ */
+
+type QuoteRequest = paths['/v1/shipper/quote']['post']['requestBody']['content']['application/json'];
+type ShipmentRequest = paths['/v1/shipper/shipment']['post']['requestBody']['content']['application/json'];
+type Quote = paths['/v1/shipper/quote']['post']['responses']['200']['content']['application/hal+json'];
+type Shipment = paths['/v1/shipper/shipment']['post']['responses']['200']['content']['application/hal+json'];
+type Tracking = paths['/v1/shipper/shipment/{orderNumber}/tracking']['get']['responses']['200']['content']['application/hal+json'];
+type Invoice = paths['/v1/shipper/shipment/{orderNumber}/invoice']['get']['responses']['200']['content']['application/hal+json'];
+type Address = components['schemas']['Address'];
+
+declare class Quotes {
+    private client;
+    constructor(client: HttpClient);
+    /**
+     * Request a shipping quote
+     * @param params Quote parameters
+     * @param companyApiKey Optional: Specify company API key for multi-tenant integrations
+     */
+    create(params: QuoteRequest, companyApiKey?: string): Promise<Quote>;
+    /**
+     * Retrieve a quote by ID
+     * @param quoteId Quote ID
+     * @param companyApiKey Optional: Specify company API key for multi-tenant integrations
+     */
+    retrieve(quoteId: string, companyApiKey?: string): Promise<Quote>;
+}
+
+declare class Shipments {
+    private client;
+    constructor(client: HttpClient);
+    create(params: ShipmentRequest, companyApiKey?: string): Promise<Shipment>;
+    retrieve(orderNumber: string, companyApiKey?: string): Promise<Shipment>;
+    confirm(orderNumber: string, companyApiKey?: string): Promise<Shipment>;
+    cancel(orderNumber: string, companyApiKey?: string): Promise<void>;
+    tracking(orderNumber: string, companyApiKey?: string): Promise<Tracking>;
+    document(orderNumber: string, documentType: 'BOL' | 'INVOICE' | 'LABEL', companyApiKey?: string): Promise<{
+        url: string;
+    }>;
+    invoice(orderNumber: string, companyApiKey?: string): Promise<Invoice>;
+}
+
+/**
+ * Oway API environment URLs
+ * Use these constants instead of hardcoding URLs
+ */
+declare const OwayEnvironments: {
+    /**
+     * Sandbox environment for development and testing
+     * Safe to use - no real shipments created
+     */
+    readonly SANDBOX: "https://rest-api.sandbox.oway.io";
+    /**
+     * Production environment for live traffic
+     * Real shipments will be created and billed
+     */
+    readonly PRODUCTION: "https://rest-api.oway.io";
+};
+
+/**
+ * Official Oway SDK for JavaScript/TypeScript
+ */
+declare class Oway {
+    private client;
+    readonly quotes: Quotes;
+    readonly shipments: Shipments;
+    constructor(config: OwayConfig);
+}
+
+export { type Address, type Invoice, Oway, type OwayConfig, OwayEnvironments, OwayError, type Quote, type QuoteRequest, type Shipment, type ShipmentRequest, type Tracking, type components, Oway as default, type paths };