@teralabs/shipstack 1.2.0

package/dist/index.d.ts

@@ -0,0 +1,2741 @@
+/**
+ * Individual Carrier Configurations
+ */
+interface UspsConfig {
+    /** If false, the aggregator will skip USPS during multi-carrier lookups */
+    enabled: boolean;
+    /** Consumer Key from USPS Developer Portal (v3) */
+    clientId: string;
+    /** Consumer Secret from USPS Developer Portal (v3) */
+    clientSecret: string;
+    /** Optional API Key for legacy headers or specific v3 requirements */
+    apiKey?: string;
+    baseUrl?: string;
+    /** The OAuth2 endpoint (e.g., https://apis.usps.com/oauth2/v3) */
+    authUrl?: string;
+    /** Specific override for the Labels v3 endpoint */
+    labelsBaseUrl?: string;
+}
+interface FedexConfig {
+    enabled: boolean;
+    clientId: string;
+    clientSecret: string;
+    accountNumber: string;
+    baseUrl?: string;
+}
+interface UpsConfig {
+    enabled: boolean;
+    clientId: string;
+    clientSecret: string;
+    /**
+     * The 6-character UPS Account Number.
+     * Maps to 'ShipperNumber' in the UPS Shipping API.
+     */
+    accountNumber: string;
+    baseUrl?: string;
+}
+/**
+ * Root configuration for the Shipstack library.
+ */
+interface ShippingConfig {
+    usps?: UspsConfig;
+    fedex?: FedexConfig;
+    ups?: UpsConfig;
+    /** Toggle between sandbox (TEM) and production environments. Defaults to 'sandbox'. */
+    environment?: "sandbox" | "production";
+}
+/**
+ * Initializes the Shipstack library with user-provided credentials.
+ * This should be called once at the start of the application lifecycle.
+ */
+declare function setShipstackConfig(config: ShippingConfig): void;
+/**
+ * Aggregator: Retrieves a list of carrier keys that are explicitly enabled.
+ * @returns Array of strings: ["usps", "fedex", "ups"]
+ */
+declare function getEnabledCarriers(): string[];
+/**
+ * Internal helper to retrieve USPS specific configs.
+ * @throws Error if USPS is not configured.
+ */
+declare function getUspsConfig(): UspsConfig;
+/**
+ * Internal helper to retrieve FedEx specific configs.
+ */
+declare function getFedexConfig(): FedexConfig;
+/**
+ * Internal helper to retrieve UPS specific configs.
+ */
+declare function getUpsConfig(): UpsConfig;
+/**
+ * Helper to check the current environment for URL resolution.
+ */
+declare function getEnvironment(): "sandbox" | "production";
+
+/**
+ * Generic request structure for retrieving shipping rates from specific carriers.
+ * * This type acts as a bridge between the ShipStack core and carrier-specific
+ * logic, housing both universal logistics data (weight/dims) and specific
+ * flags like USPS 'nonStandard' or FedEx 'pickupType'.
+ */
+type RateRequest$1 = {
+    /** The carrier to query (e.g., 'usps' triggers the Domestic Prices v3 API). */
+    carrier: "fedex" | "usps" | "ups";
+    /** 5-digit origin postal code. */
+    originZip: string;
+    /** 5-digit destination postal code. */
+    destZip: string;
+    /** Package weight in Ounces (converted to Pounds internally for USPS). */
+    weightOz: number;
+    /** Physical length in inches. */
+    lengthInches: number;
+    /** Physical width in inches. */
+    widthInches: number;
+    /** Physical height in inches. */
+    heightInches: number;
+    /** * Destination Country Code (ISO-3166-1 alpha-2).
+     * Essential for International Rates to determine zone and service availability.
+     * Defaults to 'US' in most builder implementations.
+     */
+    destCountryCode?: string;
+    /** Indicates irregular/non-machinable characteristics. */
+    nonStandard?: boolean;
+    /** The date the package is intended to be mailed. */
+    mailingDate?: string;
+    /** Specific mail class filter (e.g., 'PRIORITY_MAIL'). */
+    mailClass?: string;
+    /** USPS payment account category. */
+    accountType?: "EPS" | "PERMIT" | "METER";
+    /** The unique USPS account string. */
+    accountNumber?: string;
+    /** FedEx-specific packaging (e.g., 'FEDEX_ENVELOPE'). */
+    packagingType?: string;
+    /** Instructions for package collection. */
+    pickupType?: string;
+    /** Instructions for package drop-off. */
+    dropoffType?: string;
+    /** Requested rate calculation types (e.g., ['LIST', 'ACCOUNT']). */
+    rateRequestType?: string[];
+    /** Optional correlation ID for FedEx logs. */
+    transactionId?: string;
+    /** BCP-47 language tag (e.g., 'en-US'). */
+    locale?: string;
+};
+/**
+ * Normalized shipping rate returned to the consuming application.
+ * * This object removes carrier-specific nesting, providing a flat structure
+ * optimized for UI components like checkout tables or shipping calculators.
+ */
+type NormalizedRate = {
+    /** The carrier that provided this specific rate. */
+    carrier: "usps" | "fedex" | "ups";
+    /** The machine-readable service identifier (e.g., 'USPS_GROUND_ADVANTAGE'). */
+    serviceCode: string;
+    /** The customer-facing service name (e.g., 'Ground Advantage'). */
+    serviceName: string;
+    /** Estimated business days for transit. */
+    deliveryDays?: number;
+    /** ISO-8601 formatted date for predicted arrival. */
+    estimatedArrival?: string;
+    /** Flag for the fastest available option in a multi-rate response. */
+    isFastest?: boolean;
+    /** Flag for the lowest-cost option in a multi-rate response. */
+    isCheapest?: boolean;
+    /** Indicates if the delivery time is carrier-guaranteed. */
+    guaranteed?: boolean;
+    /** * Financial breakdown of the rate.
+     */
+    cost: {
+        /** Total price including base postage and requested extra services. */
+        amount: number;
+        /** Three-letter currency code (e.g., 'USD'). */
+        currency: string;
+    };
+    /** * The original, unformatted response from the carrier.
+     * Useful for auditing or accessing vendor-specific metadata.
+     */
+    raw?: unknown;
+};
+
+/**
+ * Request structure for validating and normalizing physical addresses.
+ *
+ * This type is used across all carrier adapters to ensure the address
+ * conforms to postal standards before attempting to generate rates or labels.
+ *
+ * @category Address
+ */
+type AddressValidationRequest = {
+    /** The specific carrier API to use for validation. */
+    carrier: "usps" | "fedex" | "ups";
+    /** The address details to be verified. */
+    address: {
+        /** Array of street lines; most carriers support up to 2 lines for domestic. */
+        streetLines: string[];
+        /** Full city name. */
+        city: string;
+        /** 2-character state or province code (e.g., 'NY', 'CA'). */
+        stateOrProvinceCode: string;
+        /** 5 or 9-digit postal code. */
+        postalCode: string;
+        /** ISO-3166-1 alpha-2 country code (e.g., 'US', 'CA'). */
+        countryCode: string;
+    };
+};
+/**
+ * Classification of an address location type.
+ *
+ * Used primarily for rate calculation, as residential deliveries
+ * often incur surcharges from carriers like FedEx and UPS.
+ */
+type AddressClassification = "RESIDENTIAL" | "COMMERCIAL" | "UNKNOWN";
+/**
+ * Standardized Address format for the Shipstack library.
+ *
+ * This interface is shared across all carrier converters (USPS, FedEx, UPS)
+ * to ensure the end-user receives a consistent object structure regardless
+ * of the underlying carrier API used.
+ *
+ * @category Address
+ */
+interface NormalizedAddress {
+    /** Primary delivery address line (e.g., '123 Main St'). */
+    street1: string;
+    /** Secondary address line (e.g., 'Apt 4B'). */
+    street2?: string;
+    /** Full city name. */
+    city: string;
+    /** 2-character state or province code. */
+    state: string;
+    /** Postal code in format: 12345 or 12345-6789. */
+    postalCode: string;
+    /** ISO-3166-1 alpha-2 country code. */
+    country: string;
+    /**
+     * Delivery Point Validation (DPV):
+     * Confirms if the address is a deliverable location recognized by the carrier.
+     */
+    isValid: boolean;
+    /** Indicates if the location type is residential or commercial. */
+    classification?: AddressClassification;
+    /** Indicates if the address is a PO Box, which may restrict certain services. */
+    isPoBox: boolean;
+    /**
+     * The original raw response from the carrier SDK.
+     * Useful for debugging or accessing carrier-specific metadata.
+     */
+    raw?: any;
+}
+/**
+ * The final output of the Address Aggregator.
+ *
+ * This structure explicitly separates the validation status from the
+ * suggested (corrected) address data.
+ *
+ * @category Address
+ */
+interface AddressValidationResult {
+    /** Global indicator of whether the input address was resolved successfully. */
+    isValid: boolean;
+    /** The standardized version of the address returned by the carrier. */
+    normalizedAddress?: NormalizedAddress;
+    /** Any warnings or footnotes returned (e.g., 'Missing Apartment Number'). */
+    messages?: string[];
+    /** The raw payload from the carrier for auditing. */
+    raw?: any;
+}
+
+/**
+ * Generic request structure for generating a shipping label.
+ * * This type serves as the input for all carrier-specific label builders.
+ * It consolidates sender, recipient, and package dimensions into a
+ * single, carrier-agnostic payload.
+ */
+type ShipmentRequest = {
+    /** The carrier to be used for the shipment (e.g., 'usps', 'fedex'). */
+    carrier: "usps" | "fedex" | "ups";
+    /** * The carrier-specific service identifier.
+     * Matches the 'serviceCode' returned by the Rates API.
+     */
+    serviceCode: string;
+    /** * Origin address details.
+     */
+    fromAddress: {
+        /** Full name of the sender. */
+        name: string;
+        /** Optional business name. */
+        company?: string;
+        /** Array of street address lines (e.g., ['123 Main St', 'Suite 400']). */
+        streetLines: string[];
+        /** City name. */
+        city: string;
+        /** 2-character state or province code. */
+        stateOrProvinceCode: string;
+        /** 5 or 9-digit postal code. */
+        postalCode: string;
+        /** ISO-3166-1 alpha-2 country code. */
+        countryCode: string;
+    };
+    /** * Destination address details.
+     */
+    toAddress: {
+        /** Full name of the recipient. */
+        name: string;
+        /** Optional business name. */
+        company?: string;
+        /** Array of street address lines. */
+        streetLines: string[];
+        /** City name. */
+        city: string;
+        /** 2-character state or province code. */
+        stateOrProvinceCode: string;
+        /** 5 or 9-digit postal code. */
+        postalCode: string;
+        /** ISO-3166-1 alpha-2 country code. */
+        countryCode: string;
+    };
+    /** * Physical characteristics and contents of the package.
+     */
+    package: {
+        /** Weight in Ounces. */
+        weightOz: number;
+        /** Length in inches. */
+        lengthInches: number;
+        /** Width in inches. */
+        widthInches: number;
+        /** Height in inches. */
+        heightInches: number;
+        /** Optional description of package contents for internal reference or labels. */
+        description?: string;
+    };
+};
+/**
+ * Normalized response representing a successfully created shipment and label.
+ * * This structure extracts the most critical data from complex carrier
+ * responses (like the USPS Labels v3 JSON) to provide a simple object for
+ * frontend rendering or database storage.
+ */
+type NormalizedShipment = {
+    /** The carrier that generated the shipment. */
+    carrier: "usps" | "fedex" | "ups";
+    /** The primary tracking number assigned to the package. */
+    trackingNumber: string;
+    /** The carrier-specific service identifier used. */
+    serviceCode: string;
+    /** Human-readable service name (e.g., 'USPS Ground Advantage'). */
+    serviceName: string;
+    /** * Label image metadata and data.
+     */
+    label: {
+        /** The file format of the generated label image. */
+        format: "PDF" | "PNG" | "ZPL" | "GIF";
+        /** The actual label data encoded as a Base64 string. */
+        base64: string;
+    };
+    /** * Financial details associated with the created label.
+     */
+    charges?: {
+        /** The final amount charged/quoted for the label. */
+        amount: number;
+        /** Three-letter currency code (e.g., 'USD'). */
+        currency: string;
+    };
+    /** * The original raw response from the carrier API.
+     * Useful for auditing or retrieving advanced metadata (e.g., routing codes).
+     */
+    raw?: unknown;
+};
+/**
+ * A staged shipment represents the intermediate payload structure used
+ * internally by the aggregator before it is transformed into a carrier-specific request. This allows for a clean separation between the public API's agnostic request format and the internal logic that builds the specific payloads required by each carrier's API.
+ */
+type StagedShipment = {
+    /** The carrier this payload is intended for. */
+    carrier: "usps" | "fedex" | "ups";
+    /** The service code selected (e.g., from a rate). */
+    serviceCode: string;
+    /** Carrier-specific request payload (USPS/FedEx/UPS label/ship request). */
+    payload: unknown;
+};
+
+/**
+ * Represents a single point-in-time update in the journey of a package.
+ * * This type normalizes diverse carrier event structures (e.g., USPS 'statusDetails'
+ * vs FedEx 'scanEvents') into a standard chronological log.
+ */
+type NormalizedTrackingEvent = {
+    /** A human-readable description of the event (e.g., 'Arrived at Post Office'). */
+    description: string;
+    /** ISO-8601 formatted date and time of the event occurrence. */
+    dateTime: string;
+    /** The city where the scan occurred. */
+    city?: string;
+    /** 2-character state or province code (e.g., 'TX'). */
+    stateOrProvinceCode?: string;
+    /** The postal code of the scanning facility. */
+    postalCode?: string;
+    /** ISO-3166-1 alpha-2 country code. */
+    countryCode?: string;
+};
+/**
+ * Normalized tracking state for a specific package.
+ * * This structure provides a unified view of a shipment's progress across
+ * different carriers, making it ideal for tracking dashboards or automated
+ * status notifications.
+ */
+type NormalizedTracking = {
+    /** The carrier currently handling the shipment. */
+    carrier: "usps" | "fedex" | "ups";
+    /** The unique identifier for the package. */
+    trackingNumber: string;
+    /** The current high-level status (e.g., 'DELIVERED', 'IN_TRANSIT'). */
+    status: string;
+    /** * Predicted date and time of arrival.
+     * Formatted as an ISO-8601 string.
+     */
+    estimatedDelivery?: string;
+    /** * A chronological list of all scan events associated with this tracking number.
+     * Typically ordered from newest to oldest.
+     */
+    events: NormalizedTrackingEvent[];
+    /** * The original raw response from the carrier (e.g., USPS Tracking v3 JSON).
+     * Useful for accessing carrier-specific internal codes or raw XML/JSON.
+     */
+    raw?: unknown;
+};
+
+/**
+ * Shipstack Error System
+ * Standardized error classes for multi-carrier shipping operations.
+ */
+/**
+ * Base error class for all Shipstack-related exceptions.
+ * * This class extends the native Error to include carrier context and the
+ * original 'cause' (e.g., a raw Axios or Fetch error), which is essential
+ * for debugging upstream carrier API failures.
+ * * @category Errors
+ */
+declare class ShipstackError extends Error {
+    carrier: "usps" | "fedex" | "ups";
+    cause?: unknown | undefined;
+    /**
+     * @param message - Human-readable error description.
+     * @param carrier - The carrier associated with the failure ('usps' | 'fedex' | 'ups').
+     * @param cause - The underlying error or raw API response responsible for the failure.
+     */
+    constructor(message: string, carrier: "usps" | "fedex" | "ups", cause?: unknown | undefined);
+}
+/**
+ * Specialized error for API Rate Limiting (HTTP 429).
+ * * Carriers like FedEx and USPS enforce strict concurrent request limits.
+ * This error includes a 'retryAfter' hint per 2026 RFC standards to help
+ * implementers manage automated backoff logic.
+ * * @category Errors
+ */
+declare class ThrottlingError extends ShipstackError {
+    retryAfter?: number | undefined;
+    /**
+     * @param message - Description of the rate limit hit.
+     * @param carrier - The carrier that throttled the request.
+     * @param retryAfter - The number of seconds to wait before retrying (if provided by carrier).
+     * @param cause - The original 429 response.
+     */
+    constructor(message: string, carrier: "usps" | "fedex" | "ups", retryAfter?: number | undefined, cause?: unknown);
+}
+/**
+ * Type Guard to check if an unknown error is a ShipstackError.
+ * @param error - The error to check.
+ */
+declare function isShipstackError(error: unknown): error is ShipstackError;
+/**
+ * Type Guard to check if an error is specifically a ThrottlingError.
+ * @param error - The error to check.
+ */
+declare function isThrottlingError(error: unknown): error is ThrottlingError;
+
+/**
+ * International Customs Declaration details.
+ * These are used during the Label generation (Shipment) phase.
+ */
+type CustomsDeclaration = {
+    /** Type of contents (e.g., 'GIFT', 'MERCHANDISE') */
+    contentsType: string;
+    /** Detailed description of the items */
+    description: string;
+    /** Total declared value */
+    value: number;
+    /** HS Tariff Code for classification */
+    hsTariffCode?: string;
+    /** Country of origin (ISO-3166-1 alpha-2) */
+    countryOfOrigin: string;
+};
+
+/**
+ * Shipstack Global Rates Aggregator
+ * * Orchestrates multi-carrier rate lookups using carrier-specific builders,
+ * authenticated clients, and standardized response converters.
+ */
+
+/**
+ * The core getRates function.
+ * * This service acts as the central router for the Shipstack library.
+ * It ensures that carrier-specific credentials are provided, payloads
+ * are correctly transformed, and responses are normalized.
+ * * @param {RateRequest} req - The agnostic rating request from the user.
+ * @param {ShippingConfig} config - The library configuration object containing credentials.
+ * @returns {Promise<NormalizedRate[]>} An array of standardized rates across available services.
+ * @throws {ShipstackError} If carrier-specific configuration is missing or the carrier is unsupported.
+ * @public
+ */
+declare function getRates$1(req: RateRequest$1, config: ShippingConfig): Promise<NormalizedRate[]>;
+
+/**
+ * Shipstack Address API
+ * * Provides a unified interface for physical address validation and normalization
+ * across USPS, FedEx, and UPS. This module handles carrier-specific client
+ * initialization and parameter mapping.
+ */
+
+/**
+ * Validates and standardizes a physical address using the specified carrier.
+ * * This method orchestrates the full validation lifecycle:
+ * 1. Verifies carrier-specific credentials in the provided configuration.
+ * 2. Maps the agnostic Shipstack address format to the carrier's required schema.
+ * 3. Executes the remote validation call.
+ * 4. Returns a standardized result including the normalization status.
+ * * @param {AddressValidationRequest} req - The universal address request payload.
+ * @param {ShippingConfig} config - The library configuration containing carrier credentials.
+ * @returns {Promise<AddressValidationResult>} The validation status and normalized address data.
+ * @throws {ShipstackError} If configuration is missing or the carrier API rejects the request.
+ * @public
+ */
+declare function validateAddress$1(req: AddressValidationRequest, config: ShippingConfig): Promise<AddressValidationResult>;
+
+/**
+ * Shipstack Tracking API
+ * * The public-facing interface for tracking operations.
+ * * This module serves as the primary entry point for tracking shipments.
+ * It orchestrates the underlying TrackingAggregator to handle carrier-specific
+ * batch limits, concurrency, and response normalization.
+ * * @module API/Tracking
+ */
+
+/**
+ * Retrieves standardized tracking information for one or more packages.
+ * * This is a high-level method designed for ease of use in UIs and backend
+ * workflows. It automatically handles the transition from single strings
+ * to arrays and initializes the necessary aggregator logic.
+ * * @param {string | string[]} trackingNumbers - A single string or array of tracking IDs.
+ * @param {"usps" | "fedex" | "ups"} carrier - The carrier service to query.
+ * @param {ShippingConfig} config - The library configuration containing credentials.
+ * @returns {Promise<NormalizedTracking[]>} An array of normalized tracking objects.
+ * @throws {ShipstackError} If the carrier is unsupported or the request fails.
+ * @public
+ */
+declare function trackShipment$1(trackingNumbers: string | string[], carrier: "usps" | "fedex" | "ups", config: ShippingConfig): Promise<NormalizedTracking[]>;
+
+/**
+ * Shipstack High-Level Shipping API
+ * Standardized convenience methods for common logistics workflows.
+ */
+
+/**
+ * Builds a staged shipment payload for the specified carrier.
+ * * This function validates the carrier configuration and delegates
+ * the payload construction to the aggregator layer.
+ * @param req The agnostic shipment request payload.
+ * @param config The global library configuration.
+ * @returns A staged shipment object containing the carrier-specific payload.
+ */
+declare function buildShipment$1(req: ShipmentRequest, config: ShippingConfig): Promise<StagedShipment>;
+/**
+ * WARNING:
+ * This method actually purchases a shipping label from the carrier.
+ * It should only be used in secure backend environments.
+ * For platform-agnostic workflows, use `buildShipment()` instead.
+ */
+/**
+ * Creates a shipping label and returns a normalized shipment object.
+ * * This is the primary entry point for generating labels across all carriers.
+ * * @param {ShipmentRequest} req - The agnostic shipment request payload.
+ * @param {ShippingConfig} config - The global library configuration.
+ * @returns {Promise<NormalizedShipment>} The generated label and tracking info.
+ * @throws {ShipstackError} If configuration is missing or carrier API fails.
+ * @category Core API
+ * @public
+ */
+declare function createShipment$1(req: ShipmentRequest, config: ShippingConfig): Promise<NormalizedShipment>;
+/**
+ * Retrieves the single lowest-cost shipping option across all configured carriers.
+ */
+declare function getBestValueRate$1(req: RateRequest$1, config: ShippingConfig): Promise<NormalizedRate | null>;
+/**
+ * Identifies the shipping option with the shortest estimated transit time.
+ */
+declare function getFastestService$1(req: RateRequest$1, config: ShippingConfig): Promise<NormalizedRate | null>;
+/**
+ * Heuristic utility to predict a carrier based on standard tracking number patterns.
+ */
+declare function predictCarrier$1(trackingNumber: string): "usps" | "fedex" | "ups" | "unknown";
+
+/**
+ * Transforms an agnostic Shipstack RateRequest into a FedEx-specific rating payload.
+ *
+ * FedEx requires the account number within the request body to unlock negotiated rates.
+ * Dimensions are rounded up (Math.ceil) to comply with carrier billing rules.
+ *
+ * @param req - The internal Shipstack RateRequest.
+ * @param accountNumber - The FedEx account number for the rating context.
+ * @returns {any} A formatted payload matching the FedEx 'body' model.
+ */
+declare function buildFedexRateRequest(req: RateRequest$1, accountNumber: string): any;
+
+/**
+ * The destination ZIP code for the package.
+ */
+type destinationZIPCode = string;
+
+/**
+ * This is the package height in inches.
+ */
+type height = number;
+
+/**
+ * This is the package length in inches.  The maximum dimension is always length.
+ */
+type length = number;
+
+/**
+ * The mail service requested.
+ *
+ * Note:
+ * - A single mail class option is deprecated and will be removed in the next major revision.  This attribute will be replaced with the array of mail classes.
+ * - `PARCEL_SELECT_LIGHTWEIGHT` is deprecated and will convert to `PARCEL_SELECT`
+ * - `FIRST-CLASS_PACKAGE_SERVICE` is deprecated and will convert to `USPS_GROUND_ADVANTAGE`
+ * - `USPS_RETAIL_GROUND` is no longer supported and will return a 400 if used
+ * @deprecated
+ */
+declare enum mailClassOutboundOnly {
+    PARCEL_SELECT = "PARCEL_SELECT",
+    PARCEL_SELECT_LIGHTWEIGHT = "PARCEL_SELECT_LIGHTWEIGHT",
+    PRIORITY_MAIL_EXPRESS = "PRIORITY_MAIL_EXPRESS",
+    PRIORITY_MAIL = "PRIORITY_MAIL",
+    FIRST_CLASS_PACKAGE_SERVICE = "FIRST-CLASS_PACKAGE_SERVICE",
+    LIBRARY_MAIL = "LIBRARY_MAIL",
+    MEDIA_MAIL = "MEDIA_MAIL",
+    BOUND_PRINTED_MATTER = "BOUND_PRINTED_MATTER",
+    USPS_CONNECT_LOCAL = "USPS_CONNECT_LOCAL",
+    USPS_CONNECT_MAIL = "USPS_CONNECT_MAIL",
+    USPS_CONNECT_REGIONAL = "USPS_CONNECT_REGIONAL",
+    USPS_GROUND_ADVANTAGE = "USPS_GROUND_ADVANTAGE",
+    USPS_RETAIL_GROUND = "USPS_RETAIL_GROUND",
+    ALL = "ALL"
+}
+
+/**
+ * An Array of mail classes
+ *
+ * Note:
+ * - `PARCEL_SELECT_LIGHTWEIGHT` is deprecated and will convert to `PARCEL_SELECT`
+ * - `FIRST-CLASS_PACKAGE_SERVICE` is deprecated and will convert to `USPS_GROUND_ADVANTAGE`
+ * - `USPS_RETAIL_GROUND` is no longer supported and will return a 400 if used
+ *
+ */
+type mailClassesOutboundOnly = Array<mailClassOutboundOnly>;
+
+/**
+ * The date the package or letter/flat/card will be mailed. The mailing date may be today plus 0 to 7 days in advance.
+ */
+type mailingDate = string;
+
+/**
+ * The originating ZIP code for the package.
+ */
+type originZIPCode = string;
+
+/**
+ * Price type can be  * 'RETAIL' * 'COMMERCIAL' * 'CONTRACT' * 'NSA' (deprecated)
+ */
+declare enum priceType {
+    RETAIL = "RETAIL",
+    COMMERCIAL = "COMMERCIAL",
+    CONTRACT = "CONTRACT",
+    NSA = "NSA"
+}
+
+/**
+ * This is the calculated weight for the package based on user input.  The greater of dimWeight and weight will be used to calculated the rate. Weight unit of measurement is in pounds.
+ */
+type weightPounds = number;
+
+/**
+ * This is the package width in inches.  The second longest dimension is always width.
+ */
+type width = number;
+
+/**
+ * Informative details about all possible prices based on the ingredients.
+ */
+type RateListQuery = {
+    originZIPCode: originZIPCode;
+    destinationZIPCode: destinationZIPCode;
+    weight: weightPounds;
+    length: length;
+    width: width;
+    height: height;
+    mailClass?: mailClassOutboundOnly;
+    mailClasses?: mailClassesOutboundOnly;
+    priceType?: priceType;
+    mailingDate?: mailingDate;
+    /**
+     * The type of payment account linked to a contract rate.
+     */
+    accountType?: RateListQuery.accountType;
+    /**
+     * The Enterprise Payment Account, Permit number or PC Postage meter number associated with a contract.
+     */
+    accountNumber?: string;
+    /**
+     * Package is nonstandard. Nonstandard packages include cylindrical tubes and rolls, certain high-density items, cartons containing more than 24 ounces of liquids in one or more glass containers, cartons containing 1 gallon or more of liquid in metal or plastic containers, and items in [201.7.6.2](https://pe.usps.com/text/dmm300/201.htm#7.6.2).
+     */
+    hasNonstandardCharacteristics?: boolean;
+};
+declare namespace RateListQuery {
+    /**
+     * The type of payment account linked to a contract rate.
+     */
+    enum accountType {
+        EPS = "EPS",
+        PERMIT = "PERMIT",
+        METER = "METER"
+    }
+}
+
+/**
+ * Extra Service Code requested.
+ * * 415 - USPS Label Delivery Service
+ * * 480 - Tracking Plus 6 Months
+ * * 481 - Tracking Plus 1 Year
+ * * 482 - Tracking Plus 3 Years
+ * * 483 - Tracking Plus 5 Years
+ * * 484 - Tracking Plus 7 Years
+ * * 485 - Tracking Plus 10 Years
+ * * 486 - Tracking Plus Signature 3 Years
+ * * 487 - Tracking Plus Signature 5 Years
+ * * 488 - Tracking Plus Signature 7 Years
+ * * 489 - Tracking Plus Signature 10 Years
+ * * 498 - PO Box Locker – Stocking Fee (NSA Only)
+ * * 500 - PO Box Locker – Self-Service Pickup Fee (NSA Only)
+ * * 501 - PO Box Locker – Clerk-Assisted Pickup Fee (NSA Only)
+ * * 502 - PO Box Locker – Local Delivery Fee (NSA Only)
+ * * 810 - Hazardous Materials - Air Eligible Ethanol
+ * * 811 - Hazardous Materials - Class 1 – Toy Propellant/Safety Fuse Package
+ * * 812 - Hazardous Materials - Class 3 - Flammable and Combustible Liquids
+ * * 813 - Hazardous Materials - Class 7 – Radioactive Materials
+ * * 814 - Hazardous Materials - Class 8 – Air Eligible Corrosive Materials
+ * * 815 - Hazardous Materials - Class 8 – Nonspillable Wet Batteries
+ * * 816 - Hazardous Materials - Class 9 - Lithium Battery Marked Ground Only
+ * * 817 - Hazardous Materials - Class 9 - Lithium Battery Returns
+ * * 818 - Hazardous Materials - Class 9 - Marked Lithium Batteries
+ * * 819 - Hazardous Materials - Class 9 – Dry Ice
+ * * 820 - Hazardous Materials - Class 9 – Unmarked Lithium Batteries
+ * * 821 - Hazardous Materials - Class 9 – Magnetized Materials
+ * * 822 - Hazardous Materials - Division 4.1 – Mailable Flammable Solids and Safety Matches
+ * * 823 - Hazardous Materials - Division 5.1 – Oxidizers
+ * * 824 - Hazardous Materials - Division 5.2 – Organic Peroxides
+ * * 825 - Hazardous Materials - Division 6.1 – Toxic Materials
+ * * 826 - Hazardous Materials - Division 6.2 Biological Materials
+ * * 827 - Hazardous Materials - Excepted Quantity Provision
+ * * 828 - Hazardous Materials - Ground Only Hazardous Materials
+ * * 829 - Hazardous Materials - Air Eligible ID8000 Consumer Commodity
+ * * 830 - Hazardous Materials - Lighters
+ * * 831 - Hazardous Materials - Limited Quantity Ground
+ * * 832 - Hazardous Materials - Small Quantity Provision (Markings Required)
+ * * 853 - Special Handling - Perishable Material
+ * * 856 - Live Animal Transportation Fee
+ * * 857 - Hazardous Materials
+ * * 858 - Cremated Remains
+ * * 910 - Certified Mail
+ * * 911 - Certified Mail Restricted Delivery
+ * * 912 - Certified Mail Adult Signature Required
+ * * 913 - Certified Mail Adult Signature Restricted Delivery
+ * * 915 - Collect on Delivery
+ * * 917 - Collect on Delivery Restricted Delivery
+ * * 920 - USPS Tracking Electronic
+ * * 921 - Signature Confirmation
+ * * 922 - Adult Signature Required
+ * * 923 - Adult Signature Restricted Delivery
+ * * 924 - Signature Confirmation Restricted Delivery
+ * * 925 - Priority Mail Express Merchandise Insurance
+ * * 930 - Insurance <= $500
+ * * 931 - Insurance > $500
+ * * 934 - Insurance Restricted Delivery
+ * * 940 - Registered Mail
+ * * 941 - Registered Mail Restricted Delivery
+ * * 955 - Return Receipt
+ * * 957 - Return Receipt Electronic
+ * * 972 - Live Animal and Perishable Handling Fee
+ * * 981 - Signature Requested (PRIORITY_MAIL_EXPRESS only)
+ * * 984 - Parcel Locker Delivery
+ * * 986 - PO to Addressee (PRIORITY_MAIL_EXPRESS only)
+ * * 991 - Sunday Delivery
+ *
+ * <b>Note:</b> Entering a single extra service will be removed in the next major revision.
+ *
+ */
+declare enum ExtraService {
+    '_415' = 415,
+    '_480' = 480,
+    '_481' = 481,
+    '_482' = 482,
+    '_483' = 483,
+    '_484' = 484,
+    '_485' = 485,
+    '_486' = 486,
+    '_487' = 487,
+    '_488' = 488,
+    '_489' = 489,
+    '_498' = 498,
+    '_500' = 500,
+    '_501' = 501,
+    '_502' = 502,
+    '_810' = 810,
+    '_811' = 811,
+    '_812' = 812,
+    '_813' = 813,
+    '_814' = 814,
+    '_815' = 815,
+    '_816' = 816,
+    '_817' = 817,
+    '_818' = 818,
+    '_819' = 819,
+    '_820' = 820,
+    '_821' = 821,
+    '_822' = 822,
+    '_823' = 823,
+    '_824' = 824,
+    '_825' = 825,
+    '_826' = 826,
+    '_827' = 827,
+    '_828' = 828,
+    '_829' = 829,
+    '_830' = 830,
+    '_831' = 831,
+    '_832' = 832,
+    '_853' = 853,
+    '_856' = 856,
+    '_857' = 857,
+    '_858' = 858,
+    '_910' = 910,
+    '_911' = 911,
+    '_912' = 912,
+    '_913' = 913,
+    '_915' = 915,
+    '_917' = 917,
+    '_920' = 920,
+    '_921' = 921,
+    '_922' = 922,
+    '_923' = 923,
+    '_924' = 924,
+    '_925' = 925,
+    '_930' = 930,
+    '_931' = 931,
+    '_934' = 934,
+    '_940' = 940,
+    '_941' = 941,
+    '_955' = 955,
+    '_957' = 957,
+    '_972' = 972,
+    '_981' = 981,
+    '_984' = 984,
+    '_986' = 986,
+    '_991' = 991
+}
+
+/**
+ * Extra Service Codes requested. If omitted, all available extra services will be returned. To narrow the results, provide a specific set of extra service codes. For convenience, use `986` for `PRIORITY_MAIL_EXPRESS` or `920` for all other `mailClasses`.
+ * * 415 - USPS Label Delivery Service
+ * * 480 - Tracking Plus 6 Months
+ * * 481 - Tracking Plus 1 Year
+ * * 482 - Tracking Plus 3 Years
+ * * 483 - Tracking Plus 5 Years
+ * * 484 - Tracking Plus 7 Years
+ * * 485 - Tracking Plus 10 Years
+ * * 486 - Tracking Plus Signature 3 Years
+ * * 487 - Tracking Plus Signature 5 Years
+ * * 488 - Tracking Plus Signature 7 Years
+ * * 489 - Tracking Plus Signature 10 Years
+ * * 498 - PO Box Locker – Stocking Fee (NSA Only)
+ * * 500 - PO Box Locker – Self-Service Pickup Fee (NSA Only)
+ * * 501 - PO Box Locker – Clerk-Assisted Pickup Fee (NSA Only)
+ * * 502 - PO Box Locker – Local Delivery Fee (NSA Only)
+ * * 810 - Hazardous Materials - Air Eligible Ethanol
+ * * 811 - Hazardous Materials - Class 1 – Toy Propellant/Safety Fuse Package
+ * * 812 - Hazardous Materials - Class 3 - Flammable and Combustible Liquids
+ * * 813 - Hazardous Materials - Class 7 – Radioactive Materials
+ * * 814 - Hazardous Materials - Class 8 – Air Eligible Corrosive Materials
+ * * 815 - Hazardous Materials - Class 8 – Nonspillable Wet Batteries
+ * * 816 - Hazardous Materials - Class 9 - Lithium Battery Marked Ground Only
+ * * 817 - Hazardous Materials - Class 9 - Lithium Battery Returns
+ * * 818 - Hazardous Materials - Class 9 - Marked Lithium Batteries
+ * * 819 - Hazardous Materials - Class 9 – Dry Ice
+ * * 820 - Hazardous Materials - Class 9 – Unmarked Lithium Batteries
+ * * 821 - Hazardous Materials - Class 9 – Magnetized Materials
+ * * 822 - Hazardous Materials - Division 4.1 – Mailable Flammable Solids and Safety Matches
+ * * 823 - Hazardous Materials - Division 5.1 – Oxidizers
+ * * 824 - Hazardous Materials - Division 5.2 – Organic Peroxides
+ * * 825 - Hazardous Materials - Division 6.1 – Toxic Materials
+ * * 826 - Hazardous Materials - Division 6.2 Biological Materials
+ * * 827 - Hazardous Materials - Excepted Quantity Provision
+ * * 828 - Hazardous Materials - Ground Only Hazardous Materials
+ * * 829 - Hazardous Materials - Air Eligible ID8000 Consumer Commodity
+ * * 830 - Hazardous Materials - Lighters
+ * * 831 - Hazardous Materials - Limited Quantity Ground
+ * * 832 - Hazardous Materials - Small Quantity Provision (Markings Required)
+ * * 853 - Special Handling - Perishable Material
+ * * 856 - Live Animal Transportation Fee
+ * * 857 - Hazardous Materials
+ * * 858 - Cremated Remains
+ * * 910 - Certified Mail
+ * * 911 - Certified Mail Restricted Delivery
+ * * 912 - Certified Mail Adult Signature Required
+ * * 913 - Certified Mail Adult Signature Restricted Delivery
+ * * 915 - Collect on Delivery
+ * * 917 - Collect on Delivery Restricted Delivery
+ * * 920 - USPS Tracking Electronic
+ * * 921 - Signature Confirmation
+ * * 922 - Adult Signature Required
+ * * 923 - Adult Signature Restricted Delivery
+ * * 924 - Signature Confirmation Restricted Delivery
+ * * 925 - Priority Mail Express Merchandise Insurance
+ * * 930 - Insurance <= $500
+ * * 931 - Insurance > $500
+ * * 934 - Insurance Restricted Delivery
+ * * 940 - Registered Mail
+ * * 941 - Registered Mail Restricted Delivery
+ * * 955 - Return Receipt
+ * * 957 - Return Receipt Electronic
+ * * 972 - Live Animal and Perishable Handling Fee
+ * * 981 - Signature Requested (PRIORITY_MAIL_EXPRESS only)
+ * * 984 - Parcel Locker Delivery
+ * * 986 - PO to Addressee (PRIORITY_MAIL_EXPRESS only)
+ * * 991 - Sunday Delivery
+ *
+ */
+type TotalRatesExtraServices = Array<ExtraService>;
+
+/**
+ * Search parameters for base rate and extra service rate.
+ */
+type TotalRatesQuery = (RateListQuery & {
+    /**
+     * The value of the item. Required for Insurance, Registered Mail, and Collect on Delivery.
+     */
+    itemValue?: number;
+    extraServices?: TotalRatesExtraServices;
+});
+
+/**
+ * Transforms a generic internal RateRequest into a USPS-specific TotalRatesQuery.
+ * This builder handles unit conversions (ounces to pounds) and maps generic
+ * shipping properties to USPS Domestic Prices v10 schema requirements.
+ * * @param req - The normalized internal rate request object.
+ * @returns A TotalRatesQuery object compatible with the USPS v3 generated SDK.
+ */
+declare function buildUspsRateRequest(req: RateRequest$1): TotalRatesQuery;
+
+/**
+ * Customer classification container. Valid if ShipFrom country or territory  is "US"
+ */
+type RateRequest_CustomerClassification = {
+    /**
+     * Customer classification code.  Valid values:00 -  Rates Associated with Shipper Number01 -  Daily Rates04 -  Retail Rates05 - Regional Rates06 - General List Rates53 -  Standard List RatesLength is not validated.If customer classification code is not a valid value please refer to Rate Types Table on page 11.
+     */
+    Code: string;
+    /**
+     * Customer classification description of the code above.  Ignored if provided in the Request. Length is not validated.
+     */
+    Description?: string;
+};
+
+/**
+ * Pickup Type container tag.
+ */
+type RateRequest_PickupType = {
+    /**
+     * Pickup Type Code.  Valid values: 01 - Daily Pickup (Default - used when an invalid pickup type code is provided)03 - Customer Counter06 - One Time Pickup19 - Letter Center20 - Air Service CenterLength is not validated. When negotiated rates are requested, 07 (onCallAir) will be ignored.Refer to the Rate Types Table in the Appendix for rate type based on Pickup Type and Customer Classification Code.
+     */
+    Code: string;
+    /**
+     * Pickup Type Description.  Ignored if provided in the Request.
+     */
+    Description?: string;
+};
+
+/**
+ * TransactionReference identifies transactions between client and server.
+ */
+type Request_TransactionReference = {
+    /**
+     * May be used to synchronize request/response pairs. Information in the request element is echoed back in the response.
+     */
+    CustomerContext?: string;
+};
+
+/**
+ * Request container.  N/A
+ */
+type RateRequest_Request = {
+    /**
+     * Indicates Rate API to display the new release features in Rate API response based on Rate release. See the What's New section for the latest Rate release. Supported values: 1601, 1607, 1701, 1707, 2108, 2205,2407,2409
+     */
+    SubVersion?: string;
+    TransactionReference?: Request_TransactionReference;
+};
+
+/**
+ * Address container for Alternate Delivery Address.
+ */
+type AlternateDeliveryAddress_Address = {
+    /**
+     * The UPS Access Point's street address, including name and number (when applicable).  Length is not validated.
+     */
+    AddressLine?: Array<string>;
+    /**
+     * UPS Access Point city.
+     */
+    City?: string;
+    /**
+     * UPS Access Point State or Province code.
+     */
+    StateProvinceCode?: string;
+    /**
+     * UPS Access Point Postal code.
+     */
+    PostalCode?: string;
+    /**
+     * UPS Access Point country or territory code.
+     */
+    CountryCode: string;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored.This field is a flag to indicate if the Alternate Delivery location is a residential location. True if ResidentialAddressIndicator tag exists.  For future use.
+     */
+    ResidentialAddressIndicator?: string;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored.
+     *
+     * This field is a flag to indicate if the Alternate Delivery location is a PO box location.
+     *
+     * True if POBoxIndicator tag exists; false otherwise.  Not valid with Shipment Indication Types:
+     * - 01 - Hold for Pickup at UPS Access Point
+     * - 02 - UPS Access Point™ Delivery
+     *
+     */
+    POBoxIndicator?: string;
+};
+
+/**
+ * Alternate Delivery Address container. Applies for deliveries to UPS Access Point™ locations.
+ *
+ * Required for the following ShipmentIndicationType values:
+ * - 01 - Hold for Pickup at UPS Access Point™
+ * - 02 - UPS Access Point™ Delivery
+ *
+ */
+type Shipment_AlternateDeliveryAddress = {
+    /**
+     * UPS Access Point location name.
+     */
+    Name?: string;
+    Address: AlternateDeliveryAddress_Address;
+};
+
+/**
+ * Pickup container.
+ */
+type DeliveryTimeInformation_Pickup = {
+    /**
+     * Shipment Date; The Pickup date is a Shipment Date and it is a required input field.  The user is allowed to query up to 35 days into the past and 60 days into the future. Format: YYYYMMDD  If a date is not provided, it will be defaulted to the current system date.
+     */
+    Date: string;
+    /**
+     * Reflects the time the package is tendered to UPS for shipping (can be dropped off at UPS or picked up by UPS).  Military Time Format HHMMSS or HHMM.   Invalid pickup time will not be validated.
+     */
+    Time?: string;
+};
+
+/**
+ * Return contract services container
+ */
+type DeliveryTimeInformation_ReturnContractServices = {
+    /**
+     * Return contract Service code. Valid Code "01" - Heavy Goods. If 01 will return Heavy Goods service transit times for a given origin and destination (if applicable)  Invalid Code will be ignore.
+     */
+    Code: string;
+    /**
+     * Return contract service Description
+     */
+    Description?: string;
+};
+
+/**
+ * Container for requesting Time In Transit Information. Required to view time in transit information.  Required to view any time in transit information.
+ */
+type Shipment_DeliveryTimeInformation = {
+    /**
+     * Valid values are:
+     * - 02 - Document only
+     * - 03 - Non-Document
+     * - 04 - WWEF Pallet
+     * - 07 - Domestic Pallet
+     *
+     * If 04 is included, Worldwide Express Freight and UPS Worldwide Express Freight Midday services (if applicable) will be included in the response.
+     *
+     */
+    PackageBillType: string;
+    Pickup?: DeliveryTimeInformation_Pickup;
+    ReturnContractServices?: Array<DeliveryTimeInformation_ReturnContractServices>;
+};
+
+/**
+ * Unit of Measurement container for the Adjusted height.
+ */
+type AdjustedHeight_UnitOfMeasurement = {
+    /**
+     * Code associated with Unit of Measurement for the Adjusted height. Valid value is IN  Unit of measurement code for Adjusted height is validated only when Handling unit type is SKD = Skid or PLT = Pallet.
+     */
+    Code: string;
+    /**
+     * Description for Code associated with Unit of Measurement for the Adjusted height.
+     */
+    Description: string;
+};
+
+/**
+ * Container to hold Adjusted Height information.  Required if AdjustedHeightIndicator is present.
+ */
+type FreightDensityInfo_AdjustedHeight = {
+    /**
+     * Adjusted Height value for the handling unit.
+     */
+    Value: string;
+    UnitOfMeasurement: AdjustedHeight_UnitOfMeasurement;
+};
+
+/**
+ * UnitOfMeasurement container.
+ */
+type HandlingUnits_UnitOfMeasurement = {
+    /**
+     * Code for UnitOfMeasurement for the line item dimension. Valid value - IN = Inches
+     */
+    Code: string;
+    /**
+     * Description for UnitOfMeasurement for the line item dimension.
+     */
+    Description: string;
+};
+
+/**
+ * Dimension of the HandlingUnit container for density based pricing.
+ */
+type HandlingUnits_Dimensions = {
+    UnitOfMeasurement: HandlingUnits_UnitOfMeasurement;
+    /**
+     * The length of the line item used to determine dimensional weight.
+     */
+    Length: string;
+    /**
+     * The width of the line item used to determine dimensional weight.
+     */
+    Width: string;
+    /**
+     * The height of the line item used to determine dimensional weight.
+     */
+    Height: string;
+};
+
+/**
+ * Handling Unit Type for Density based rating.
+ */
+type HandlingUnits_Type = {
+    /**
+     * The code associated with Handling Unit Type.  Valid values: SKD = Skid CBY = CarboyPLT = PalletTOT = TotesLOO = LooseOTH = Other
+     */
+    Code: string;
+    /**
+     * A description of the code for the Handling Unit type.
+     */
+    Description?: string;
+};
+
+/**
+ * Handling Unit for Density based rating container.
+ */
+type FreightDensityInfo_HandlingUnits = {
+    /**
+     * Handling Unit Quantity for Density based rating.
+     */
+    Quantity: string;
+    Type: HandlingUnits_Type;
+    Dimensions: HandlingUnits_Dimensions;
+};
+
+/**
+ * Freight Density Info container.  Required if DensityEligibleIndicator is present.
+ */
+type FreightShipmentInformation_FreightDensityInfo = {
+    /**
+     * The presence of the AdjustedHeightIndicator allows UPS to do height reduction adjustment for density based rate request.
+     */
+    AdjustedHeightIndicator?: string;
+    AdjustedHeight?: FreightDensityInfo_AdjustedHeight;
+    HandlingUnits: Array<FreightDensityInfo_HandlingUnits>;
+};
+
+/**
+ * Container to hold Freight Shipment information.
+ */
+type Shipment_FreightShipmentInformation = {
+    FreightDensityInfo?: FreightShipmentInformation_FreightDensityInfo;
+    /**
+     * The presence of the tag indicates that the  rate request is density based.For Density Based Rating (DBR), the customer must have DBR Contract Service.
+     */
+    DensityEligibleIndicator?: string;
+};
+
+/**
+ * Payer Address Container.  Address container may be present for FRS Payment Information type = 02 and required when the FRS Payment Information type = 03.
+ */
+type FRSPaymentInformation_Address = {
+    /**
+     * Postal Code for UPS accounts billing address.  Postal Code  may be present when the FRS Payment Information type = 02 and type = 03.
+     */
+    PostalCode?: string;
+    /**
+     * Country or Territory code for the  UPS accounts & billing address.  Country or Territory Code is required when the FRS Payment Information type = 02 and type= 03.
+     */
+    CountryCode: string;
+};
+
+/**
+ * GFP Payment Information Type container.  GFP only.
+ */
+type FRSPaymentInformation_Type = {
+    /**
+     * Payer Type code for FRS Rate request. Valid Values are: 01 = Prepaid 02 = FreightCollect 03 = BillThirdParty
+     */
+    Code: string;
+    /**
+     * Text description of the code representing the GFP payment type.
+     */
+    Description?: string;
+};
+
+/**
+ * UPS Ground Freight Pricing (GFP) Payment Information container.  Required only for GFP and when the FRSIndicator is present.
+ */
+type Shipment_FRSPaymentInformation = {
+    Type: FRSPaymentInformation_Type;
+    /**
+     * UPS Account Number.
+     */
+    AccountNumber?: string;
+    Address?: FRSPaymentInformation_Address;
+};
+
+/**
+ * Container to hold InvoiceLineTotal Information.  Required if the shipment is from US/PR Outbound to non US/PR destination with the PackagingType of UPS PAK(04).Required for international shipments when using request option "ratetimeintransit" or "shoptimeintransit".
+ */
+type Shipment_InvoiceLineTotal = {
+    /**
+     * Invoice Line Total Currency type. The Currency code should match the origin country's or territory's currency code, otherwise the currency code entered will be ignored.  Note: UPS doesn't support all international currency codes. Please check the developer guides for Supported Currency codes.
+     */
+    CurrencyCode: string;
+    /**
+     * Total amount of the invoice accompanying the shipment. Required when the InvoiceLineTotal container exists in the rate request.  Valid values are from 1 to 99999999.
+     */
+    MonetaryValue: string;
+};
+
+/**
+ * NMFC Commodity container.  For GFP Only.
+ */
+type Commodity_NMFC = {
+    /**
+     * Value of NMFC Prime. Contact your service representative if you need information concerning NMFC Codes.  Required if NMFC Container is present. For GFP Only.
+     */
+    PrimeCode: string;
+    /**
+     * Value of NMFC Sub. Contact your service representative if you need information concerning NMFC Codes.  Needs to be provided when the SubCode associated with the PrimeCode is other than 00. API defaults the sub value to 00 if not provided. If provided the Sub Code should be associated with the PrimeCode of the NMFC.
+     */
+    SubCode?: string;
+};
+
+/**
+ * Commodity Container.  Required only for GFP rating when FRSShipmentIndicator is requested.
+ */
+type Package_Commodity = {
+    /**
+     * Freight Classification. Freight class partially determines the freight rate for the article.  See Appendix of the Rating Ground Freight Web Services Developers Guide for list of Freight classes. For GFP Only.
+     */
+    FreightClass: string;
+    NMFC?: Commodity_NMFC;
+};
+
+/**
+ * UnitOfMeasurement container.
+ */
+type Dimensions_UnitOfMeasurement = {
+    /**
+     * Package dimensions unit of measurement code.
+     *
+     * Valid values:
+     * - IN
+     * - CM
+     *
+     */
+    Code: string;
+    /**
+     * Text description of the code representing the UnitOfMeasurement associated with the package.  This element is not validated.
+     */
+    Description: string;
+};
+
+/**
+ * Dimensions Container. This container is not applicable for GFP Rating request.  Required for Heavy Goods service. Package Dimension will be ignored for Simple Rate
+ */
+type Package_Dimensions = {
+    UnitOfMeasurement: Dimensions_UnitOfMeasurement;
+    /**
+     * Length of the package used to determine dimensional weight.  Required for GB to GB and Poland to Poland shipments.
+     *
+     * 6 digits in length with 2 digits of significance after the decimal point.
+     *
+     */
+    Length: string;
+    /**
+     * Width of the package used to determine dimensional weight.  Required for GB to GB and Poland to Poland shipments.
+     *
+     * 6 digits in length with 2 digits of significance after the decimal point.
+     *
+     */
+    Width: string;
+    /**
+     * Height of the package used to determine dimensional weight.  Required for GB to GB and Poland to Poland shipments.
+     *
+     * 6 digits in length with 2 digits of significance after the decimal point.
+     *
+     */
+    Height: string;
+};
+
+/**
+ * UnitOfMeasurement Container.
+ */
+type DimWeight_UnitOfMeasurement = {
+    /**
+     * Code representing the unit of measure associated with the package weight.
+     *
+     * Valid values:
+     * - LBS - Pounds
+     * - KGS - Kilograms.
+     *
+     */
+    Code: string;
+    /**
+     * Text description of the code representing the unit of measure associated with the package weight.  Length and value are not validated.
+     */
+    Description: string;
+};
+
+/**
+ * Package Dimensional Weight container. Values in this container are ignored when package dimensions are provided. Please visit ups.com for instructions on calculating this value.  Only used for non-US/CA/PR shipments.
+ */
+type Package_DimWeight = {
+    UnitOfMeasurement?: DimWeight_UnitOfMeasurement;
+    /**
+     * Dimensional weight of the package. Decimal values are not accepted, however there is one implied decimal place for values in this field (i.e. 115 = 11.5).
+     */
+    Weight?: string;
+};
+
+/**
+ * Access Point COD indicates Package COD is requested for a shipment.  Valid only for : 01 - Hold For Pickup At UPS Access Point, Shipment Indication type. Package Access Point COD is valid only for shipment without return service from US/PR to US/PR and CA to CA. Not valid with (Package) COD.
+ */
+type PackageServiceOptions_AccessPointCOD = {
+    /**
+     * Access Point COD Currency Code.  Required if Access Point COD container is present. UPS does not support all international currency codes. Refer to the appendix for a list of valid codes.
+     */
+    CurrencyCode: string;
+    /**
+     * Access Point COD Monetary Value.  Required if Access Point COD container is present.
+     *
+     * 8 digits prior to the decimal place and 2 after.
+     *
+     */
+    MonetaryValue: string;
+};
+
+/**
+ * CODAmount Container.
+ */
+type COD_CODAmount = {
+    /**
+     * Currency Code.  Required if a value for the COD amount exists in the MonetaryValue tag. Must match one of the IATA currency codes. UPS does not support all international currency codes. Refer to Currency Codes in the Appendix for a list of valid codes.
+     */
+    CurrencyCode: string;
+    /**
+     * The COD value for the package.  Required if COD option is present. The maximum amount allowed is 50,000 USD.
+     */
+    MonetaryValue: string;
+};
+
+/**
+ * COD Container. Indicates COD is requested.   Valid for the following country or territory combinations: US/PR to US/PRCA to CACA to USNot allowed for CA to US for packages that are designated as Letters or Envelopes.
+ */
+type PackageServiceOptions_COD = {
+    /**
+     * Indicates the type of funds that will be used for the C.O.D. payment.  For valid values, refer to Rating and Shipping COD Supported Countries or Territories in the Appendix.
+     */
+    CODFundsCode: string;
+    CODAmount: COD_CODAmount;
+};
+
+/**
+ * Declared Value Container.
+ */
+type PackageServiceOptions_DeclaredValue = {
+    /**
+     * The IATA currency code associated with the declared value amount for the package.  Required if a value for the package declared value amount exists in the MonetaryValue tag. Must match one of the IATA currency codes. Length is not validated. UPS does not support all international currency codes. Refer to Currency Codes in the Appendix for a list of valid codes.
+     */
+    CurrencyCode: string;
+    /**
+     * The monetary value for the declared value amount associated with the package.  Max value of 5,000 USD for Local and 50,000 USD for Remote. Absolute maximum value is 21474836.47
+     */
+    MonetaryValue: string;
+};
+
+/**
+ * Delivery Confirmation Container. For a list of valid origin/destination countries or territories please refer to appendix.  DeliveryConfirmation and COD are mutually exclusive.
+ */
+type PackageServiceOptions_DeliveryConfirmation = {
+    /**
+     * Type of delivery confirmation.  Valid values: 1 - Unsupported 2 - Delivery Confirmation Signature Required 3 - Delivery Confirmation Adult Signature Required
+     */
+    DCISType: string;
+};
+
+/**
+ * Container for Unit Of Measurement for Dry Ice.
+ */
+type DryIceWeight_UnitOfMeasurement = {
+    /**
+     * DryIce weight unit of measurement code. Valid values:
+     * - 00 - KG (Metric Unit of Measurements) or KGS
+     * - 01 - LB (English Unit of Measurements) or LBS
+     *
+     */
+    Code: string;
+    /**
+     * Text description of the code representing the unit of measure associated with the package.
+     */
+    Description: string;
+};
+
+/**
+ * Container for Weight information for Dry Ice.
+ */
+type DryIce_DryIceWeight = {
+    UnitOfMeasurement: DryIceWeight_UnitOfMeasurement;
+    /**
+     * Weight for Dry Ice. Cannot be more than package weight. Should be more than 0.0. Valid characters are 0-9 and "." (Decimal point). Limit to 1 digit after the decimal. The maximum length of the field is 5 including "." and can hold up to 1 decimal place.
+     */
+    Weight: string;
+};
+
+/**
+ * Container to hold Dry Ice information.  Lane check will happen based on postal code/ city.
+ */
+type PackageServiceOptions_DryIce = {
+    /**
+     * Regulation set for DryIce Shipment. Valid values: CFR = For HazMat regulated by US Dept of Transportation within the U.S. or ground shipments to Canada,IATA = For Worldwide Air movement.   The following values are valid: CFR and IATA.
+     */
+    RegulationSet: string;
+    DryIceWeight: DryIce_DryIceWeight;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored. Relevant only in CFR regulation set. If present it is used to designate the Dry Ice is for any medical use and rates are adjusted for DryIce weight more than 2.5 KGS or 5.5 LBS.
+     */
+    MedicalUseIndicator?: string;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored. Indicates a Dry Ice audit will be performed per the Regulation Set requirements. Empty tag means indicator is present.
+     */
+    AuditRequired?: string;
+};
+
+/**
+ * Container to hold HazMat Chemical Records.
+ */
+type HazMat_HazMatChemicalRecord = {
+    /**
+     * Identifies the Chemcial Record.  Required if SubVersion is greater than or equal to 1701.
+     */
+    ChemicalRecordIdentifier?: string;
+    /**
+     * This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'LQ' or 'FR'  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    ClassDivisionNumber?: string;
+    /**
+     * This is the ID number (UN/NA/ID) for the specified commodity. Required if CommodityRegulatedLevelCode = LR, LQ or FR and if the field applies to the material by regulation. UN/NA/ID Identification Number assigned to the specified regulated good. (Include the UN/NA/ID as part of the entry).  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    IDNumber?: string;
+    /**
+     * The method of transport by which a shipment is approved to move and the regulations associated with that method.  Only required when the CommodityRegulatedLevelCode is FR or LQ.Valid values: 01 - Highway02 - Ground03 - Passenger Aircraft04 - Cargo Aircraft Only  Applies only if SubVersion is greater than or equal to 1701. For multiple ChemicalRecords per package having different TransportationMode, TransportationMode of first ChemicalRecord would be considered for validating and rating the package. All TransportationMode except for '04' are general service offering. If any chemical record contains '04' as TransportationMode, ShipperNumber needs to be authorized to use '04' as TransportationMode.
+     */
+    TransportationMode: string;
+    /**
+     * The Regulatory set associated with every regulated shipment. It must be the same across the shipment. Valid values:   ADR -  For Europe to Europe Ground Movement CFR -  For HazMat regulated by US Dept. of Transportation within the U.S. or ground shipments to Canada, IATA -  For Worldwide Air movement TDG -  For Canada to Canada ground movement or Canada to U.S. standard movement  Applies only if SubVersion is greater than or equal to 1701. For multiple ChemicalRecords per package or multiple packages containing different RegulationSet, RegulationSet of first ChemicalRecord would be considered for validating and rating the entire shipment.
+     */
+    RegulationSet: string;
+    /**
+     * 24 Hour Emergency Phone Number of the shipper. Valid values for this field are (0) through (9) with trailing blanks. For numbers within the U.S., the layout is '1', area code, 7-digit number. For all other countries or territories the layout is country or territory code, area code, number.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    EmergencyPhone?: string;
+    /**
+     * The emergency information, contact name and/or contact number, required to be communicated when a call is placed to the EmergencyPhoneNumber. The information is required if there is a value in the EmergencyPhoneNumber field above and the shipment is with a US50 or PR origin and/or destination and the RegulationSet is IATA.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    EmergencyContact?: string;
+    /**
+     * Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. If reportable quantity is met, 'RQ' should be entered.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    ReportableQuantity?: string;
+    /**
+     * Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma).  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    SubRiskClass?: string;
+    /**
+     * This is the packing group category associated to the specified commodity. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Must be shown in Roman Numerals.Valid values are:I, II,III,blank.   Applies only if SubVersion is greater than or equal to 1701.
+     */
+    PackagingGroupType?: string;
+    /**
+     * Required if CommodityRegulatedLevelCode = LQ or FR. The numerical value of the mass capacity of the regulated good.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    Quantity?: string;
+    /**
+     * Required if CommodityRegulatedLevelCode = LQ or FR. The unit of measure used for the mass capacity of the regulated good. For Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    UOM?: string;
+    /**
+     * The packing instructions related to the chemical record. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    PackagingInstructionCode?: string;
+    /**
+     * The Proper Shipping Name assigned by ADR, CFR or IATA. Required if CommodityRegulatedLevelCode = LR, LQ or FR.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    ProperShippingName?: string;
+    /**
+     * The technical name (when required) for the specified commodity. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    TechnicalName?: string;
+    /**
+     * Additional remarks or special provision information. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.
+     *
+     * Additional information that may be required by regulation about a hazardous material, such as, "Limited Quantity", DOT-SP numbers, EX numbers.  Applies only if SubVersion is greater than or equal to 1701.
+     *
+     */
+    AdditionalDescription?: string;
+    /**
+     * The package type code identifying the type of packaging used for the commodity. (Ex: Fiberboard Box). Required if CommodityRegulatedLevelCode = LQ or FR.   Applies only if SubVersion is greater than or equal to 1701.
+     */
+    PackagingType?: string;
+    /**
+     * Defines the type of label that is required on the package for the commodity. Not applicable if CommodityRegulatedLevelCode = LR or EQ.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    HazardLabelRequired?: string;
+    /**
+     * The number of pieces of the specific commodity. Required if CommodityRegulatedLevelCode = LQ or FR.Valid values are 1 to 999.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    PackagingTypeQuantity?: string;
+    /**
+     * Indicates the type of commodity - Fully Regulated (FR), Limited Quantity (LQ), Excepted Quantity (EQ), Lightly Regulated (LR). Default value is FR.Valid values are LR, FR, LQ, EQ.   Applies only if SubVersion is greater than or equal to 1701.
+     */
+    CommodityRegulatedLevelCode?: string;
+    /**
+     * Transport Category.Valid values are 0 to 4.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    TransportCategory?: string;
+    /**
+     * Defines what is restricted to pass through a tunnel.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    TunnelRestrictionCode?: string;
+};
+
+/**
+ * Container to hold HazMat information.  Applies only if SubVersion is greater than or equal to 1701.
+ */
+type PackageServiceOptions_HazMat = {
+    /**
+     * Identifies the package containing Dangerous Goods.  Required if SubVersion is greater than or equal to 1701.
+     */
+    PackageIdentifier?: string;
+    /**
+     * QValue is required when a HazMat shipment specifies AllPackedInOneIndicator and the regulation set for that shipment is IATA.   Applies only if SubVersion is greater than or equal to 1701. Valid values are : 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0
+     */
+    QValue?: string;
+    /**
+     * Presence/Absence Indicator. Any value is ignored. Presence indicates that shipment is overpack.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    OverPackedIndicator?: string;
+    /**
+     * Presence/Absence Indicator. Any value is ignored. Indicates the hazmat shipment/package is all packed in one.  Applies only if SubVersion is greater than or equal to 1701.
+     */
+    AllPackedInOneIndicator?: string;
+    HazMatChemicalRecord: Array<HazMat_HazMatChemicalRecord>;
+};
+
+/**
+ * Container to hold Basic Flexible Parcel Indicator information.  Valid for UPS World Wide Express Freight shipments.
+ */
+type Insurance_BasicFlexibleParcelIndicator = {
+    /**
+     * The IATA currency code associated with the amount for the package.  UPS does not support all international currency codes. Refer to the appendix for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
+     */
+    CurrencyCode: string;
+    /**
+     * The monetary value associated with the package.  Valid for UPS World Wide Express Freight shipments.
+     */
+    MonetaryValue: string;
+};
+
+/**
+ * Container for Extended Flexible Parcel Indicator  Valid for UPS World Wide Express Freight shipments.
+ */
+type Insurance_ExtendedFlexibleParcelIndicator = {
+    /**
+     * The IATA currency code associated with the amount for the package.  UPS does not support all international currency codes. Refer to the appendix for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
+     */
+    CurrencyCode: string;
+    /**
+     * The monetary value associated with the package.  Valid for UPS World Wide Express Freight shipments.
+     */
+    MonetaryValue: string;
+};
+
+/**
+ * Container to hold Time In Transit Flexible Parcel Indicator information.  Valid for UPS World Wide Express Freight shipments.
+ */
+type Insurance_TimeInTransitFlexibleParcelIndicator = {
+    /**
+     * The IATA currency code associated with the amount for the package.  UPS does not support all international currency codes. Refer to the appendix for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
+     */
+    CurrencyCode: string;
+    /**
+     * The monetary value associated with the package.  Valid for UPS World Wide Express Freight shipments.
+     */
+    MonetaryValue: string;
+};
+
+/**
+ * Insurance Accesorial. Only one type of insurance can exist at a time on the shipment. Valid for UPS World Wide Express Freight shipments.
+ */
+type PackageServiceOptions_Insurance = {
+    BasicFlexibleParcelIndicator?: Insurance_BasicFlexibleParcelIndicator;
+    ExtendedFlexibleParcelIndicator?: Insurance_ExtendedFlexibleParcelIndicator;
+    TimeInTransitFlexibleParcelIndicator?: Insurance_TimeInTransitFlexibleParcelIndicator;
+};
+
+/**
+ * Shipper Paid Declared Value Charge at Package level.   Valid for UPS World Wide Express Freight shipments.
+ */
+type PackageServiceOptions_ShipperDeclaredValue = {
+    /**
+     * The IATA currency code associated with the amount for the package.  UPS does not support all international currency codes. Refer to the appendix for a list of valid codes.
+     */
+    CurrencyCode: string;
+    /**
+     * The monetary value for the amount associated with the package.
+     */
+    MonetaryValue: string;
+};
+
+/**
+ * PackageServiceOptions container.
+ */
+type Package_PackageServiceOptions = {
+    DeliveryConfirmation?: PackageServiceOptions_DeliveryConfirmation;
+    AccessPointCOD?: PackageServiceOptions_AccessPointCOD;
+    COD?: PackageServiceOptions_COD;
+    DeclaredValue?: PackageServiceOptions_DeclaredValue;
+    ShipperDeclaredValue?: PackageServiceOptions_ShipperDeclaredValue;
+    /**
+     * The presence indicates that the package may be released by driver without a signature from the consignee.  Empty Tag. Only available for US50/PR to US50/PR packages without return service.
+     */
+    ShipperReleaseIndicator?: string;
+    /**
+     * Any value associated with this element will be ignored. If present, the package is rated for UPS Proactive Response and proactive package tracking.Contractual accessorial for health care companies to allow package monitoring throughout the UPS system.  Shippers account needs to have valid contract for UPS Proactive Response.
+     */
+    ProactiveIndicator?: string;
+    /**
+     * Presence/Absence Indicator. Any value is ignored. If present, indicates that the package contains an item that needs refrigeration.  Shippers account needs to have a valid contract for Refrigeration.
+     */
+    RefrigerationIndicator?: string;
+    Insurance?: PackageServiceOptions_Insurance;
+    /**
+     * The UPSPremiumCareIndicator indicates special handling is required for shipment having controlled substances.  Empty Tag means indicator is present.
+     *
+     * Valid only for Canada to Canada movements.
+     *
+     * Available for the following Return Services:
+     * - Returns Exchange (available with a contract)
+     * - Print Return Label
+     * - Print and Mail
+     * - Electronic Return Label
+     * - Return Service Three Attempt
+     *
+     * May be requested with following UPS services:
+     * - UPS Express® Early
+     * - UPS Express
+     * - UPS Express Saver
+     * - UPS Standard.
+     *
+     * Not available for packages with the following:
+     * - Delivery Confirmation - Signature Required
+     * - Delivery Confirmation - Adult Signature Required.
+     *
+     */
+    UPSPremiumCareIndicator?: string;
+    HazMat?: PackageServiceOptions_HazMat;
+    DryIce?: PackageServiceOptions_DryIce;
+};
+
+/**
+ * UnitOfMeasurement Container.
+ */
+type PackageWeight_UnitOfMeasurement = {
+    /**
+     * Code representing the unit of measure associated with the package weight.
+     *
+     * Unit of Measurement "OZS" is the only valid UOM for Worldwide Economy DDU Shipments.
+     *
+     * Valid values:
+     * - LBS - Pounds (default)
+     * - KGS - Kilograms
+     * - OZS - Ounces
+     *
+     */
+    Code: string;
+    /**
+     * Text description of the code representing the unit of measure associated with the package weight.  Length and value are not validated.
+     */
+    Description: string;
+};
+
+/**
+ * Package Weight Container.  Required for an GFP Rating request. Otherwise optional. Required for Heavy Goods service.  Package Weight will be ignored for Simple Rate
+ */
+type Package_PackageWeight = {
+    UnitOfMeasurement: PackageWeight_UnitOfMeasurement;
+    /**
+     * Actual package weight.  Weight accepted for letters/envelopes.
+     */
+    Weight: string;
+};
+
+/**
+ * Packaging Type Container.
+ */
+type Package_PackagingType = {
+    /**
+     * The code for the UPS packaging type associated with the package.  Valid values:
+     * - 00 - UNKNOWN
+     * - 01 - UPS Letter
+     * - 02 - Package
+     * - 03 - Tube
+     * - 04 - Pak
+     * - 21 - Express Box
+     * - 24 - 25KG Box
+     * - 25 - 10KG Box
+     * - 30 - Pallet
+     * - 2a - Small Express Box
+     * - 2b - Medium Express Box
+     * - 2c - Large Express Box.
+     *
+     * For FRS rating requests the only valid value is customer supplied packaging “02”.
+     *
+     */
+    Code: string;
+    /**
+     * A text description of the code for the UPS packaging type associated with the shipment.  Length is not validated.
+     */
+    Description?: string;
+};
+
+/**
+ * SimpleRate Container
+ */
+type Package_SimpleRate = {
+    /**
+     * Simple Rate Package Size Valid values: XS -  Extra Small S -  Small M -  Medium L - Large XL - Extra Large
+     */
+    Code: string;
+    /**
+     * Simple Rate Package Size Description
+     */
+    Description?: string;
+};
+
+/**
+ * UPS Premier
+ */
+type Package_UPSPremier = {
+    /**
+     * UPS Premier Category  Valid values are 01,02,03 UPS Premier Silver - 01 UPS Premier Gold - 02 UPS Premier Platinum - 03
+     */
+    Category: string;
+};
+
+/**
+ * Package Container.  Only one Package allowed for Simple Rate
+ */
+type Shipment_Package = {
+    PackagingType?: Package_PackagingType;
+    Dimensions?: Package_Dimensions;
+    DimWeight?: Package_DimWeight;
+    PackageWeight?: Package_PackageWeight;
+    Commodity?: Package_Commodity;
+    /**
+     * This element does not require a value and if one is entered it will be ignored.  If present, it indicates the shipment will be categorized as a Large Package.
+     */
+    LargePackageIndicator?: string;
+    PackageServiceOptions?: Package_PackageServiceOptions;
+    /**
+     * A flag indicating if the packages require additional handling. True if AdditionalHandlingIndicator tag exists; false otherwise. Additional Handling indicator indicates it's a non-corrugated package.  Empty Tag.
+     */
+    AdditionalHandlingIndicator?: string;
+    SimpleRate?: Package_SimpleRate;
+    UPSPremier?: Package_UPSPremier;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored. It indicates if packge is oversized.  Applicable for UPS Worldwide Economy DDU service
+     */
+    OversizeIndicator?: string;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored. It indicates if packge is qualified for minimum billable weight.  Applicable for UPS Worldwide Economy DDU service
+     */
+    MinimumBillableWeightIndicator?: string;
+};
+
+/**
+ * Container for additional information for the bill receiver's UPS accounts address.
+ */
+type BillReceiver_Address = {
+    /**
+     * The postal code for the UPS account's pickup address. The pickup postal code was entered in the UPS system when the account was set-up.
+     */
+    PostalCode?: string;
+};
+
+/**
+ * Container for the BillReceiver billing option.  This element or its sibling element, BillShipper, BillThirdParty or Consignee Billed, must be present but no more than one can be present. For a return shipment, Bill Receiver is invalid for Transportation charges.
+ */
+type ShipmentCharge_BillReceiver = {
+    /**
+     * The UPS account number.  The account must be a valid UPS account number that is active. For US, PR and CA accounts, the account must be a daily pickup account, an occasional account, a customer B.I.N account, or a dropper shipper account. All other accounts must be either a daily pickup account, an occasional account, a drop shipper account, or a non-shipping account.
+     */
+    AccountNumber: string;
+    Address?: BillReceiver_Address;
+};
+
+/**
+ * Container for the BillShipper billing option.  This element or its sibling element, BillReceiver, BillThirdParty or ConsigneeBilledIndicator, must be present but no more than one can be present.
+ */
+type ShipmentCharge_BillShipper = {
+    /**
+     * UPS account number  Must be the same UPS account number as the one provided in Shipper/ShipperNumber.
+     */
+    AccountNumber: string;
+};
+
+/**
+ * Container for additional information for the third party UPS accounts address.
+ */
+type BillThirdParty_Address = {
+    /**
+     * The origin street address including name and number (when applicable).
+     */
+    AddressLine?: Array<string>;
+    /**
+     * Origin city.
+     */
+    City?: string;
+    /**
+     * Origin state code.
+     */
+    StateProvinceCode?: string;
+    /**
+     * Origin postal code. The postal code must be the same as the UPS account pickup address postal code. Required for United States and Canadian UPS accounts and/or if the UPS account pickup address has a postal code. If the UPS account's pickup country or territory is US or Puerto Rico, the postal code is 5 or 9 digits. The character '-' may be used to separate the first five digits and the last four digits. If the UPS account's pickup country or territory is CA, the postal code is 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit.
+     */
+    PostalCode?: string;
+    /**
+     * Origin country or territory code. Refer to the Supported Country or Territory Tables located in the Appendix.
+     */
+    CountryCode: string;
+};
+
+/**
+ * Container for the third party billing option.  This element or its sibling element, BillShipper, BillReceiver or Consignee Billed, must be present but no more than one can be present.
+ */
+type ShipmentCharge_BillThirdParty = {
+    /**
+     * The UPS account number of the third party shipper.  The account must be a valid UPS account number that is active. For US, PR and CA accounts, the account must be either a daily pickup account, an occasional account, or a customer B.I.N account, or a drop shipper account. All other accounts must be either a daily pickup account, an occasional account, a drop shipper account, or a non-shipping account.
+     */
+    AccountNumber: string;
+    Address: BillThirdParty_Address;
+};
+
+/**
+ * Shipment charge container.  If Duty and Tax charges are applicable to a shipment and a payer is not specified, the default payer of Duty and Tax charges is Bill to Receiver. There will be no default payer of Duty and Tax charges for DDU and DDP service.
+ */
+type PaymentDetails_ShipmentCharge = {
+    /**
+     * Values are 01 = Transportation, 02 = Duties and Taxes
+     */
+    Type: string;
+    BillShipper?: ShipmentCharge_BillShipper;
+    BillReceiver?: ShipmentCharge_BillReceiver;
+    BillThirdParty?: ShipmentCharge_BillThirdParty;
+    /**
+     * Consignee Billing payment option indicator. The presence indicates consignee billing option is selected. The absence indicates one of the other payment options is selected.  Empty Tag. This element or its sibling element, BillShipper, BillReceiver or BillThirdParty, must be present but no more than one can be present. This billing option is valid for a shipment charge type of Transportation only. Only applies to US/PR and PR/US shipment origins and destination.
+     */
+    ConsigneeBilledIndicator?: string;
+};
+
+/**
+ * Payment details container for detailed shipment charges. The two shipment charges that are available for specification are Transportation charges and Duties and Taxes.  This container is used for Who Pays What functionality.
+ */
+type Shipment_PaymentDetails = {
+    ShipmentCharge: Array<PaymentDetails_ShipmentCharge>;
+    /**
+     * Split Duty VAT Indicator. The presence indicates the payer specified for Transportation Charges will pay transportation charges and any duties that apply to the shipment. The payer specified for Duties and Taxes will pay the VAT (Value-Added Tax) only.  Empty Tag. The payment method for Transportation charges must be UPS account. The UPS account must be a daily pickup account or an occasional account.
+     */
+    SplitDutyVATIndicator?: string;
+};
+
+/**
+ * PromotionalDiscountInformation container. This container contains discount information that the customer wants to request each time while placing a shipment.
+ */
+type Shipment_PromotionalDiscountInformation = {
+    /**
+     * Promotion Code. A discount that is applied to the user.  Required if PromotionalDiscountInformation container is present.
+     */
+    PromoCode: string;
+    /**
+     * Promotion Alias code  Required if PromotionalDiscountInformation container is present.
+     */
+    PromoAliasCode: string;
+};
+
+/**
+ * Service Container.  Only valid with RequestOption = Rate for both Small package and GFP Rating requests.
+ */
+type Shipment_Service = {
+    /**
+     * The code for the UPS Service associated with the shipment.
+     *
+     * NOTE: For a complete listing of values, refer to Service Codes in the Appendix
+     *
+     * Valid domestic values:
+     * - 01 = Next Day Air
+     * - 02 = 2nd Day Air
+     * - 03 = Ground
+     * - 12 = 3 Day Select
+     * - 13 = Next Day Air Saver
+     * - 14 = UPS Next Day Air Early
+     * - 59 = 2nd Day Air A.M.
+     * - 75 = UPS Heavy Goods
+     *
+     * Valid international values:
+     * - 07 = Worldwide Express
+     * - 08 = Worldwide Expedited
+     * - 11= Standard
+     * - 54 = Worldwide Express Plus
+     * - 65 = Saver
+     * - 96 = UPS Worldwide Express Freight
+     * - 71 = UPS Worldwide Express Freight Midday
+     *
+     * Required for Rating and ignored for Shopping.
+     *
+     */
+    Code: string;
+    /**
+     * A text description of the UPS Service associated with the shipment.  Length is not validated.
+     */
+    Description?: string;
+};
+
+/**
+ * Address container for Ship From.  Address Container
+ */
+type ShipFrom_Address = {
+    /**
+     * The origin street address including name and number (when applicable).  Length is not validated.
+     */
+    AddressLine?: Array<string>;
+    /**
+     * Origin city.  Required if country or territory does not utilize postal codes. Length is not validated.
+     */
+    City?: string;
+    /**
+     * Origin state code.  A StateProvinceCode and valid account number are required when requesting negotiated rates. Otherwise the StateProvinceCode is optional.
+     *
+     * If the TaxInformationIndicator flag is present in the request, a StateProvinceCode must be entered for tax charges to be accurately calculated in the response.
+     *
+     */
+    StateProvinceCode?: string;
+    /**
+     * Origin postal code.  Required if country or territory utilizes postal codes (e.g. US and PR).
+     */
+    PostalCode?: string;
+    /**
+     * Origin country or territory code. Refer to the Supported Country or Territory Tables located in the Appendix.  Required, but defaults to US.
+     */
+    CountryCode: string;
+};
+
+/**
+ * Ship From Container.
+ */
+type Shipment_ShipFrom = {
+    /**
+     * Origin attention name or company name.  Length is not validated.
+     */
+    Name?: string;
+    /**
+     * Origin attention name.  Length is not validated.
+     */
+    AttentionName?: string;
+    Address: ShipFrom_Address;
+};
+
+/**
+ * Container to hold shipment indication type.
+ */
+type Shipment_ShipmentIndicationType = {
+    /**
+     * Code for Shipment Indication Type.
+     *
+     * Valid values:
+     * - 01 - Hold for Pickup at UPS Access Point
+     * - 02 - UPS Access Point™ Delivery
+     *
+     */
+    Code: string;
+    /**
+     * Description for Shipment Indication Type.  Length is not Validated.
+     */
+    Description?: string;
+};
+
+/**
+ * Shipment Rating Options container.
+ */
+type Shipment_ShipmentRatingOptions = {
+    /**
+     * NegotiatedRatesIndicator -  Required to display two types of discounts: 1) Bids or Account Based Rates2) Web/Promotional Discounts BidsAccount Based Rates: If the indicator is present, the Shipper is authorized, and the Rating API XML Request is configured to return Negotiated Rates, then Negotiated Rates should be returned in the response. Web/Promotional Discounts: If the indicator is present, the Shipper is authorized for Web/Promotional Discounts then Negotiated Rates should be returned in the response.
+     */
+    NegotiatedRatesIndicator?: string;
+    /**
+     * FRS Indicator. The indicator is required to obtain rates for UPS Ground Freight Pricing (GFP).  The account number must be enabled for GFP.
+     */
+    FRSShipmentIndicator?: string;
+    /**
+     * RateChartIndicator -  If present in a request, the response will contain a RateChart element.
+     */
+    RateChartIndicator?: string;
+    /**
+     * UserLevelDiscountIndicator - required to obtain rates for User Level Promotions.  This is required to obtain User Level Discounts. There must also be no ShipperNumber in the Shipper container.
+     */
+    UserLevelDiscountIndicator?: string;
+    /**
+     * This indicator applies for a third party (3P) / Freight collect (FC) shipment only. For 3P/FC shipment if the shipper wishes to request for the negotiated rates of the third party then this indicator should be included in the request. If authorized the 3P/FC negotiated rates will be applied to the shipment and rates will be returned in response.
+     */
+    TPFCNegotiatedRatesIndicator?: string;
+};
+
+/**
+ * Access Point COD indicates Shipment level Access Point COD is requested for a shipment.  Valid only for "01 - Hold For Pickup At UPS Access Point" Shipment Indication type.
+ *
+ * Shipment Access Point COD is valid only for countries or territories within E.U.
+ *
+ * Not valid with (Shipment) COD.
+ *
+ * Not available to shipment with return service.
+ *
+ */
+type ShipmentServiceOptions_AccessPointCOD = {
+    /**
+     * Access Point COD Currency Code.  Required if Access Point COD container is present. UPS does not support all international currency codes. Refer to the appendix for a list of valid codes.
+     */
+    CurrencyCode: string;
+    /**
+     * Access Point COD Monetary Value.  Required if Access Point COD container is present.
+     *
+     * 8 digits prior to the decimal place and 2 after.
+     *
+     */
+    MonetaryValue: string;
+};
+
+/**
+ * CODAmount Container.  UPS does not support all international currency codes. Refer to the appendix for a list of valid codes.
+ */
+type ShipmentServiceOptions_COD_CODAmount = {
+    /**
+     * COD amount currency code type.
+     */
+    CurrencyCode: string;
+    /**
+     * COD Amount.
+     */
+    MonetaryValue: string;
+};
+
+/**
+ * If present, indicates C.O.D. is requested for the shipment.  Shipment level C.O.D. is only available for EU origin countries or territories.C.O.D. shipments are only available for Shippers with Daily Pickup and Drop Shipping accounts.
+ */
+type ShipmentServiceOptions_COD = {
+    /**
+     * For valid values, refer to Rating and Shipping COD Supported Countries or Territories in the Appendix.
+     */
+    CODFundsCode: string;
+    CODAmount: ShipmentServiceOptions_COD_CODAmount;
+};
+
+/**
+ * Delivery Confirmation Container.  DeliveryConfirmation and C.O.D. are mutually exclusive. Refer to the Appendix for a list of valid origin-destination country or territory pairs associated with each confirmation type.
+ */
+type ShipmentServiceOptions_DeliveryConfirmation = {
+    /**
+     * Type of delivery confirmation.  Valid values: 1 - Delivery Confirmation Signature Required 2 - Delivery Confirmation Adult Signature Required
+     */
+    DCISType: string;
+};
+
+/**
+ * Shipment Service Delivery Options Container.  Valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipments.
+ */
+type ShipmentServiceOptions_DeliveryOptions = {
+    /**
+     * The presence of the tag LiftGateAtDeliveryIndicator indicates that the shipment requires a lift gate for delivery.
+     */
+    LiftGateAtDeliveryIndicator?: string;
+    /**
+     * The presence of the tag DropOffAtUPSFacilityIndicator indicates the package will be dropped at a UPS facility for shipment.
+     */
+    DropOffAtUPSFacilityIndicator?: string;
+};
+
+/**
+ * Container for type of Import Control shipments.
+ */
+type ShipmentServiceOptions_ImportControl = {
+    /**
+     * Code for type of Import Control shipment. Valid values are: ImportControl One-Attempt '03' = ImportControl Three-Attempt'04' = ImportControl Electronic Label '05' = ImportControl Print Label.
+     */
+    Code: string;
+    /**
+     * Text description of the code representing the Import Control associated with the shipment.
+     */
+    Description?: string;
+};
+
+/**
+ * Shipment Service Pickup Options Container.  Valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipments.
+ */
+type ShipmentServiceOptions_PickupOptions = {
+    /**
+     * The presence of the tag LiftGatePickupRequiredIndicator indicates that the shipment requires a lift gate for pickup.
+     */
+    LiftGateAtPickupIndicator?: string;
+    /**
+     * The presence of the tag HoldForPickupIndicator indicates that the user opted to hold the shipment at UPS location for pickup.
+     */
+    HoldForPickupIndicator?: string;
+};
+
+/**
+ * Restricted Articles container.  Valid for UPS World Wide Express Freight shipments.
+ */
+type ShipmentServiceOptions_RestrictedArticles = {
+    /**
+     * This field is a flag to indicate if the package has Alcohol. True if present; false otherwise.  Valid for UPS World Wide Express Freight shipments.
+     */
+    AlcoholicBeveragesIndicator?: string;
+    /**
+     * This field is a flag to indicate if the package has Biological substances. True if present; false otherwise.  Valid for UPS World Wide Express Freight shipments. Lane check will happen based on postal code/ city.
+     */
+    DiagnosticSpecimensIndicator?: string;
+    /**
+     * This field is a flag to indicate if the package has Perishables. True if present; false otherwise.  Valid for UPS World Wide Express Freight shipments.
+     */
+    PerishablesIndicator?: string;
+    /**
+     * This field is a flag to indicate if the package has Plants. True if present; false otherwise.  Valid for UPS World Wide Express Freight shipments.
+     */
+    PlantsIndicator?: string;
+    /**
+     * This field is a flag to indicate if the package has Seeds. True if present; false otherwise.  Valid for UPS World Wide Express Freight shipments.
+     */
+    SeedsIndicator?: string;
+    /**
+     * This field is a flag to indicate if the package has Special Exceptions Restricted Materials. True if present; false otherwise.  Valid for UPS World Wide Express Freight shipments.
+     */
+    SpecialExceptionsIndicator?: string;
+    /**
+     * This field is a flag to indicate if the package has Tobacco. True if present; false otherwise.  Valid for UPS World Wide Express Freight shipments.
+     */
+    TobaccoIndicator?: string;
+    /**
+     * This field is a flag to indicate if the package has E-Cigarettes. True if present; false otherwise.  Valid for UPS World Wide Express Freight shipments.
+     */
+    ECigarettesIndicator?: string;
+    /**
+     * This field is a flag to indicate if the package has Hemp/CBD. True if present; false otherwise.  Valid for UPS World Wide Express Freight shipments.
+     */
+    HempCBDIndicator?: string;
+};
+
+/**
+ * Container for type of Return Services.
+ */
+type ShipmentServiceOptions_ReturnService = {
+    /**
+     * Code for type of Return shipment. Valid values are:'3' =UPS One-Attempt Return Label'5' = UPS Three Attempt Return Label'8' = UPS Electronic Return Label'9' = UPS Print Return Label'10' = UPS Exchange Print Return Label                            '11' = UPS Pack & Collect Service 1-Attempt Box 1 '12' = UPS Pack & Collect Service 1-Attempt Box 2 '13' = UPS Pack & Collect Service 1-Attempt Box 3 '14' = UPS Pack & Collect Service 1-Attempt Box 4 '15' = UPS Pack & Collect Service 1-Attempt Box 5 '16' = UPS Pack & Collect Service 3-Attempt Box 1 '17' = UPS Pack & Collect Service 3-Attempt Box 2 '18' = UPS Pack & Collect Service 3-Attempt Box 3 '19' = UPS Pack & Collect Service 3-Attempt Box 4 '20' = UPS Pack & Collect Service 3-Attempt Box 5  10 = UPS Exchange Print Return Label and 5 = UPS Three Attempt Return Label are not valid for UPS WorldWide Express Freight and UPS Worldwide Express Freight Midday Services. 3 = UPS One-Attempt Return Label is not valid return service with UPS Premium Care accessorial.
+     */
+    Code: string;
+    /**
+     * Description for type of Return Service.
+     */
+    Description?: string;
+};
+
+/**
+ * Shipment level Accessorials are included in this container.
+ */
+type Shipment_ShipmentServiceOptions = {
+    /**
+     * A flag indicating if the shipment requires a GlobalCheckoutIndicator. True if GlobalCheckoutIndicator tag exists; false otherwise  Empty Tag.
+     */
+    GlobalCheckoutIndicator?: string;
+    /**
+     * A flag indicating if the shipment requires a Saturday pickup. True if SaturdayPickupIndicator tag exists; false otherwise. Not available for GFP rating requests.  Empty Tag.
+     */
+    SaturdayPickupIndicator?: string;
+    /**
+     * A flag indicating if a shipment must be delivered on a Saturday. True if SaturdayDeliveryIndicator tag exists; false otherwise  Empty Tag.
+     */
+    SaturdayDeliveryIndicator?: string;
+    /**
+     * A flag indicating if a shipment must be delivered on a Sunday. True if SundayDeliveryIndicator tag exists; false otherwise  Empty Tag.
+     */
+    SundayDeliveryIndicator?: string;
+    /**
+     * If we need diferent available services in response, this option is used for shop request option. SaturdayDeliveryIndicator/ SundayDeliveryIndicator will be ignored in that case.  Valid Values:1- Weekday+Saturday services2- Weekday+Sunday services3- Weekday+Sat services+Sun services
+     */
+    AvailableServicesOption?: string;
+    AccessPointCOD?: ShipmentServiceOptions_AccessPointCOD;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored.
+     *
+     * DeliverToAddresseeOnlyIndicator is shipper specified restriction that requires the addressee to be the one who takes final delivery of the "Hold For PickUp at UPS Access Point" package.
+     *
+     * Presence of indicator means shipper restriction will apply to the shipment.  Only valid for Shipment Indication type "01 - Hold For PickUp at UPS Access Point".
+     *
+     */
+    DeliverToAddresseeOnlyIndicator?: string;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored. Direct Delivery Only (DDO) accessorial in a request would ensure that delivery is made only to the Ship To address on the shipping label.  This accessorial is not valid with Shipment Indication Types:
+     * - 01 - Hold For Pickup At UPS Access Point
+     * - 02 - UPS Access Point™ Delivery
+     *
+     */
+    DirectDeliveryOnlyIndicator?: string;
+    COD?: ShipmentServiceOptions_COD;
+    DeliveryConfirmation?: ShipmentServiceOptions_DeliveryConfirmation;
+    /**
+     * Return of Documents Indicator - If the flag is present, the shipper has requested the ReturnOfDocument accessorial be added to the shipment  Valid for Poland to Poland shipment.
+     */
+    ReturnOfDocumentIndicator?: string;
+    /**
+     * UPS carbon neutral indicator. Indicates the shipment will be rated as carbon neutral.
+     */
+    UPScarbonneutralIndicator?: string;
+    /**
+     * The empty tag in request indicates that customer would be using UPS prepared SED form.  Valid for UPS World Wide Express Freight shipments.
+     */
+    CertificateOfOriginIndicator?: string;
+    PickupOptions?: ShipmentServiceOptions_PickupOptions;
+    DeliveryOptions?: ShipmentServiceOptions_DeliveryOptions;
+    RestrictedArticles?: ShipmentServiceOptions_RestrictedArticles;
+    /**
+     * The empty tag in request indicates that customer would be using UPS prepared SED form.  Valid for UPS World Wide Express Freight shipments.
+     */
+    ShipperExportDeclarationIndicator?: string;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored. CommercialInvoiceRemovalIndicator - empty tag means indicator is present. CommercialInvoiceRemovalIndicator allows a shipper to dictate that UPS remove the Commercial Invoice from the user's shipment before the shipment is delivered to the ultimate consignee.
+     */
+    CommercialInvoiceRemovalIndicator?: string;
+    ImportControl?: ShipmentServiceOptions_ImportControl;
+    ReturnService?: ShipmentServiceOptions_ReturnService;
+    /**
+     * Empty Tag means the indicator is present. This field is a flag to indicate if the receiver needs SDL rates in response. True if SDLShipmentIndicator tag exists; false otherwise.  If present, the State Department License (SDL) rates will be returned in the response.This service requires that the account number is enabled for SDL.
+     */
+    SDLShipmentIndicator?: string;
+    /**
+     * For valid values, refer to Rating and Shipping COD Supported Countries or Territories in the Appendix.Presence/Absence Indicator. Any value inside is ignored. This field is a flag to indicate Package Release Code is requested for shipment.
+     *
+     * This accessorial is only valid with ShipmentIndicationType '01' - Hold for Pickup at UPS Access Point™.
+     *
+     */
+    EPRAIndicator?: string;
+    /**
+     * Inside Delivery accessory. Valid values:
+     * - 01 - White Glove
+     * - 02 - Room of Choice
+     * - 03 - Installation  Shippers account needs to have a valid contract for Heavy Goods Service.
+     *
+     */
+    InsideDelivery?: string;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored. If present, indicates that the customer would like items disposed.   Shippers account needs to have a valid contract for Heavy Goods Service.
+     */
+    ItemDisposalIndicator?: string;
+};
+
+/**
+ * UnitOfMeasurement Container.
+ */
+type ShipmentTotalWeight_UnitOfMeasurement = {
+    /**
+     * Code representing the unit of measure associated with the package weight.
+     *
+     * Valid values:
+     * - LBS = Pounds
+     * - KGS = Kilograms.
+     *
+     */
+    Code: string;
+    /**
+     * Text description of the code representing the unit of measure associated with the shipment weight.
+     */
+    Description: string;
+};
+
+/**
+ * Shipment Total Weight Container. This container is only applicable for "ratetimeintransit" and "shoptimeintransit" request options.  Required for all international shipments when retreiving time in transit information, including letters and documents shipments.
+ */
+type Shipment_ShipmentTotalWeight = {
+    UnitOfMeasurement: ShipmentTotalWeight_UnitOfMeasurement;
+    /**
+     * Non-zero total weight of all packages in the shipment.
+     */
+    Weight: string;
+};
+
+/**
+ * Address Container.  If the ShipFrom container is not present then this address will be used as the ShipFrom. If this address is used as the ShipFrom, the shipment will be rated from this origin address.
+ */
+type Shipper_Address = {
+    /**
+     * Shipper's street address including name and number (when applicable).  Maximum Occurrence should be three. Length is not validated. Note:Required if requesting Roadie Service
+     */
+    AddressLine: Array<string>;
+    /**
+     * Shipper's city.  Required if country or territory does not utilize postal codes. Length is not validated.
+     */
+    City?: string;
+    /**
+     * Shipper's state code.  Length is not validated.
+     */
+    StateProvinceCode?: string;
+    /**
+     * Shipper's postal code.  Length is not validated.
+     */
+    PostalCode?: string;
+    /**
+     * Country or Territory code. Refer to the Supported Country or Territory Tables located in Appendix.
+     */
+    CountryCode: string;
+};
+
+/**
+ * Shipper container. Information associated with the UPS account number.
+ */
+type Shipment_Shipper = {
+    /**
+     * Shipper's name or company name.  Length is not validated.
+     */
+    Name?: string;
+    /**
+     * Shipper's attention name.  Length is not validated.
+     */
+    AttentionName?: string;
+    /**
+     * Shipper's UPS account number.  A valid account number is required to receive negotiated rates. Optional otherwise. Cannot be present when requesting UserLevelDiscount.
+     */
+    ShipperNumber?: string;
+    Address: Shipper_Address;
+};
+
+/**
+ * Address Container.
+ */
+type ShipTo_Address = {
+    /**
+     * Destination street address including name and number (when applicable).  Max Occurrence can be 3. Length is not validated. Note:Required if requesting Roadie Service
+     */
+    AddressLine: Array<string>;
+    /**
+     * Destination city.  Required if country or territory does not utilize postal codes. Length is not validated.
+     */
+    City?: string;
+    /**
+     * Destination state code.
+     */
+    StateProvinceCode?: string;
+    /**
+     * Destination postal code.  Required if country or territory utilizes postal codes (i.e. US and PR).
+     */
+    PostalCode?: string;
+    /**
+     * Destination country or territory code. Refer to the Supported Country or Territory Tables located in the Appendix.
+     */
+    CountryCode: string;
+    /**
+     * Residential Address flag. This field is a flag to indicate if the destination is a residential location. True if ResidentialAddressIndicator tag exists; false otherwise. This element does not require a value and if one is entered it will be ignored.
+     *
+     * Note: When requesting TimeInTransit information, this indicator must be passed to determine if Three Day Select or Ground shipment is eligible for Saturday Delivery at no charge. If this indicator is not present, address will be considered as commercial. Empty Tag.
+     *
+     */
+    ResidentialAddressIndicator?: string;
+};
+
+/**
+ * Ship To Container
+ */
+type Shipment_ShipTo = {
+    /**
+     * Destination attention name or company name.  Length is not validated.
+     */
+    Name?: string;
+    /**
+     * Destination attention name.  Length is not validated.
+     */
+    AttentionName?: string;
+    Address: ShipTo_Address;
+};
+
+/**
+ * Container for Shipment Information.
+ */
+type RateRequest_Shipment = {
+    /**
+     * The time that the request was made from the originating system. UTC time down to milliseconds. Example - 2016-07-14T12:01:33.999  Applicable only for HazMat request and with subversion greater than or equal to 1701.
+     */
+    OriginRecordTransactionTimestamp?: string;
+    Shipper: Shipment_Shipper;
+    ShipTo: Shipment_ShipTo;
+    ShipFrom?: Shipment_ShipFrom;
+    AlternateDeliveryAddress?: Shipment_AlternateDeliveryAddress;
+    ShipmentIndicationType?: Array<Shipment_ShipmentIndicationType>;
+    PaymentDetails?: Shipment_PaymentDetails;
+    FRSPaymentInformation?: Shipment_FRSPaymentInformation;
+    FreightShipmentInformation?: Shipment_FreightShipmentInformation;
+    /**
+     * Goods Not In Free Circulation indicator.  This is an empty tag, any value inside is ignored. This indicator is invalid for a package type of UPS Letter and DocumentsOnly.
+     */
+    GoodsNotInFreeCirculationIndicator?: string;
+    Service?: Shipment_Service;
+    /**
+     * Total number of pieces in all pallets. Required for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipments.
+     */
+    NumOfPieces?: string;
+    ShipmentTotalWeight?: Shipment_ShipmentTotalWeight;
+    /**
+     * Valid values are Document and Non-document. If the indicator is present then the value is Document else Non-Document. Note: Not applicable for FRS rating  requests.  Empty Tag.
+     */
+    DocumentsOnlyIndicator?: string;
+    Package: Array<Shipment_Package>;
+    ShipmentServiceOptions?: Shipment_ShipmentServiceOptions;
+    ShipmentRatingOptions?: Shipment_ShipmentRatingOptions;
+    InvoiceLineTotal?: Shipment_InvoiceLineTotal;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored. RatingMethodRequestedIndicator is an indicator. If present, Billable Weight Calculation method and Rating Method information would be returned in response.
+     */
+    RatingMethodRequestedIndicator?: string;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored. TaxInformationIndicator is an indicator. The Tax related information includes any type of Taxes, corresponding Monetary Values, Total Charges with Taxes and disclaimers (if applicable) would be returned in response.  If present, any taxes that may be applicable to a shipment would be returned in response. If this indicator is requested with NegotiatedRatesIndicator, Tax related information, if applicable, would be returned only for Negotiated Rates and not for Published Rates.
+     */
+    TaxInformationIndicator?: string;
+    PromotionalDiscountInformation?: Shipment_PromotionalDiscountInformation;
+    DeliveryTimeInformation?: Shipment_DeliveryTimeInformation;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored. MasterCartonIndicator is an indicator and presence implies that shipment is Master Carton type.  If present, the shipment will be rated as a Master Carton Type. If this indicator is requested with NegotiatedRatesIndicator, rates would be returned only for Negotiated Rates and not for Published Rates.
+     */
+    MasterCartonIndicator?: string;
+    /**
+     * Presence/Absence Indicator. Any value inside is ignored. WWEShipmentIndicator is an indicator and presence implies that WWE service details requested for RequestOption=Shop or  RequestOption=Shoptimeintransit  RequestOption=Shop or  RequestOption=Shoptimeintransit
+     */
+    WWEShipmentIndicator?: string;
+};
+
+/**
+ * Rate Request container.
+ */
+type RateRequest = {
+    Request: RateRequest_Request;
+    PickupType?: RateRequest_PickupType;
+    CustomerClassification?: RateRequest_CustomerClassification;
+    Shipment: RateRequest_Shipment;
+};
+
+/**
+ * N/A
+ */
+type RATERequestWrapper = {
+    RateRequest: RateRequest;
+};
+
+/**
+ * UPS Rating Request Builder
+ * * This module transforms agnostic Shipstack rating requests into the
+ * specific nested JSON structure required by the UPS Rating API.
+ */
+
+/**
+ * Transforms an agnostic Shipstack rate request into a UPS RATERequestWrapper.
+ * * @param {InternalRateRequest} req - The standardized rating request.
+ * @param {string} shipperNumber - The 6-digit UPS account number (required for negotiated rates).
+ * @returns {RATERequestWrapper} The formatted UPS rating payload.
+ * @category Builders
+ * @public
+ */
+declare function buildUpsRateRequest(req: RateRequest$1, shipperNumber: string): RATERequestWrapper;
+
+/**
+ * Service Client for the FedEx Rates and Transit Times API v1.
+ * * This client abstracts the complexity of the FedEx OAuth2 flow and the
+ * deeply nested request structures required by the 'rateAndTransitTimes' endpoint.
+ * It ensures that every request is authenticated with a fresh Bearer token
+ * scoped to the provided credentials.
+ * * @example
+ * ```typescript
+ * const client = new FedexRatesClient(config);
+ * await client.init();
+ * const rates = await client.getRates(fedexPayload);
+ * ```
+ */
+declare class FedexRatesClient {
+    private config;
+    /**
+     * Initializes the FedEx Rates client.
+     * @param config - Validated FedEx configuration including clientId and clientSecret.
+     */
+    constructor(config: FedexConfig);
+    /**
+     * Performs the OAuth2 handshake and configures the global OpenAPI state.
+     * * This method must be called before executing any rate requests. it injects
+     * the retrieved Bearer token into the OpenAPI singleton used by the generated SDK.
+     * * @returns {Promise<void>}
+     * @throws {ShipstackError} If authentication fails or credentials are invalid.
+     */
+    init(): Promise<void>;
+    /**
+     * Retrieves real-time rates and transit times from FedEx.
+     * * Maps to the 'POST /rate/v1/rates/quotes' endpoint. This method ensures
+     * a fresh token is present before dispatching the request.
+     * * @param requestBody - The raw FedEx 'RateAndTransitTimesRequest' payload.
+     * @returns {Promise<any>} The raw FedEx 'RateAndTransitTimesResponse' object.
+     * @throws {Error} If the API returns a terminal error or network failure occurs.
+     */
+    getRates(requestBody: any): Promise<any>;
+}
+/**
+ * Factory function to instantiate a new FedexRatesClient.
+ * @param config - The FedEx configuration slice.
+ * @returns An instance of FedexRatesClient.
+ */
+declare const createFedexRatesClient: (config: FedexConfig) => FedexRatesClient;
+
+/**
+ * USPS Rates Service Client
+ * * A specialized wrapper for the USPS Domestic Prices v3 API.
+ * This client manages the configuration and execution of rate lookups,
+ * utilizing the generated OpenAPI SDK for standardized data fetching.
+ */
+
+/**
+ * Client for fetching real-time USPS domestic shipping rates.
+ * @public
+ */
+declare class UspsRatesClient {
+    private config;
+    /**
+     * Initializes the USPS Rates Client with provided configuration.
+     * @param {UspsConfig} config - USPS-specific credentials and environment settings.
+     */
+    constructor(config: UspsConfig);
+    /**
+     * Synchronizes the OpenAPI configuration singleton with the library's
+     * global client factory settings.
+     * @returns {Promise<void>}
+     */
+    init(): Promise<void>;
+    /**
+     * Queries the USPS API for available services and prices based on
+     * package weight, dimensions, and destination.
+     *
+     * * Executes against the /base-rates/search endpoint.
+     *
+     * @param {any} requestBody - The search parameters (BaseRatesQuery schema).
+     * @returns {Promise<any>} A collection of available shipping rates and service levels.
+     * @throws {Error} If the API request fails or the configuration is invalid.
+     */
+    getRates(requestBody: any): Promise<any>;
+}
+/**
+ * Factory function to create a new UspsRatesClient instance.
+ */
+declare const createUspsRatesClient: (config: UspsConfig) => UspsRatesClient;
+
+/**
+ * UPS Rating Service Client
+ * * Interacts with the generated RatingService to fetch shipping quotes.
+ */
+
+declare class UpsRatingClient {
+    private config;
+    private tokenManager;
+    private ratingService;
+    /**
+     * Initializes the UPS Rating Client and its internal service instance.
+     * * @param {UpsConfig} config - UPS-specific configuration.
+     */
+    constructor(config: UpsConfig);
+    /**
+     * Fetches available shipping rates.
+     * * @param {RATERequestWrapper} payload - The UPS-formatted request body.
+     * @returns {Promise<any>} The raw UPS RATEResponseWrapper.
+     */
+    getRates(payload: RATERequestWrapper): Promise<any>;
+}
+declare const createUpsRatesClient: (config: UpsConfig) => UpsRatingClient;
+
+/**
+ * Shipstack Shipping Manager
+ * * High-level orchestrator for cross-carrier operations.
+ * * This class provides the primary interface for e-commerce checkout logic,
+ * such as comparing and ranking rates across all configured carriers.
+ * * @module Core/ShippingManager
+ */
+
+/**
+ * Core manager for multi-carrier shipping operations.
+ * @public
+ */
+declare class ShippingManager {
+    private config;
+    /**
+     * Initializes the Shipping Manager with a specific configuration instance.
+     * @param {ShippingConfig} config - The global library configuration.
+     */
+    constructor(config: ShippingConfig);
+    /**
+     * Validates a physical address against a specific carrier.
+     * @param {AddressValidationRequest} req - The address validation payload.
+     */
+    validateAddress(req: AddressValidationRequest): Promise<AddressValidationResult>;
+    /**
+     * Retrieves tracking updates for a shipment.
+     * @param {string | string[]} trackingNumbers - Identifiers for the packages.
+     * @param {"usps" | "fedex" | "ups"} carrier - The target carrier.
+     */
+    track(trackingNumbers: string | string[], carrier: "usps" | "fedex" | "ups"): Promise<NormalizedTracking[]>;
+    /**
+     * Fetches, flattens, and ranks rates from enabled carriers.
+     * * Executes carrier requests in parallel and identifies value-added options.
+     * * @param req - The standardized shipment details, excluding the carrier.
+     * @param {Array<"usps" | "fedex" | "ups">} carriers - List of carriers to query.
+     * @returns {Promise<NormalizedRate[]>} A sorted list of rates by cost (ascending).
+     */
+    getRankedRates(req: Omit<RateRequest$1, "carrier">, carriers: ("usps" | "fedex" | "ups")[]): Promise<NormalizedRate[]>;
+}
+
+/**
+ * Shipstack: The Universal Shipping SDK
+ * * Primary entry point for the Shipstack library.
+ * Provides a stateful 'ShippingClient', the advanced 'ShippingManager',
+ * and stateless functional exports for serverless integrations.
+ * * @module Shipstack
+ */
+
+/**
+ * 1. CLASS-BASED API (The SDK Pattern)
+ * * Ideal for applications where configuration is initialized once.
+ * @category Core
+ */
+declare class ShippingClient {
+    private config;
+    /**
+     * Initializes the Shipstack client with carrier credentials.
+     * @param {ShippingConfig} config - The global library configuration.
+     */
+    constructor(config: ShippingConfig);
+    /**
+     * Retrieves all available shipping rates across configured carriers.
+     */
+    getRates(request: RateRequest$1): Promise<NormalizedRate[]>;
+    /**
+     * Validates and normalizes a physical address using a specified carrier.
+     */
+    validateAddress(request: AddressValidationRequest): Promise<AddressValidationResult>;
+    /**
+     * Standardized tracking for one or more packages.
+     * @param {string | string[]} trackingNumbers - Identifiers for the packages.
+     * @param {"usps" | "fedex" | "ups"} carrier - The target carrier.
+     */
+    track(trackingNumbers: string | string[], carrier: "usps" | "fedex" | "ups"): Promise<NormalizedTracking[]>;
+    /**
+     * Identifies the single cheapest shipping option.
+     */
+    getBestValue(request: RateRequest$1): Promise<NormalizedRate | null>;
+    /**
+     * Identifies the service with the shortest transit time.
+     */
+    getFastest(request: RateRequest$1): Promise<NormalizedRate | null>;
+    /**
+     * Static utility to predict the carrier based on tracking number patterns.
+     */
+    static predict(trackingNumber: string): "usps" | "fedex" | "ups" | "unknown";
+    /**
+     * Builds a staged shipment payload for the specified carrier without purchasing a label.
+     */
+    buildShipment(request: ShipmentRequest): Promise<StagedShipment>;
+    /**
+     * Creates a shipping label and returns a normalized shipment object.
+     */
+    createShipment(request: ShipmentRequest): Promise<NormalizedShipment>;
+}
+/**
+ * 2. FUNCTIONAL API (Direct Exports)
+ * * Stateless versions for dynamic configuration or tree-shaking.
+ */
+declare const getRates: typeof getRates$1;
+declare const validateAddress: typeof validateAddress$1;
+declare const trackShipment: typeof trackShipment$1;
+declare const getBestValueRate: typeof getBestValueRate$1;
+declare const getFastestService: typeof getFastestService$1;
+declare const predictCarrier: typeof predictCarrier$1;
+declare const buildShipment: typeof buildShipment$1;
+declare const createShipment: typeof createShipment$1;
+
+export { type AddressClassification, type AddressValidationRequest, type AddressValidationResult, type CustomsDeclaration, type FedexConfig, type NormalizedAddress, type NormalizedRate, type NormalizedShipment, type NormalizedTracking, type NormalizedTrackingEvent, type RateRequest$1 as RateRequest, type ShipmentRequest, ShippingClient, type ShippingConfig, ShippingManager, ShipstackError, type StagedShipment, ThrottlingError, type UpsConfig, type UspsConfig, buildFedexRateRequest, buildShipment, buildUpsRateRequest, buildUspsRateRequest, createFedexRatesClient, createShipment, createUpsRatesClient, createUspsRatesClient, getBestValueRate, getEnabledCarriers, getEnvironment, getFastestService, getFedexConfig, getRates, getUpsConfig, getUspsConfig, isShipstackError, isThrottlingError, predictCarrier, setShipstackConfig, trackShipment, validateAddress };