@shipengine/elements 2.9.1 → 2.11.0

package/src/elements/labels-grid/labels-grid.d.ts

@@ -1,6 +1,12 @@
 /// <reference types="react" />
 import { SE } from "@shipengine/js-api";
+import { LabelsGridFeatures } from "../../utilities";
 export type LabelsGridProps = {
+    /**
+     * `features` provides optional feature configuration for the Element
+     * If no value is defined, default configuration will be used.
+     */
+    features?: LabelsGridFeatures;
     /**
      * `labelStatus` is the status of the labels you wish to view.
      * If no value is defined, all labels will be rendered.
@@ -30,16 +36,8 @@ export type LabelsGridProps = {
      * `onRowClick` callback invoked when a row is clicked.
      */
     onRowClick?: (label: SE.Label) => void;
-    /**
-     * `showLabelIdFilter` controls the display of the label Id search filter
-     */
-    showLabelIdFilter?: boolean;
-    /**
-     * `showShipmentIdFilter` controls the display of the shipmentId search filter
-     */
-    showShipmentIdFilter?: boolean;
 };
-export declare const Component: ({ labelStatus, showShipmentIdFilter, showLabelIdFilter, onClickPrintLabel, onClickVoidLabel, onClickPrintForms, onClickViewDetails, onRowClick, }: LabelsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ labelStatus, features, onClickPrintLabel, onClickVoidLabel, onClickPrintForms, onClickViewDetails, onRowClick, }: LabelsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export declare const Element: ({ resources, ...props }: LabelsGridProps & {
     resources?: {
         en: {
@@ -97,6 +95,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     showItems: string;
                     void: string;
                     download: string;
+                    fileClaim: string;
                 };
                 fields: {
                     dimensions: string;
@@ -112,10 +111,26 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     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;
+                    labels: string; /**
+                     * `onRowClick` callback invoked when a row is clicked.
+                     */
                     shipmentSummary: string;
                 };
                 noLabels: string;
@@ -154,12 +169,6 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
             };
             "register-wallet": {
                 sections: {
-                    setup: {
-                        title: string;
-                        subtitle: string;
-                        descriptionTitle: string;
-                        description: string;
-                    };
                     billing: {
                         title: string;
                         cardSubTitle: string;
@@ -172,6 +181,17 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         title: string;
                         subtitle: string;
                     };
+                    insuranceProviders: {
+                        parcelguard: {
+                            description: string;
+                            terms: string;
+                            termsLink: string;
+                            popover: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
                     notifications: {
                         error: {
                             title: string;
@@ -236,10 +256,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     pickup: string;
                     location_fee: string;
                     oversize: string;
-                    returns: string; /**
-                     * `labelStatus` is the status of the labels you wish to view.
-                     * If no value is defined, all labels will be rendered.
-                     */
+                    returns: string;
                     notifications: string;
                     tip: string;
                     duties_and_taxes: string;
@@ -249,7 +266,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     auctane_service_fee: string;
                     product_price: string;
                 };
-            };
+            }; /**
+             * `labelStatus` is the status of the labels you wish to view.
+             * If no value is defined, all labels will be rendered.
+             */
             "purchase-label": {
                 title: string;
                 actions: {
@@ -269,9 +289,13 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                 };
                 cta: {
                     addPackageDetails: string;
+                    parcelguard: string;
                 };
                 errorMessages: {
-                    customsItemsRequired: string;
+                    customsItemsRequired: string; /**
+                     * `features` provides optional feature configuration for the Element
+                     * If no value is defined, default configuration will be used.
+                     */
                     invalidAddress: string;
                     noRates: string;
                     salesOrderNotLoaded: string;
@@ -339,6 +363,17 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     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;
@@ -369,6 +404,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                 shipToAddressFormFields: string;
                 sections: {
                     customsForm: string;
+                    windsorFramework: string;
                     shipment: string;
                     rate_one: string;
                     rate_other: string;
@@ -393,6 +429,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
                 };
+                termsAgreement: {
+                    title: string;
+                    subtitle: string;
+                };
                 warehouse: {
                     title: string;
                     subtitle: string;
@@ -401,10 +441,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                 errors: {
                     noCarriers: {
                         title: string;
-                        subtitle: string; /**
-                         * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
-                         * `Print Forms` button.
-                         */
+                        subtitle: string;
                     };
                 };
                 success: {
@@ -502,7 +539,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     insufficientFunds: string;
                     insufficientFundsTitle: string;
                     negativeBalance: string;
-                    negativeBalanceTitle: string;
+                    negativeBalanceTitle: string; /**
+                     * `onClickVoidLabel` is a callback function that controls the display of `Void Label` button and
+                     *  will be invoked when the user clicks on it.
+                     */
                     newBalance: string;
                 };
                 errors: {
@@ -622,7 +662,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     error: string;
                 };
                 actions: {
-                    title: string;
+                    title: string; /**
+                     * `labelStatus` is the status of the labels you wish to view.
+                     * If no value is defined, all labels will be rendered.
+                     */
                     print: string;
                     void: string;
                     printForms: string;
@@ -672,6 +715,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     continue: string;
                     delete: string;
                     edit: string;
+                    enable: string;
                     hide: string;
                     parse: string;
                     purchase: string;
@@ -714,9 +758,6 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         unableToValidate: string;
                         use: {
                             originalAddress: string;
-                            /**
-                             * `onRowClick` callback invoked when a row is clicked.
-                             */
                             matchedAddress: string;
                         };
                     };
@@ -835,6 +876,14 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    windsorFramework: {
+                        doNotConform: string;
+                        pleaseAddTheFollowingTaxIds: string;
+                        windsorFrameworkDefaultMessage: string;
+                        shipperEori: string;
+                        recipientEori: string;
+                        ukims: string;
+                    };
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -848,6 +897,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     system: string;
                     unknown: string;
                     validation: string;
+                    windsorFramework: string;
                 };
                 grid: {
                     "row-count_one": string;
@@ -874,8 +924,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                 insuranceProviders: {
                     carrier: string;
                     none: string;
+                    parcelguard: string;
                     shipsurance: string;
                     thirdParty: string;
+                    x_cover: string;
                 };
                 loading: {
                     accountSettings: string;
@@ -953,6 +1005,9 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     platform: string;
                     user: string;
                 };
+                tags: {
+                    new: string;
+                };
                 terms: {
                     fields: {
                         agreement: string;
@@ -960,6 +1015,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    insuranceProvidersTitle: string;
                     shipEngineTitle: string;
                 };
                 weight: {
@@ -1016,13 +1072,13 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string; /**
-                     * `labelStatus` is the status of the labels you wish to view.
-                     * If no value is defined, all labels will be rendered.
-                     */
+                    carriers: string;
                     externalCarriers: string;
                     labelLayout: string;
-                    unitSettings: string;
+                    unitSettings: string; /**
+                     * `features` provides optional feature configuration for the Element
+                     * If no value is defined, default configuration will be used.
+                     */
                     vatSettings: string;
                 };
             };

package/src/elements/manage-carriers/manage-carriers.d.ts

@@ -81,6 +81,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     showItems: string;
                     void: string;
                     download: string;
+                    fileClaim: string;
                 };
                 fields: {
                     dimensions: string;
@@ -96,6 +97,20 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     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: {
@@ -138,12 +153,6 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
             };
             "register-wallet": {
                 sections: {
-                    setup: {
-                        title: string;
-                        subtitle: string;
-                        descriptionTitle: string;
-                        description: string;
-                    };
                     billing: {
                         title: string;
                         cardSubTitle: string;
@@ -156,6 +165,17 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                         title: string;
                         subtitle: string;
                     };
+                    insuranceProviders: {
+                        parcelguard: {
+                            description: string;
+                            terms: string;
+                            termsLink: string;
+                            popover: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
                     notifications: {
                         error: {
                             title: string;
@@ -272,6 +292,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                 };
                 cta: {
                     addPackageDetails: string;
+                    parcelguard: string;
                 };
                 errorMessages: {
                     customsItemsRequired: string;
@@ -342,6 +363,17 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     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;
@@ -372,6 +404,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                 shipToAddressFormFields: string;
                 sections: {
                     customsForm: string;
+                    windsorFramework: string;
                     shipment: string;
                     rate_one: string;
                     rate_other: string;
@@ -396,6 +429,10 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
                 };
+                termsAgreement: {
+                    title: string;
+                    subtitle: string;
+                };
                 warehouse: {
                     title: string;
                     subtitle: string;
@@ -694,6 +731,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                      * @see {@link ManageCarriers.ComponentProps | The props that are passed into the `<ManageCarriers />` component}
                      * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<ManageCarriers />` component}
                      */
+                    enable: string;
                     hide: string;
                     parse: string;
                     purchase: string;
@@ -854,6 +892,14 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    windsorFramework: {
+                        doNotConform: string;
+                        pleaseAddTheFollowingTaxIds: string;
+                        windsorFrameworkDefaultMessage: string;
+                        shipperEori: string;
+                        recipientEori: string;
+                        ukims: string;
+                    };
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -867,6 +913,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     system: string;
                     unknown: string;
                     validation: string;
+                    windsorFramework: string;
                 };
                 grid: {
                     "row-count_one": string;
@@ -893,8 +940,10 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                 insuranceProviders: {
                     carrier: string;
                     none: string;
+                    parcelguard: string;
                     shipsurance: string;
                     thirdParty: string;
+                    x_cover: string;
                 };
                 loading: {
                     accountSettings: string;
@@ -972,6 +1021,9 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     platform: string;
                     user: string;
                 };
+                tags: {
+                    new: string;
+                };
                 terms: {
                     fields: {
                         agreement: string;
@@ -979,6 +1031,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    insuranceProvidersTitle: string;
                     shipEngineTitle: string;
                 };
                 weight: {

package/src/elements/manage-external-carriers/manage-external-carriers.d.ts

@@ -103,6 +103,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                      */
                     void: string;
                     download: string;
+                    fileClaim: string;
                 };
                 fields: {
                     dimensions: string;
@@ -118,6 +119,20 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     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: {
@@ -160,33 +175,6 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
             };
             "register-wallet": {
                 sections: {
-                    setup: {
-                        title: string;
-                        subtitle: string;
-                        descriptionTitle: string;
-                        description: string;
-                    }; /**
-                     * # ManageExternalCarriers Element
-                     *
-                     * @param ComponentProps The base props that will be passed into the `<ManageExternalCarriers />` component.
-                     *
-                     * @returns Element A React element that renders the `<ManageExternalCarriers />` component allowing users
-                     * to view a list of their own carrier accounts that have been connected to their ShipEngine account,
-                     * and to add additional carriers.
-                     * This component is composed in the `<AccountSettings />` Element.
-                     *
-                     * @example
-                     * ```tsx
-                     * (() => {
-                     *   return <ManageExternalCarriers.Element isModalFullScreen={false} />;
-                     * })();
-                     * ```
-                     *
-                     * <br />
-                     *
-                     * @see {@link ManageExternalCarriers.ComponentProps | The props that are passed into the `<ManageExternalCarriers />` component}
-                     * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<ManageExternalCarriers />` component}
-                     */
                     billing: {
                         title: string;
                         cardSubTitle: string;
@@ -196,9 +184,42 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                         title: string;
                     };
                     carriers: {
+                        /**
+                         * # ManageExternalCarriers Element
+                         *
+                         * @param ComponentProps The base props that will be passed into the `<ManageExternalCarriers />` component.
+                         *
+                         * @returns Element A React element that renders the `<ManageExternalCarriers />` component allowing users
+                         * to view a list of their own carrier accounts that have been connected to their ShipEngine account,
+                         * and to add additional carriers.
+                         * This component is composed in the `<AccountSettings />` Element.
+                         *
+                         * @example
+                         * ```tsx
+                         * (() => {
+                         *   return <ManageExternalCarriers.Element isModalFullScreen={false} />;
+                         * })();
+                         * ```
+                         *
+                         * <br />
+                         *
+                         * @see {@link ManageExternalCarriers.ComponentProps | The props that are passed into the `<ManageExternalCarriers />` component}
+                         * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<ManageExternalCarriers />` component}
+                         */
                         title: string;
                         subtitle: string;
                     };
+                    insuranceProviders: {
+                        parcelguard: {
+                            description: string;
+                            terms: string;
+                            termsLink: string;
+                            popover: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
                     notifications: {
                         error: {
                             title: string;
@@ -293,6 +314,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                 };
                 cta: {
                     addPackageDetails: string;
+                    parcelguard: string;
                 };
                 errorMessages: {
                     customsItemsRequired: string;
@@ -363,6 +385,17 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     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;
@@ -393,6 +426,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                 shipToAddressFormFields: string;
                 sections: {
                     customsForm: string;
+                    windsorFramework: string;
                     shipment: string;
                     rate_one: string;
                     rate_other: string;
@@ -417,6 +451,10 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
                 };
+                termsAgreement: {
+                    title: string;
+                    subtitle: string;
+                };
                 warehouse: {
                     title: string;
                     subtitle: string;
@@ -693,6 +731,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     continue: string;
                     delete: string;
                     edit: string;
+                    enable: string;
                     hide: string;
                     parse: string;
                     purchase: string;
@@ -853,6 +892,14 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    windsorFramework: {
+                        doNotConform: string;
+                        pleaseAddTheFollowingTaxIds: string;
+                        windsorFrameworkDefaultMessage: string;
+                        shipperEori: string;
+                        recipientEori: string;
+                        ukims: string;
+                    };
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -866,6 +913,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     system: string;
                     unknown: string;
                     validation: string;
+                    windsorFramework: string;
                 };
                 grid: {
                     "row-count_one": string;
@@ -892,8 +940,10 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                 insuranceProviders: {
                     carrier: string;
                     none: string;
+                    parcelguard: string;
                     shipsurance: string;
                     thirdParty: string;
+                    x_cover: string;
                 };
                 loading: {
                     accountSettings: string;
@@ -971,6 +1021,9 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     platform: string;
                     user: string;
                 };
+                tags: {
+                    new: string;
+                };
                 terms: {
                     fields: {
                         agreement: string;
@@ -978,6 +1031,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    insuranceProvidersTitle: string;
                     shipEngineTitle: string;
                 };
                 weight: {