@shipengine/elements 2.20.0 → 2.21.0

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

@@ -513,10 +513,6 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     saveRateFailedMessage: string;
                     saveRateFailedTitle: string;
                 };
-                /**
-                 * 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.
-                 */
                 errorTypes: {
                     results: string;
                 };
@@ -531,9 +527,6 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                         height: string;
                     };
                     dimensionsGroup: string;
-                    /**
-                     * `features` is a set of feature flags you would like to enable or disable in this component.
-                     */
                     estimatedShipping: string;
                     insurance: string;
                     insuranceProvider: string;
@@ -560,6 +553,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                 };
                 loading: {
                     calculatingRates: string;
+                    savingRate: string;
                 };
                 modes: {
                     browseRates: string;
@@ -601,15 +595,15 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     noRatesForType: string;
                     dropOff: string;
                     pickUp: string;
-                    closed: 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)
-                     */
+                    closed: string;
                     hideLocations: string;
                     moreLocations: string;
                     nearestLocation: string;
                     open: string;
-                    nextOpeningDay: 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;
@@ -619,6 +613,10 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     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;
@@ -636,12 +634,17 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
             };
             onboarding: {
                 title: string;
+                previouslyOnboarded: {
+                    title: string;
+                    subtitle: string;
+                };
                 confirmation: {
                     title: string;
                     warehouse: string;
                     billingAddress: string;
                     paymentMethod: string;
                     action: string;
+                    noPaymentMethod: string;
                 };
                 stepLabel: {
                     confirmation: string;
@@ -663,6 +666,10 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                         title: string;
                         subtitle: string;
                     };
+                    unableToLoad: {
+                        title: string;
+                        subtitle: string;
+                    };
                 };
                 success: {
                     title: string;
@@ -684,9 +691,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
                     aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
                     aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
-                    aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string; /**
-                     * `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.
-                     */
+                    aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
                 };
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -860,6 +865,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     labelId: string;
                     externalOrderId: string;
                     externalShipmentId: string;
+                    shipmentNumber: string;
                 };
                 empty: {
                     title: string;
@@ -1194,6 +1200,9 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
+                    submittingOnboarding: string;
+                    submittingWarehouse: string;
+                    updatingPaymentMethod: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;

package/types/src/elements/select-label-layout/select-label-layout-element.d.ts

@@ -307,6 +307,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                 };
                 loading: {
                     calculatingRates: string;
+                    savingRate: string;
                 };
                 modes: {
                     browseRates: string;
@@ -380,12 +381,17 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
             };
             onboarding: {
                 title: string;
+                previouslyOnboarded: {
+                    title: string;
+                    subtitle: string;
+                };
                 confirmation: {
                     title: string;
                     warehouse: string;
                     billingAddress: string;
                     paymentMethod: string;
                     action: string;
+                    noPaymentMethod: string;
                 };
                 stepLabel: {
                     confirmation: string;
@@ -407,6 +413,10 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                         title: string;
                         subtitle: string;
                     };
+                    unableToLoad: {
+                        title: string;
+                        subtitle: string;
+                    };
                 };
                 success: {
                     title: string;
@@ -602,6 +612,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     labelId: string;
                     externalOrderId: string;
                     externalShipmentId: string;
+                    shipmentNumber: string;
                 };
                 empty: {
                     title: string;
@@ -929,6 +940,9 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
+                    submittingOnboarding: string;
+                    submittingWarehouse: string;
+                    updatingPaymentMethod: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;

package/types/src/elements/shipment-summary/shipment-summary.d.ts

@@ -400,6 +400,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 };
                 loading: {
                     calculatingRates: string;
+                    savingRate: string;
                 };
                 modes: {
                     browseRates: string;
@@ -473,12 +474,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
             };
             onboarding: {
                 title: string;
+                previouslyOnboarded: {
+                    title: string;
+                    subtitle: string;
+                };
                 confirmation: {
                     title: string;
                     warehouse: string;
                     billingAddress: string;
                     paymentMethod: string;
                     action: string;
+                    noPaymentMethod: string;
                 };
                 stepLabel: {
                     confirmation: string;
@@ -500,6 +506,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                         title: string;
                         subtitle: string;
                     };
+                    unableToLoad: {
+                        title: string;
+                        subtitle: string;
+                    };
                 };
                 success: {
                     title: string;
@@ -508,10 +518,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 };
                 termsAndAgreementLinkText: {
                     shipEngineToS: string;
-                    auctanePrivacyPolicy: string; /**
-                     * `onClickVoidLabel` is a callback function that will be invoked when the user clicks the
-                     * `Void Label` button.
-                     */
+                    auctanePrivacyPolicy: string;
                     aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
@@ -701,6 +708,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     labelId: string;
                     externalOrderId: string;
                     externalShipmentId: string;
+                    shipmentNumber: string;
                 };
                 empty: {
                     title: string;
@@ -715,6 +723,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     voided: string;
                     error: string;
                     completed: string;
+                    /**
+                     * `onClickPrintLabel` is a callback function that will be invoked when the user clicks the
+                     * `Print Label` button.
+                     */
                     processing: string;
                 };
                 trackingStatus: {
@@ -722,6 +734,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     inTransit: string;
                     in_transit: string;
                     delivered: string;
+                    /**
+                     * `onClickPurchaseLabel` is a callback function that will be invoked when the user clicks the
+                     * `Purchase Label` button.
+                     */
                     error: string;
                     voided: string;
                 };
