@shipengine/elements 2.19.0 → 2.21.0

package/types/src/elements/purchase-label/purchase-label.d.ts

@@ -0,0 +1,1365 @@
+import { UseConfigureShipmentProps } from "../../hooks/use-configure-shipment";
+import { UseImportSalesOrderProps } from "../../hooks/use-import-sales-order";
+import { PurchaseLabelFeatures } from "../../utilities/feature-flags";
+import React from "react";
+import { SE } from "@shipengine/react-api";
+import { HarmonizedTariffCode } from "../../types";
+import { ConfigureShipmentProps } from "./configure-shipment";
+import { UseShippingPresetsOptionsProps } from "./hooks";
+/**
+ * # Purchase Label Component Props
+ *
+ * These are the shared props that will be passed into the `<PurchaseLabel.Element />`, and work
+ * for either shipment-based or sales order-based label purchasing.
+ *
+ * @see {@link PurchaseLabel.Element | This prop types usage in `<PurchaseLabel.Element />`}
+ */
+export type PurchaseLabelCommonProps = {
+    /**
+     * The Currency used through out the label purchase process. Default to USD
+     */
+    currency?: SE.Currency;
+    /**
+     * A unique ID assigned during the creation of a sales order. It can be used to locate the
+     * sales order and any subsequent shipments related to that order.
+     */
+    externalOrderId?: UseImportSalesOrderProps["externalOrderId"];
+    /**
+     * A unique ID assigned during the creation of a sales order. It can be used to locate the
+     * sales order and any subsequent shipments related to that order.
+     */
+    externalOrderNumber?: UseImportSalesOrderProps["externalOrderNumber"];
+    /**
+     * A unique ID assigned during the creation of a sales order. It can be used to locate the
+     * sales order and any subsequent shipments related to that order.
+     */
+    externalShipmentId?: string;
+    /**
+     * `features` is a set of feature flags you would like to enable or disable in this component.
+     */
+    features?: PurchaseLabelFeatures;
+    /**
+     *`getPreferredRates is an async/sync optional callback function that will be invoked each time rates are caculated.
+     * This is an optional callback function that returns an array of ShipEngine rates. The rates from this response will
+     * be spliced into the normal get rates response the Elements makes internally. If a service code matches a service
+     * code on a rate returned from getPreferredRates, the rate returned from getPreferredRates will not be shown in the
+     * rate form. These preferred rates will be displayed with a set of UI enhancements that incude a dynamic cost savings
+     * flag and green checkmark when the rate is selected.
+     */
+    getPreferredRates?: ConfigureShipmentProps["getPreferredRates"];
+    /**
+     * `harmonizedTariffCodes` is an array of objects that contain the Harmonized Tariff Codes and descriptions used to populate the HS Codes dropdown within the Customs Form.
+     */
+    harmonizedTariffCodes?: HarmonizedTariffCode[];
+    /**
+     * `onAddressValidation` is an async/sync callback function that will be invoked on each Address
+     * validation request. For example, whenever you update the `Ship To Address` or
+     * `Ship From Address` for a given shipment.
+     */
+    onAddressValidation?: ConfigureShipmentProps["onAddressValidation"];
+    /**
+     *  `onApplyPreset` is an async/sync callback function that will be invoked each time a `Preset`
+     *  has been applied to a shipment.
+     */
+    onApplyPreset?: ConfigureShipmentProps["onApplyPreset"];
+    /**
+     * `onBeforeLabelCreate` is an async/sync callback function that will be invoked before every
+     * label purchase.
+     */
+    onBeforeLabelCreate?: ConfigureShipmentProps["onBeforeLabelCreate"];
+    /**
+     * `onBeforeRateSave` is an async/sync callback function that will be invoked before each time a user
+     * saves a rate.
+     */
+    onBeforeRateSaved?: ConfigureShipmentProps["onBeforeRateSaved"];
+    /**
+     * `onChangeAddress` is an async/sync callback function that will be invoked each time a
+     * `Ship To Address` or `Ship From Address` has been updated.
+     */
+    onChangeAddress?: ConfigureShipmentProps["onChangeAddress"];
+    /**
+     * `onChangeShipmentFormMode` is an async/sync callback function that will be invoked each time
+     * the user toggles the `Shipment Form Mode` between `Browse Rates` and `Selected Rate`.
+     */
+    onChangeShipmentFormMode?: ConfigureShipmentProps["onChangeShipmentFormMode"];
+    /**
+     * `onLabelCreateFailure` is an async/sync callback function that will be invoked each time a
+     * label purchase fails.
+     */
+    onLabelCreateFailure?: ConfigureShipmentProps["onLabelCreateFailure"];
+    /**
+     * `onLabelCreateSuccess` is an async/sync callback provided by the client that is invoked if the
+     * label is successfully created/purchased.
+     */
+    onLabelCreateSuccess?: ConfigureShipmentProps["onLabelCreateSuccess"];
+    /**
+     * `onLoad` is an async/sync callback provided by the host application that is invoked after the
+     * element is loaded. (This may be useful to grab the shipmentId of a one-off label)
+     */
+    onLoad?: UseConfigureShipmentProps["onLoad"];
+    /**
+     * `onRateSaved` is an async/sync callback function that will be invoked each time a rate is
+     * saved by the user when rate shopping in the host application.
+     */
+    onRateSaved?: ConfigureShipmentProps["onRateSaved"];
+    /**
+     * `onRatesCalculated` is an async/sync callback function that will be invoked each time rates
+     * are calculated for a given shipment.
+     */
+    onRatesCalculated?: ConfigureShipmentProps["onRatesCalculated"];
+    /**
+     * `onShipmentUpdated` is an async/sync callback function that will be invoked each time a
+     * shipment is updated with a new `ShipTo/ShipFrom Address`, `rate`, `preset`, etc.
+     */
+    onShipmentUpdated?: ConfigureShipmentProps["onShipmentUpdated"];
+    /**
+     * `onToggleAddressPreferenceDisclosure` is an async/sync callback function that will be invoked
+     * each time the user toggles the `Address Preference` disclosure. This disclosure component
+     * allows the user to select whether they would like to use the address they entered, or
+     * the formatted address that we return after validation.
+     */
+    onToggleAddressPreferenceDisclosure?: ConfigureShipmentProps["onToggleAddressPreferenceDisclosure"];
+    /**
+     * A unique Id refering the API code used to identify the type of order source, e.g. "amazon_ca"
+     */
+    orderSourceCode?: UseImportSalesOrderProps["orderSourceCode"];
+    /**
+     * `preferredServiceCodes` is an array of service codes you would like to be marked as preferred. The services
+     * codes corresponding rate will get the same UI enhancements as the rates received from getPreferredRates.
+     */
+    preferredServiceCodes?: ConfigureShipmentProps["preferredServiceCodes"];
+    /**
+     * `printLabelLayout` is a string that represents the label layout you would like to use when
+     * purchasing a label. e.g. `4x6`
+     */
+    printLabelLayout?: ConfigureShipmentProps["printLabelLayout"];
+    /**
+     * A unique Id used to indentify a ShipEngine Sales Order
+     */
+    salesOrderId?: UseImportSalesOrderProps["salesOrderId"];
+    /**
+     * `shipFromAddresses` is an array of objects that contain the ship from and return to addresses to be used when purchasing a label.
+     * This can be used in lieu of a `warehouseId` if initializing the Purchase Label Element without a pre-existing shipment or sales order.
+     */
+    shipFromAddresses?: ConfigureShipmentProps["shipFromAddresses"];
+    /**
+     * A unique Id used to indentify a ShipEngine Shipment
+     */
+    shipmentId?: string;
+    /**
+     * `shippingPresets` is an object that contains configured shipment details/specs
+     * (dimensions, shipping service, etc) that can be applied to a shipment when purchasing a label.
+     */
+    shippingPresets?: UseShippingPresetsOptionsProps;
+    /**
+     * `warehouseId` is a string that represents a previously configured warehouse you would
+     * like to use as the `Ship From Address` when purchasing a label.
+     */
+    warehouseId?: UseConfigureShipmentProps["warehouseId"];
+};
+/**
+ * # PurchaseLabel Element Props
+ *
+ * @see {@link PurchaseLabel.Element | This prop types usage in `<PurchaseLabel />`}
+ */
+export type ElementProps = PurchaseLabelCommonProps;
+/**
+ * # Purchase Label Component
+ *
+ * The `<PurchaseLabel />` component is used to purchase shipping labels from various carriers
+ *
+ * @param ElementProps The props necessary to render the `<PurchaseLabel />` component for shipment
+ * based or sales order based label purchasing.
+ *
+ * @returns Element An EmotionJSX.Element that will render the `<PurchaseLabel />` component
+ * with all the appropriate wrappers.
+ *
+ * @example
+ * You can see how the `<Component />` is used in the `createElement` function call below.
+ * ```tsx
+ * export const Element = createElement(Component, ErrorFallback, {
+ *
+ *   resources: { en },
+ * });
+ * ```
+ *
+ * <br />
+ *
+ * @see {@link PurchaseLabel.Element | The **Element** created to render `<PurchaseLabel />`}
+ */
+export declare const Component: ({ features, externalOrderId, externalOrderNumber, externalShipmentId, onLoad, onShipmentUpdated, orderSourceCode, salesOrderId, shipFromAddresses, warehouseId, shipmentId, printLabelLayout, currency: currencyProp, ...props }: ElementProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+/**
+ * # Registered Purchase Label Element
+ *
+ * @param ElementProps The props necessary to render the `<PurchaseLabel.Element />` for shipment
+ * based or sales order based label purchasing.
+ *
+ * @example
+ * The `<Component />` is the source JSX that is rendered when you make use of the `PurchaseLabel`
+ * Element directly.
+ * ```tsx
+ * <PurchaseLabel.Element
+ *   key={currentSalesOrderId}
+ *   printLabelLayout='4x6'
+ *   shippingPresets={presets}
+ *   onShipmentUpdated={(shipment) => console.log('Shipment Updated', shipment)}
+ *   onRateSaved={(
+ *     shipment: SE.SalesOrderShipment,
+ *     rate?: SE.Rate,
+ *     rateOptions?: SE.Rate[]
+ *   ) => console.log('Rate Saved', shipment, rate, rateOptions)}
+ *   onRatesCalculated={() => console.log('Rates Calculated')}
+ *   onBeforeLabelCreate={onBeforeLabelPurchase}
+ *   onLabelCreateSuccess={onLabelPurchaseSuccess}
+ *   onLabelCreateFailure={(rate) => console.log('Label Purchase Failed', rate)}
+ *   warehouseId={defaultWarehouseId}
+ * />
+ * ```
+ *
+ * <br />
+ *
+ * - Once a label has been purchased using this Element, you can take the `shipmentId` for the
+ * associated shipment and pass it into the `<ShipmentSummary.Element />` Element in order to view
+ * the shipment details.
+ *
+ * @see {@link PurchaseLabel.PurchaseLabelCommonProps | The **Common props** used in `<PurchaseLabel.Element />`}
+ *
+ * @see {@link ShipmentSummary.Element | The next step in the label purchase workflow `<ShipmentSummary.Element />`}
+ */
+export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps & import("../../create-element/element").CSSProp & {
+    resources?: {
+        en: {
+            "wallet-history": {
+                actions: {
+                    downloadCsv: string;
+                    chooseDate: string;
+                    tryAgain: string;
+                };
+                errors: {
+                    failureToFetch: string;
+                };
+                dateRange: string;
+                details: {
+                    inaccurateWeight: string;
+                };
+                historyOptions: {
+                    custom: string;
+                    last30days: string;
+                    thisMonth: string;
+                    lastMonth: string;
+                };
+                category: {
+                    fundsAdded: string;
+                };
+            };
+            "void-label": {
+                title: string;
+                actions: {
+                    complete: string;
+                    confirmVoid: string;
+                    viewShipment: string;
+                };
+                errorMessages: {
+                    labelIdRequired: string;
+                    request_failed_to_complete: string;
+                };
+                resultMessages: {
+                    approved: string;
+                    rejected: string;
+                    dpdwallet: string;
+                };
+                refund_process: string;
+                refund_rules: string;
+                resultTitles: {
+                    approved: string;
+                    rejected: string;
+                }; /**
+                 * The Currency used through out the label purchase process. Default to USD
+                 */
+                voidedOn: string;
+            };
+            "view-shipment": {
+                title: string;
+                actions: {
+                    buyAnotherLabel: string;
+                    hideItems: string;
+                    printForms: string;
+                    printLabel: string;
+                    schedulePickup: string;
+                    showItems: string;
+                    void: string;
+                    download: string;
+                    fileClaim: string;
+                };
+                fields: {
+                    dimensions: string;
+                    estimatedShipping: string;
+                    items: string;
+                    orderDate: string;
+                    orderValue: string;
+                    requestedShipping: string;
+                    shipDate: string;
+                    shipTo: string;
+                    warehouse: string;
+                    weight: string;
+                    insuredValue: string;
+                    deliveryConfirmation: string;
+                };
+                insurance: {
+                    parcelguard: {
+                        title: string;
+                        description: string;
+                        cta: {
+                            title: string;
+                            description: string;
+                        };
+                        registerSuccess: {
+                            title: string;
+                            description: string;
+                        };
+                    };
+                };
+                highVolumeForms: string;
+                multipleShippingServices: string;
+                sections: {
+                    labels: string;
+                    shipmentSummary: string;
+                };
+                noLabels: string;
+            }; /**
+             * `features` is a set of feature flags you would like to enable or disable in this component.
+             */
+            "vat-settings": {
+                addNew: string;
+                vatNumber: string;
+                vatRegistrationTooltip: string;
+                vatFormText: string;
+                vatNumberInputHint: string;
+                vatNumberInputPlaceholder: string;
+                verifiedVat: string;
+                vatNumberFieldLabel: string;
+                vatTypePlaceholder: string;
+                issuingAuthorityPlaceholder: string;
+                issuingAuthorityFieldLabel: string;
+                vatFormErrors: {
+                    invalidFieldValue: string; /**
+                     * # Purchase Label Component Props
+                     *
+                     * These are the shared props that will be passed into the `<PurchaseLabel.Element />`, and work
+                     * for either shipment-based or sales order-based label purchasing.
+                     *
+                     * @see {@link PurchaseLabel.Element | This prop types usage in `<PurchaseLabel.Element />`}
+                     */
+                    verificationFailure: string;
+                    forbidden: string;
+                    connectionNotSupported: string;
+                    genericText: string;
+                }; /**
+                 * The Currency used through out the label purchase process. Default to USD
+                 */
+            };
+            "manage-carriers": {
+                title: string;
+                headers: {
+                    accountCarriers: string;
+                    carriers: string;
+                    settings: string;
+                };
+                actions: {
+                    status: {
+                        connected: string;
+                        notConnected: string;
+                    };
+                };
+            };
+            "register-wallet": {
+                sections: {
+                    billing: {
+                        title: string;
+                        cardSubTitle: string;
+                        addressSubTitle: string;
+                    };
+                    vatSettings: {
+                        title: string;
+                    };
+                    carriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                    insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
+                        parcelguard: {
+                            description: string;
+                            terms: string;
+                            termsLink: string;
+                            popover: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
+                    notifications: {
+                        error: {
+                            title: string;
+                        };
+                        info: {
+                            description: string;
+                        };
+                        poBox: {
+                            title: string;
+                            description: string;
+                        };
+                        carrier: {
+                            title: string;
+                            confirmAddress: string;
+                            description: string;
+                        };
+                        blackBox: {
+                            description: string;
+                        };
+                    };
+                };
+                settings: {
+                    title: string;
+                    billing: {
+                        title: string; /**
+                         *`getPreferredRates is an async/sync optional callback function that will be invoked each time rates are caculated.
+                         * This is an optional callback function that returns an array of ShipEngine rates. The rates from this response will
+                         * be spliced into the normal get rates response the Elements makes internally. If a service code matches a service
+                         * code on a rate returned from getPreferredRates, the rate returned from getPreferredRates will not be shown in the
+                         * rate form. These preferred rates will be displayed with a set of UI enhancements that incude a dynamic cost savings
+                         * flag and green checkmark when the rate is selected.
+                         */
+                        subtitleCard: string;
+                        subtitleBilling: string;
+                    };
+                };
+            };
+            "register-carrier": {
+                formTitle: {
+                    default: string;
+                    new: string;
+                    edit: string;
+                };
+                notifications: {
+                    error: {
+                        title: string;
+                    };
+                };
+                noFundingSource: string;
+            };
+            "rate-details": {
+                total: string;
+                subtotal: string;
+                registerVat: string;
+                concepts: {
+                    confirmation: string;
+                    uncategorized: string;
+                    shipping: string;
+                    insurance: string;
+                    confirm: string;
+                    discount: string;
+                    fuel_charge: string;
+                    additional_fees: string;
+                    tariff: string;
+                    tax: string;
+                    delivery: string;
+                    handling: string;
+                    special_goods: string;
+                    pickup: string;
+                    location_fee: string;
+                    oversize: string;
+                    returns: string;
+                    notifications: string;
+                    tip: string;
+                    duties_and_taxes: string;
+                    brokerage_fee: string;
+                    admin_fee: string;
+                    adjustment: string;
+                    auctane_service_fee: string;
+                    product_price: string;
+                };
+            };
+            "purchase-label": {
+                title: string;
+                actions: {
+                    calculateRates_one: string;
+                    calculateRates_other: string;
+                    hideItems: string;
+                    purchaseLabel: string;
+                    purchaseNow: string;
+                    showItems: string;
+                    showMoreRates: string;
+                    showFewerRates: string;
+                    saveRate: string;
+                };
+                balance: {
+                    currentBalance: string;
+                    insufficientBalanceCTA: string;
+                };
+                cta: {
+                    addPackageDetails: string;
+                    parcelguard: string;
+                };
+                errorMessages: {
+                    customsItemsRequired: string;
+                    invalidAddress: string;
+                    noRates: string;
+                    salesOrderNotLoaded: string;
+                    unsupportedAddress: string;
+                    saveRateFailedMessage: string;
+                    saveRateFailedTitle: string;
+                };
+                errorTypes: {
+                    results: string;
+                };
+                fields: {
+                    "requires-additional-handling": string;
+                    addOns: string;
+                    contentDescription: string;
+                    confirmation: string;
+                    dimensions: {
+                        length: string;
+                        width: string;
+                        height: string;
+                    };
+                    dimensionsGroup: string;
+                    estimatedShipping: string;
+                    insurance: string;
+                    insuranceProvider: string;
+                    insuredValue: string;
+                    items: string;
+                    orderDate: string;
+                    orderValue: string;
+                    packageCode: string;
+                    requestedShipping: string;
+                    shipDate: string;
+                    service: string;
+                    shipTo: string;
+                    addShipToAddress: string;
+                    warehouse: string;
+                    weight: {
+                        whole: string;
+                        fractional: string;
+                    };
+                    weightGroup: string;
+                    today: string;
+                };
+                hints: {
+                    contentDescription: string;
+                };
+                loading: {
+                    calculatingRates: string;
+                    savingRate: string;
+                };
+                modes: {
+                    browseRates: string;
+                    selectService: string;
+                };
+                multipleShippingServices: string;
+                schemaErrors: {
+                    shipFromUnitedStatesOnly: string;
+                    shipFromAddressRequired: string;
+                    needToAcknowledge: string;
+                };
+                rates: {
+                    requestedShippingNotification: string;
+                    uspsMediaMailAcknowledgement: string;
+                    uspsFirstClassMailAcknowledgement_leof: string;
+                    rateSavings: string;
+                    upsGroundSaverTermsAcknowledgement: string;
+                    dhlExpressTermsAcknowledgement: string;
+                    noRateService: string;
+                };
+                windsorFramework: {
+                    movementIndicator: string;
+                    movementIndicators: {
+                        b2c: string;
+                        c2b: string;
+                        c2c: string;
+                        b2b: string;
+                    };
+                    notAtRisk: string;
+                    notAtRiskShipmentTootip: string;
+                };
+                requirements: {
+                    noWarehouse: string;
+                    noCarrier: string;
+                    noWarehouseOrCarrier: string;
+                };
+                servicePoints: {
+                    searchLabel: string;
+                    noRatesForType: string;
+                    dropOff: string;
+                    pickUp: string;
+                    closed: string;
+                    hideLocations: string;
+                    moreLocations: string;
+                    nearestLocation: string;
+                    open: string;
+                    nextOpeningDay: string; /**
+                     * `onRateSaved` is an async/sync callback function that will be invoked each time a rate is
+                     * saved by the user when rate shopping in the host application.
+                     */
+                    until: string;
+                    selected: string;
+                    select: string;
+                    today: string;
+                    viewMap: string;
+                    otherLocations: string;
+                    noServicePointsForService: string;
+                    error: string;
+                    paperless: string;
+                    /**
+                     * `onShipmentUpdated` is an async/sync callback function that will be invoked each time a
+                     * shipment is updated with a new `ShipTo/ShipFrom Address`, `rate`, `preset`, etc.
+                     */
+                    localTimeDisclaimer: string;
+                };
+                shipToAddressFormFields: string;
+                sections: {
+                    customsForm: string;
+                    windsorFramework: string;
+                    shipment: string;
+                    rate_one: string;
+                    rate_other: string;
+                    payment: string;
+                };
+            };
+            "payment-method": {
+                title: string;
+            };
+            onboarding: {
+                title: string;
+                previouslyOnboarded: {
+                    title: string;
+                    subtitle: string;
+                };
+                confirmation: {
+                    title: string;
+                    warehouse: string;
+                    billingAddress: string;
+                    paymentMethod: string;
+                    action: string;
+                    noPaymentMethod: string;
+                };
+                stepLabel: {
+                    confirmation: string;
+                    termsAgreement: string;
+                    shipFromAddress: string;
+                    fundingAndCarrierConnection: string;
+                };
+                termsAgreement: {
+                    title: string;
+                    subtitle: string;
+                };
+                warehouse: {
+                    title: string;
+                    subtitle: string;
+                    inlineMessage: string;
+                };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                    unableToLoad: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
+                success: {
+                    title: string;
+                    subtitle: string;
+                    action: string;
+                };
+                termsAndAgreementLinkText: {
+                    shipEngineToS: string;
+                    auctanePrivacyPolicy: string;
+                    aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
+                    "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
+                    "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
+                    "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
+                    aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
+                    "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
+                    "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
+                    "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
+                    aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
+                    "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
+                    aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
+                    aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
+                    aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
+                };
+                termsAndAgreementTitles: {
+                    "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
+                    "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
+                    "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
+                    RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
+                    "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
+                    "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
+                    UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
+                };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
+            };
+            "manage-warehouses": {
+                title: string;
+                addNew: string;
+                editWarehouse: string;
+                contactName: string;
+                default: string;
+                isDefault: string;
+                locationName: string;
+                residentialAddress: string;
+                returnTo: string;
+                returnToAddressIsDifferent: string;
+                setDefault: string;
+                shipFrom: string;
+                noWarehouses: string;
+            };
+            "manage-funding": {
+                actions: {
+                    addFunds: string;
+                    addFundsAndPurchase: string;
+                    addNow: string;
+                    saveRule: string;
+                };
+                autoFunding: {
+                    edit: string;
+                    editSettings: string;
+                    error: {
+                        title: string;
+                        message: string;
+                    };
+                    isEnabledCTA: string;
+                    isEnabled: string;
+                    isLoading: string;
+                    lowBalancePurchaseThreshold: string;
+                    maximumPurchasesPerDay: string;
+                    purchaseAmount: string;
+                    readSettings: string;
+                };
+                addFunds: {
+                    custom: string;
+                    error: {
+                        title: string;
+                        message: string;
+                    };
+                    isLoading: string;
+                    labels: {
+                        amount: string;
+                    };
+                    minimumPurchaseAmount: string;
+                    other: string;
+                };
+                fundAndPurchase: {
+                    finalBalance: string;
+                    insufficientFunds: string;
+                    insufficientFundsTitle: string;
+                    negativeBalance: string;
+                    negativeBalanceTitle: string;
+                    newBalance: string;
+                };
+                errors: {
+                    balanceUnknown: string;
+                    unableToFindBalance: string;
+                    noFundingSource: string;
+                };
+                byoc: {
+                    invoiceNotification: string;
+                };
+                currentBalance: string;
+                maximumBalanceAmount: string;
+            };
+            "manage-defaults": {
+                label: {
+                    title: string;
+                    letter: {
+                        title: string;
+                        description: string;
+                    };
+                    purchase: {
+                        title: string;
+                        description: string;
+                    };
+                    thermal: {
+                        title: string;
+                        description: string;
+                    };
+                };
+                status: {
+                    saving: string;
+                    saved: string;
+                    savingFailed: string;
+                };
+                units: {
+                    title: string;
+                    dimensions: {
+                        title: string;
+                        standard: string;
+                        metric: string;
+                    };
+                    weight: {
+                        title: string;
+                        standard: string;
+                        g: string;
+                        kg: string;
+                    };
+                };
+            };
+            "list-shipments": {
+                title: string;
+                none: string;
+                headers: {
+                    created: string;
+                    modified: string;
+                    shipping: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    status: string;
+                };
+                status: {
+                    cancelled: string;
+                    purchased: string;
+                    readyToBuy: string;
+                    processing: string;
+                };
+                actions: {
+                    download: {
+                        pdf: string;
+                    };
+                };
+                emptyState: {
+                    title: string;
+                    subtitle: string;
+                    filtersTitle: string;
+                    filtersSubtitle: string;
+                    viewAll: string;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
+            };
+            "list-labels": {
+                title: string;
+                headers: {
+                    created: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    shipping: string;
+                    shipDate: string;
+                    status: string;
+                    trackingStatus: string;
+                    labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
+                    shipmentNumber: string;
+                };
+                empty: {
+                    title: string;
+                    subtitle: string;
+                };
+                emptyWithFilters: {
+                    title: string;
+                    subtitle: string;
+                    button: string;
+                };
+                status: {
+                    voided: string;
+                    error: string;
+                    completed: string;
+                    processing: string;
+                };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    in_transit: string;
+                    delivered: string;
+                    error: string;
+                    voided: string;
+                };
+                actions: {
+                    title: string;
+                    print: string;
+                    void: string;
+                    printForms: string;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
+            };
+            "connect-carrier": {
+                actions: {
+                    cancel: string;
+                    carrierSettings: string;
+                    connectCarriers: string;
+                    disconnect: string;
+                    disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
+                };
+                noCarriersDescription: string;
+                registrationForm: {
+                    error: string;
+                    title: string;
+                    betaWarning: string;
+                };
+                search: string;
+                settingsModal: {
+                    closeDialog: string;
+                    header: string;
+                };
+                status: {
+                    connected: string;
+                };
+                disconnectDropdown: {
+                    toastTitle: string;
+                    toastBody: string;
+                };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
+            };
+            common: {
+                actions: {
+                    add: string;
+                    cancel: string;
+                    close: string;
+                    confirm: string;
+                    connect: string;
+                    continue: string;
+                    delete: string;
+                    edit: string;
+                    enable: string;
+                    hide: string;
+                    parse: string;
+                    purchase: string;
+                    remove: string;
+                    save: string;
+                    skipForNow: string;
+                    submit: string;
+                    tryAgain: string;
+                };
+                address: {
+                    fields: {
+                        name: string;
+                        fullName: string;
+                        company: string;
+                        county: string;
+                        countryCode: string;
+                        addressLine1: string;
+                        addressLine2: string;
+                        cityLocality: string;
+                        stateProvince: string;
+                        postalCode: string;
+                        phone: string;
+                        email: string;
+                        addressResidentialIndicator: string;
+                    };
+                    noResults: string;
+                    subFields: {
+                        optional: string;
+                    };
+                    parserFields: {
+                        fullAddress: string;
+                    };
+                    paste: string;
+                    preference: {
+                        confirm: string;
+                        addressNotValidated: string;
+                        modified: string;
+                        title: string;
+                        originalAddress: string;
+                        matchedAddress: string;
+                        unableToValidate: string;
+                        use: {
+                            originalAddress: string;
+                            matchedAddress: string;
+                        };
+                    };
+                    validation: {
+                        notValidated: string;
+                        validated: string;
+                    };
+                };
+                billing: {
+                    fields: {
+                        differentBillingAddress: string;
+                        name: string;
+                        cardNumber: string;
+                        expiration: string;
+                        cvv: string;
+                        cvvPlaceholder: string;
+                        expirationPlaceholder: string;
+                        cardNumberPlaceholder: string;
+                    };
+                };
+                carriers: {
+                    fields: {
+                        agreement: string;
+                    };
+                    terms: {
+                        agreeToTerms: string;
+                        title: string;
+                    };
+                };
+                charsetWarnings: {
+                    name: {
+                        message: string;
+                    };
+                    address: {
+                        message: string;
+                        title: string;
+                    };
+                };
+                confirmationTypes: {
+                    adultSignature: string;
+                    delivery: string;
+                    deliveryMailed: string;
+                    directSignature: string;
+                    none: string;
+                    signature: string;
+                    verbalConfirmation: string;
+                };
+                customs: {
+                    addDeclaration: string;
+                    noResults: string;
+                    contents: {
+                        documents: string;
+                        gift: string;
+                        merchandise: string;
+                        returnedGoods: string;
+                        sample: string;
+                    };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string;
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
+                    currencyChange: string;
+                    declarations: string;
+                    descriptionTooltip: {
+                        message: string;
+                        example1: string;
+                        example2: string;
+                    };
+                    fields: {
+                        contentsType: string;
+                        countryOfOrigin: string;
+                        description: string;
+                        harmonizedTariffCode: string;
+                        ifDeliveryFails: string;
+                        dutiesTaxes: string;
+                        quantity: string;
+                        sku: string;
+                        value: string;
+                        valueQuantity: string; /**
+                         * `onLoad` is an async/sync callback provided by the host application that is invoked after the
+                         * element is loaded. (This may be useful to grab the shipmentId of a one-off label)
+                         */
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
+                    };
+                    hsCode: string;
+                    nonDelivery: {
+                        returnToSender: string;
+                        treatAsAbandoned: string;
+                    };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        /**
+                         * `onRatesCalculated` is an async/sync callback function that will be invoked each time rates
+                         * are calculated for a given shipment.
+                         */
+                        recipientPays: string;
+                        tooltip: {
+                            title: string;
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
+                    removeAllDeclarations: string;
+                    total: string;
+                };
+                errorMessages: {
+                    invalidNameOrCompany: string;
+                    parsingFailure: string;
+                    incompleteLabelPurchaseRequirements: string;
+                    shipmentCancelled: string;
+                    unableToLoad: {
+                        accountSettings: string;
+                        autoFundingSettings: string;
+                        carrier: string;
+                        carriers: string;
+                        connectCarrierForm: string;
+                        fundingSourceMetadata: string;
+                        label: string;
+                        labels: string;
+                        salesOrder: string;
+                        shipment: string;
+                        shipments: string;
+                        warehouses: string;
+                    };
+                    labelHasBeenPurchased: string;
+                    emailIsRequired: string;
+                    unknown: string;
+                    noRatesAvailable: string;
+                    refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
+                    windsorFramework: {
+                        doNotConform: string;
+                        pleaseAddTheFollowingTaxIds: string;
+                        windsorFrameworkDefaultMessage: string;
+                        shipperEori: string;
+                        recipientEori: string;
+                        ukims: string;
+                    };
+                };
+                errorTypes: {
+                    accountStatus: string;
+                    businessRules: string;
+                    integrations: string;
+                    purchase: string;
+                    rateInvalid: string;
+                    saveRate: string;
+                    security: string;
+                    shipmentStatus: string;
+                    shipFromAddress: string;
+                    system: string;
+                    unknown: string;
+                    validation: string;
+                    windsorFramework: string;
+                };
+                grid: {
+                    "row-count_one": string;
+                    "row-count_other": string;
+                    rows: string;
+                    clearAll: string;
+                    shipmentId: string;
+                    labelId: string;
+                    labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
+                    createdDate: string;
+                    shipmentIdFilter: string;
+                    createdDateFilter: string;
+                    apply: string;
+                    clear: string;
+                    search: string;
+                    shipmentIdHint: string;
+                    labelIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
+                };
+                insuranceProviders: {
+                    carrier: string;
+                    none: string;
+                    parcelguard: string;
+                    shipsurance: string;
+                    thirdParty: string;
+                    x_cover: string;
+                };
+                loading: {
+                    accountSettings: string;
+                    carrier: string;
+                    carriers: string;
+                    carrierServices: string;
+                    connectCarrierForm: string;
+                    connectingCarriers: string;
+                    creatingFundingSource: string;
+                    submittingOnboarding: string;
+                    submittingWarehouse: string;
+                    updatingPaymentMethod: string;
+                    data: string;
+                    importingSalesOrder: string;
+                    label: string;
+                    labels: string;
+                    onboarding: string;
+                    salesOrder: string;
+                    shipment: string;
+                    shipments: string;
+                    warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
+                };
+                months: {
+                    january: string;
+                    february: string;
+                    march: string;
+                    april: string;
+                    may: string;
+                    june: string;
+                    july: string;
+                    august: string;
+                    september: string;
+                    october: string;
+                    november: string;
+                    december: string;
+                };
+                packageCategories: {
+                    customPackages: string;
+                };
+                packageCodes: {
+                    package: string;
+                };
+                "powered-by": string;
+                schema: {
+                    optionalLabel: string;
+                };
+                required: string;
+                schemaErrors: {
+                    notAValidPhoneNumber: string;
+                    mustAgreeToTerms: string;
+                    group: {
+                        allMeasurementsOrNone: string;
+                    };
+                    invalidAddressName: string;
+                    invalidAddressNameStrict: string;
+                    invalidAddressNameOnboarding: string;
+                    invalidAddressPoBox: string;
+                    invalidCreditCardType: string;
+                    invalidExpirationDate: string;
+                    invalidPostalCode: string;
+                    invalidStateProvince: string;
+                    invalidString: string;
+                    nonnegative: string;
+                    nonnegativeList: string;
+                    positive: string;
+                    positiveList: string;
+                    required: string;
+                    requiredList: string;
+                    tooFewCharacters: string;
+                    tooManyCharacters: string;
+                    requiredShipmentId: string;
+                    requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
+                };
+                shippingPresets: {
+                    apply: string;
+                    platform: string;
+                    user: string;
+                };
+                tags: {
+                    new: string;
+                };
+                terms: {
+                    fields: {
+                        agreement: string;
+                    };
+                    agreeToTerms: string;
+                    carriersTitle: string;
+                    fundingSourceTitle: string;
+                    insuranceProvidersTitle: string;
+                    shipEngineTitle: string;
+                };
+                weight: {
+                    ounces: string;
+                    pounds_one: string;
+                    pounds_other: string;
+                    kilogram: string;
+                    gram: string;
+                };
+                units: {
+                    inch: string;
+                    lbs: string;
+                    oz: string;
+                    centimeter: string;
+                    gram: string;
+                    kilogram: string;
+                };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                        viewDetails: string;
+                        cancelShipment: string;
+                    };
+                };
+                ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
+                T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
+                "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
+                "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
+                QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
+                "QWRkcmVzcyBub3QgZm91bmQ=": string;
+                QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
+                UGxlYXNlIGFkZCBhIFN0YW1wcy5jb20gYWNjb3VudCB0byBTaGlwRW5naW5lIGluIG9yZGVyIHRvIGNyZWF0ZSBzaGlwcGluZyBsYWJlbHMu: string;
+                QSBzaGlwcGluZyBlcnJvciBvY2N1cnJlZDogTWlzc2luZyBvciBpbnZhbGlkIHNoaXBwZXIgbnVtYmVy: string;
+                QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcHBlciBuYW1l: string;
+                "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
+                "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
+            };
+            "account-settings": {
+                messages: {
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
+                };
+                title: string;
+                sections: {
+                    accountBalance: string;
+                    paymentMethod: string;
+                    transactionHistory: string;
+                    adjustmentHistory: string;
+                    warehouses: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
+                    externalCarriers: string;
+                    labelLayout: string;
+                    unitSettings: string;
+                    vatSettings: string;
+                };
+            };
+        };
+    } | undefined;
+}) => import("@emotion/react/jsx-runtime").JSX.Element;
+/**
+ * # Purchase Label Component Props
+ *
+ * @see {@link PurchaseLabel.Component | The **Common Props** used in the `<PurchaseLabel /> component`}
+ */
+export type ComponentProps = React.ComponentProps<typeof Element>;