@shipengine/elements 2.9.0 → 2.10.0

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

@@ -246,6 +246,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     showItems: string;
                     void: string;
                     download: string;
+                    fileClaim: string;
                 };
                 fields: {
                     dimensions: string;
@@ -261,6 +262,20 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     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: {
@@ -303,12 +318,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
             };
             "register-wallet": {
                 sections: {
-                    setup: {
-                        title: string;
-                        subtitle: string;
-                        descriptionTitle: string;
-                        description: string;
-                    };
                     billing: {
                         title: string;
                         cardSubTitle: string;
@@ -321,6 +330,17 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         title: string;
                         subtitle: string;
                     };
+                    insuranceProviders: {
+                        parcelguard: {
+                            description: string;
+                            terms: string;
+                            termsLink: string;
+                            popover: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
                     notifications: {
                         error: {
                             title: string;
@@ -415,6 +435,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 };
                 cta: {
                     addPackageDetails: string;
+                    parcelguard: string;
                 };
                 errorMessages: {
                     customsItemsRequired: string;
@@ -450,14 +471,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     requestedShipping: string;
                     shipDate: string;
                     service: string;
-                    /**
-                     *  `onApplyPreset` is an async/sync callback function that will be invoked each time a `Preset`
-                     *  has been applied to a shipment.
-                     */
                     shipTo: string;
                     addShipToAddress: string;
                     warehouse: string;
                     weight: {
+                        /**
+                         * `onBeforeLabelCreate` is an async/sync callback function that will be invoked before every
+                         * label purchase.
+                         */
                         whole: string;
                         fractional: string;
                     };
@@ -489,6 +510,24 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     dhlExpressTermsAcknowledgement: string;
                     noRateService: string;
                 };
+                windsorFramework: {
+                    movementIndicator: string;
+                    movementIndicators: {
+                        b2c: string;
+                        c2b: string;
+                        c2c: string;
+                        b2b: string;
+                    }; /**
+                     * `onRatesCalculated` is an async/sync callback function that will be invoked each time rates
+                     * are calculated for a given shipment.
+                     */
+                    notAtRisk: string;
+                    notAtRiskShipmentTootip: 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.
+                 */
                 requirements: {
                     noWarehouse: string;
                     noCarrier: string;
@@ -519,6 +558,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 shipToAddressFormFields: string;
                 sections: {
                     customsForm: string;
+                    windsorFramework: string;
                     shipment: string;
                     rate_one: string;
                     rate_other: string;
@@ -543,6 +583,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
                 };
+                termsAgreement: {
+                    title: string;
+                    subtitle: string;
+                };
                 warehouse: {
                     title: string;
                     subtitle: string;
@@ -576,10 +620,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
                     aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
                 };
-                /**
-                 * `onBeforeRateSave` is an async/sync callback function that will be invoked before each time a user
-                 * saves a rate.
-                 */
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
                     "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
@@ -830,6 +870,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     continue: string;
                     delete: string;
                     edit: string;
+                    enable: string;
                     hide: string;
                     parse: string;
                     purchase: string;
@@ -906,7 +947,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         message: string;
                     };
                     address: {
-                        message: string;
+                        message: string; /**
+                         * `onChangeAddress` is an async/sync callback function that will be invoked each time a
+                         * `Ship To Address` or `Ship From Address` has been updated.
+                         */
                         title: string;
                     };
                 };
@@ -923,12 +967,11 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     addDeclaration: string;
                     noResults: string;
                     contents: {
-                        documents: string;
-                        gift: string;
-                        /**
+                        documents: string; /**
                          * `onLabelCreateFailure` is an async/sync callback function that will be invoked each time a
                          * label purchase fails.
                          */
+                        gift: string;
                         merchandise: string;
                         returnedGoods: string;
                         sample: string;
@@ -937,10 +980,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         sectionTitle: string;
                         addTaxId: string;
                         sectionTitleTooltip: string;
-                        entityTypeTooltipText: 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)
-                         */
+                        entityTypeTooltipText: string;
                         entityTypeTooltipPointOne: string;
                         entityTypeTooltipPointTwo: string;
                     };
@@ -958,6 +998,12 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
                         quantity: string;
+                        /**
+                         * `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.
+                         */
                         sku: string;
                         value: string;
                         valueQuantity: string;
@@ -997,6 +1043,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    windsorFramework: {
+                        doNotConform: string;
+                        pleaseAddTheFollowingTaxIds: string;
+                        windsorFrameworkDefaultMessage: string;
+                        shipperEori: string;
+                        recipientEori: string;
+                        ukims: string;
+                    };
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -1010,6 +1064,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     system: string;
                     unknown: string;
                     validation: string;
+                    windsorFramework: string;
                 };
                 grid: {
                     "row-count_one": string;
@@ -1036,8 +1091,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 insuranceProviders: {
                     carrier: string;
                     none: string;
+                    parcelguard: string;
                     shipsurance: string;
                     thirdParty: string;
+                    x_cover: string;
                 };
                 loading: {
                     accountSettings: string;
@@ -1115,6 +1172,9 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     platform: string;
                     user: string;
                 };
+                tags: {
+                    new: string;
+                };
                 terms: {
                     fields: {
                         agreement: string;
@@ -1122,6 +1182,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    insuranceProvidersTitle: string;
                     shipEngineTitle: string;
                 };
                 weight: {

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

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { SE } from "@shipengine/react-api";
+import { ShipmentProps } from "../../components/templates/shipment";
 import { ShipmentSummaryFeatures } from "../../utilities";
 /**
  * # Shipment Summary Component Props
@@ -17,17 +17,17 @@ export type ComponentProps = {
      * `onClickPrintLabel` is a callback function that will be invoked when the user clicks the
      * `Print Label` button.
      */
-    onClickPrintLabel?: () => void;
+    onClickPrintLabel?: ShipmentProps["onClickPrintLabel"];
     /**
      * `onClickPurchaseLabel` is a callback function that will be invoked when the user clicks the
      * `Purchase Label` button.
      */
-    onClickPurchaseLabel?: (order: SE.SalesOrder) => void;
+    onClickPurchaseLabel?: ShipmentProps["onClickPurchaseLabel"];
     /**
      * `onClickVoidLabel` is a callback function that will be invoked when the user clicks the
      * `Void Label` button.
      */
-    onClickVoidLabel?: (label: SE.Label) => void;
+    onClickVoidLabel?: ShipmentProps["onClickVoidLabel"];
     /**
      * `shipmentId` is the unique identifier for the shipment you wish to view.
      */
@@ -146,6 +146,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     showItems: string;
                     void: string;
                     download: string;
+                    fileClaim: string;
                 };
                 fields: {
                     dimensions: string;
@@ -161,6 +162,20 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     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: {
@@ -203,12 +218,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "register-wallet": {
                 sections: {
-                    setup: {
-                        title: string;
-                        subtitle: string;
-                        descriptionTitle: string;
-                        description: string;
-                    };
                     billing: {
                         title: string;
                         cardSubTitle: string;
@@ -221,13 +230,27 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                         subtitle: string;
                     };
+                    insuranceProviders: {
+                        parcelguard: {
+                            description: string;
+                            terms: string;
+                            termsLink: string;
+                            popover: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
                     notifications: {
                         error: {
                             title: string;
                         };
                         info: {
                             description: string;
-                        };
+                        }; /**
+                         * `onClickVoidLabel` is a callback function that will be invoked when the user clicks the
+                         * `Void Label` button.
+                         */
                         poBox: {
                             title: string;
                             description: string;
@@ -287,9 +310,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     oversize: string;
                     returns: string;
                     notifications: string;
-                    tip: string; /**
-                     * `features` is a set of feature flags you would like to enable or disable in this component.
-                     */
+                    tip: string;
                     duties_and_taxes: string;
                     brokerage_fee: string;
                     admin_fee: string;
@@ -317,6 +338,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 cta: {
                     addPackageDetails: string;
+                    parcelguard: string;
                 };
                 errorMessages: {
                     customsItemsRequired: string;
@@ -387,6 +409,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     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;
@@ -417,6 +450,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 shipToAddressFormFields: string;
                 sections: {
                     customsForm: string;
+                    windsorFramework: string;
                     shipment: string;
                     rate_one: string;
                     rate_other: string;
@@ -441,6 +475,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
                 };
+                termsAgreement: {
+                    title: string;
+                    subtitle: string;
+                };
                 warehouse: {
                     title: string;
                     subtitle: string;
@@ -527,6 +565,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     lowBalancePurchaseThreshold: string;
                     maximumPurchasesPerDay: string;
                     purchaseAmount: string;
+                    /**
+                     * `features` is a set of feature flags you would like to enable or disable in this component.
+                     */
                     readSettings: string;
                 };
                 addFunds: {
@@ -615,13 +656,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     readyToBuy: string;
                     processing: string;
                 };
-                /**
-                 * # Shipment Summary Component Props
-                 *
-                 * - These are the base props that will be passed into the `<ShipmentSummary />` component.
-                 *
-                 * @see {@link ShipmentSummary.Component | This prop types usage in the `<ShipmentSummary />` component}
-                 */
                 actions: {
                     download: {
                         pdf: string;
@@ -638,7 +672,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     title: string;
                     subtitle: string;
                 };
-            };
+            }; /**
+             * `onClickPurchaseLabel` is a callback function that will be invoked when the user clicks the
+             * `Purchase Label` button.
+             */
             "list-labels": {
                 title: string;
                 headers: {
@@ -677,11 +714,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     title: string;
                     print: string;
                     void: string;
-                    /**
+                    printForms: string; /**
                      * `onClickPurchaseLabel` is a callback function that will be invoked when the user clicks the
                      * `Purchase Label` button.
                      */
-                    printForms: string;
                 };
                 errorMessages: {
                     title: string;
@@ -728,6 +764,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     continue: string;
                     delete: string;
                     edit: string;
+                    enable: string;
                     hide: string;
                     parse: string;
                     purchase: string;
@@ -766,11 +803,34 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         modified: string;
                         title: string;
                         originalAddress: string;
-                        matchedAddress: string; /**
-                         * `shipmentId` is the unique identifier for the shipment you wish to view.
-                         */
+                        matchedAddress: string;
                         unableToValidate: string;
                         use: {
+                            /**
+                             * # Shipment Summary Component
+                             *
+                             * - The `<ShipmentSummary />` component is used to for viewing the shipment's tracking number, printing the label that
+                             * was created, and the option to void the label. When a label is voided, you can see a list of the
+                             * previously voided labels for a given shipment using this component.
+                             *
+                             * @param ComponentProps The base props that will be passed into the `<ShipmentSummary />` component.
+                             *
+                             * @returns Element An EmotionJSX.Element that will render the `<ShipmentSummary />` 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 ShipmentSummary.Element | The **Element** created to render `<ShipmentSummary />`}
+                             */
                             originalAddress: string;
                             matchedAddress: string;
                         };
@@ -890,6 +950,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    windsorFramework: {
+                        doNotConform: string;
+                        pleaseAddTheFollowingTaxIds: string;
+                        windsorFrameworkDefaultMessage: string;
+                        shipperEori: string;
+                        recipientEori: string;
+                        ukims: string;
+                    };
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -903,6 +971,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     system: string;
                     unknown: string;
                     validation: string;
+                    windsorFramework: string;
                 };
                 grid: {
                     "row-count_one": string;
@@ -929,8 +998,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 insuranceProviders: {
                     carrier: string;
                     none: string;
+                    parcelguard: string;
                     shipsurance: string;
                     thirdParty: string;
+                    x_cover: string;
                 };
                 loading: {
                     accountSettings: string;
@@ -1008,6 +1079,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     platform: string;
                     user: string;
                 };
+                tags: {
+                    new: string;
+                };
                 terms: {
                     fields: {
                         agreement: string;
@@ -1015,6 +1089,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    insuranceProvidersTitle: string;
                     shipEngineTitle: string;
                 };
                 weight: {

package/src/elements/shipments-grid/hooks/use-shipments-grid.d.ts

@@ -14,6 +14,7 @@ export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter,
             billToCountryCode?: string | undefined;
             billToParty?: SE.BillToParties | undefined;
             billToPostalCode?: string | undefined;
+            canadaDeliveredDuty?: "sender_prepay" | null | undefined;
             collectOnDelivery?: {
                 paymentAmount: SE.Money;
                 paymentType: SE.PaymentTypes;
@@ -40,6 +41,7 @@ export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter,
             shipperRelease?: boolean | undefined;
             thirdPartyConsignee?: boolean | undefined;
             useUpsGroundFreightPricing?: boolean | undefined;
+            windsorFrameworkDetails?: SE.WindsorFrameworkDetails | undefined;
         } | undefined;
         carrierId: string;
         comparisonRateType?: string | undefined;
@@ -99,6 +101,7 @@ export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter,
             billToCountryCode?: string | undefined;
             billToParty?: SE.BillToParties | undefined;
             billToPostalCode?: string | undefined;
+            canadaDeliveredDuty?: "sender_prepay" | null | undefined;
             collectOnDelivery?: {
                 paymentAmount: SE.Money;
                 paymentType: SE.PaymentTypes;
@@ -125,6 +128,7 @@ export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter,
             shipperRelease?: boolean | undefined;
             thirdPartyConsignee?: boolean | undefined;
             useUpsGroundFreightPricing?: boolean | undefined;
+            windsorFrameworkDetails?: SE.WindsorFrameworkDetails | undefined;
         } | undefined;
         carrierId: string;
         comparisonRateType?: string | undefined;