@@ -1053,6 +1069,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
+                    submittingOnboarding: string;
+                    submittingWarehouse: string;
+                    updatingPaymentMethod: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;

package/types/src/elements/shipments-grid/shipments-grid.d.ts

@@ -341,9 +341,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                 };
                 errorTypes: {
                     results: string;
-                }; /**
-                 * `showCreatedDateFilter` controls the display of the Created Date filter
-                 */
+                };
                 fields: {
                     "requires-additional-handling": string;
                     addOns: string;
@@ -355,27 +353,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                         height: string;
                     };
                     dimensionsGroup: string;
-                    estimatedShipping: string; /**
-                     * # Shipments Grid Component
-                     *
-                     * - The `<ShipmentsGrid />` component is used to view the user's list of shipments.
-                     *
-                     * @param ShipmentsGridProps The base props that will be passed into the `<ShipmentsGrid />` component.
-                     *
-                     * @returns Element An EmotionJSX.Element that will render the `<ShipmentsGrid />` component.
-                     *
-                     * @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 ShipmentsGrid.Element | The **Element** created to render `<ShipmentsGrid />`}
-                     */
+                    estimatedShipping: string;
                     insurance: string;
                     insuranceProvider: string;
                     insuredValue: string;
@@ -401,6 +379,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                 };
                 loading: {
                     calculatingRates: string;
+                    savingRate: string;
                 };
                 modes: {
                     browseRates: string;
@@ -474,12 +453,17 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
             };
             onboarding: {
                 title: string;
+                previouslyOnboarded: {
+                    title: string;
+                    subtitle: string;
+                };
                 confirmation: {
                     title: string;
                     warehouse: string;
                     billingAddress: string;
                     paymentMethod: string;
                     action: string;
+                    noPaymentMethod: string;
                 };
                 stepLabel: {
                     confirmation: string;
@@ -501,6 +485,10 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                         title: string;
                         subtitle: string;
                     };
+                    unableToLoad: {
+                        title: string;
+                        subtitle: string;
+                    };
                 };
                 success: {
                     title: string;
@@ -509,9 +497,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                 };
                 termsAndAgreementLinkText: {
                     shipEngineToS: string;
-                    auctanePrivacyPolicy: string; /**
-                     * `onRowClick` callback invoked when a row is clicked.
-                     */
+                    auctanePrivacyPolicy: string;
                     aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
@@ -698,6 +684,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                     labelId: string;
                     externalOrderId: string;
                     externalShipmentId: string;
+                    shipmentNumber: string;
                 };
                 empty: {
                     title: string;
@@ -1025,6 +1012,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
+                    submittingOnboarding: string;
+                    submittingWarehouse: string;
+                    updatingPaymentMethod: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;

package/types/src/elements/theme-creator/theme-creator.d.ts

@@ -309,6 +309,7 @@ export declare const Element: ({ resources, ...props }: ConfigureThemeProps & im
                 };
                 loading: {
                     calculatingRates: string;
+                    savingRate: string;
                 };
                 modes: {
                     browseRates: string;
@@ -382,12 +383,17 @@ export declare const Element: ({ resources, ...props }: ConfigureThemeProps & im
             };
             onboarding: {
                 title: string;
+                previouslyOnboarded: {
+                    title: string;
+                    subtitle: string;
+                };
                 confirmation: {
                     title: string;
                     warehouse: string;
                     billingAddress: string;
                     paymentMethod: string;
                     action: string;
+                    noPaymentMethod: string;
                 };
                 stepLabel: {
                     confirmation: string;
@@ -409,6 +415,10 @@ export declare const Element: ({ resources, ...props }: ConfigureThemeProps & im
                         title: string;
                         subtitle: string;
                     };
+                    unableToLoad: {
+                        title: string;
+                        subtitle: string;
+                    };
                 };
                 success: {
                     title: string;
@@ -604,6 +614,7 @@ export declare const Element: ({ resources, ...props }: ConfigureThemeProps & im
                     labelId: string;
                     externalOrderId: string;
                     externalShipmentId: string;
+                    shipmentNumber: string;
                 };
                 empty: {
                     title: string;
@@ -931,6 +942,9 @@ export declare const Element: ({ resources, ...props }: ConfigureThemeProps & im
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
+                    submittingOnboarding: string;
+                    submittingWarehouse: string;
+                    updatingPaymentMethod: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;

package/types/src/elements/transaction-history/transaction-history-element.d.ts

@@ -307,6 +307,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                 };
                 loading: {
                     calculatingRates: string;
+                    savingRate: string;
                 };
                 modes: {
                     browseRates: string;
@@ -380,12 +381,17 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
             };
             onboarding: {
                 title: string;
+                previouslyOnboarded: {
+                    title: string;
+                    subtitle: string;
+                };
                 confirmation: {
                     title: string;
                     warehouse: string;
                     billingAddress: string;
                     paymentMethod: string;
                     action: string;
+                    noPaymentMethod: string;
                 };
                 stepLabel: {
                     confirmation: string;
@@ -407,6 +413,10 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                         title: string;
                         subtitle: string;
                     };
+                    unableToLoad: {
+                        title: string;
+                        subtitle: string;
+                    };
                 };
                 success: {
                     title: string;
@@ -602,6 +612,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     labelId: string;
                     externalOrderId: string;
                     externalShipmentId: string;
+                    shipmentNumber: string;
                 };
                 empty: {
                     title: string;
@@ -929,6 +940,9 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
+                    submittingOnboarding: string;
+                    submittingWarehouse: string;
+                    updatingPaymentMethod: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;

package/types/src/elements/unit-settings/unit-settings-element.d.ts

@@ -307,6 +307,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                 };
                 loading: {
                     calculatingRates: string;
+                    savingRate: string;
                 };
                 modes: {
                     browseRates: string;
@@ -380,12 +381,17 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
             };
             onboarding: {
                 title: string;
+                previouslyOnboarded: {
+                    title: string;
+                    subtitle: string;
+                };
                 confirmation: {
                     title: string;
                     warehouse: string;
                     billingAddress: string;
                     paymentMethod: string;
                     action: string;
+                    noPaymentMethod: string;
                 };
                 stepLabel: {
                     confirmation: string;
@@ -407,6 +413,10 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                         title: string;
                         subtitle: string;
                     };
+                    unableToLoad: {
+                        title: string;
+                        subtitle: string;
+                    };
                 };
                 success: {
                     title: string;
@@ -602,6 +612,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     labelId: string;
                     externalOrderId: string;
                     externalShipmentId: string;
+                    shipmentNumber: string;
                 };
                 empty: {
                     title: string;
@@ -929,6 +940,9 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
+                    submittingOnboarding: string;
+                    submittingWarehouse: string;
+                    updatingPaymentMethod: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;

package/types/src/elements/vat-settings/vat-settings-element.d.ts

@@ -307,6 +307,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                 };
                 loading: {
                     calculatingRates: string;
+                    savingRate: string;
                 };
                 modes: {
                     browseRates: string;
@@ -380,12 +381,17 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
             };
             onboarding: {
                 title: string;
+                previouslyOnboarded: {
+                    title: string;
+                    subtitle: string;
+                };
                 confirmation: {
                     title: string;
                     warehouse: string;
                     billingAddress: string;
                     paymentMethod: string;
                     action: string;
+                    noPaymentMethod: string;
                 };
                 stepLabel: {
                     confirmation: string;
@@ -407,6 +413,10 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                         title: string;
                         subtitle: string;
                     };
+                    unableToLoad: {
+                        title: string;
+                        subtitle: string;
+                    };
                 };
                 success: {
                     title: string;
@@ -602,6 +612,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     labelId: string;
                     externalOrderId: string;
                     externalShipmentId: string;
+                    shipmentNumber: string;
                 };
                 empty: {
                     title: string;
@@ -929,6 +940,9 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
+                    submittingOnboarding: string;
+                    submittingWarehouse: string;
+                    updatingPaymentMethod: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;

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

@@ -407,6 +407,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 };
                 loading: {
                     calculatingRates: string;
+                    savingRate: string;
                 };
                 modes: {
                     browseRates: string;
@@ -480,12 +481,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
             };
             onboarding: {
                 title: string;
+                previouslyOnboarded: {
+                    title: string;
+                    subtitle: string;
+                };
                 confirmation: {
                     title: string;
                     warehouse: string;
                     billingAddress: string;
                     paymentMethod: string;
                     action: string;
+                    noPaymentMethod: string;
                 };
                 stepLabel: {
                     confirmation: string;
@@ -507,6 +513,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                         title: string;
                         subtitle: string;
                     };
+                    unableToLoad: {
+                        title: string;
+                        subtitle: string;
+                    };
                 };
                 success: {
                     title: string;
@@ -515,10 +525,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 };
                 termsAndAgreementLinkText: {
                     shipEngineToS: string;
-                    auctanePrivacyPolicy: string; /**
-                     * `onSuccess` is a callback function that will be invoked when the request to void a given
-                     * shipping label is successful.
-                     */
+                    auctanePrivacyPolicy: string;
                     aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
@@ -705,6 +712,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     labelId: string;
                     externalOrderId: string;
                     externalShipmentId: string;
+                    shipmentNumber: string;
                 };
                 empty: {
                     title: string;
@@ -1032,6 +1040,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
+                    submittingOnboarding: string;
+                    submittingWarehouse: string;
+                    updatingPaymentMethod: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;

package/types/src/features/manage-carriers/manage-carriers.styles.d.ts

@@ -5,6 +5,8 @@ export declare const styles: {
         };
         border: string;
         borderRadius: string;
+        display: "flex";
+        flexDirection: "column";
         listStyle: "none";
     };
 };