@shipengine/elements 2.11.1 → 2.13.0

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

@@ -6,6 +6,11 @@ import { SE } from "@shipengine/js-api";
  * @see {@link ShipmentsGrid.Element | This prop types usage in `<ShipmentsGrid />`}
  */
 export type ShipmentsGridProps = {
+    /**
+     * `onClickCancelShipment` is a callback function that controls the display of `Cancel shipment` option and
+     *  will be invoked when the user clicks on it.
+     */
+    onClickCancelShipment?: (shipment: SE.Shipment) => void;
     /**
      * `onRowClick` callback invoked when a row is clicked.
      */
@@ -45,7 +50,7 @@ export type ShipmentsGridProps = {
  *
  * @see {@link ShipmentsGrid.Element | The **Element** created to render `<ShipmentsGrid />`}
  */
-export declare const Component: ({ onRowClick, shipmentStatus, showShipmentIdFilter, showCreatedDateFilter, }: ShipmentsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ onRowClick, onClickCancelShipment, shipmentStatus, showShipmentIdFilter, showCreatedDateFilter, }: ShipmentsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
  * # Registered Shipments Grid Element
  *
@@ -99,6 +104,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -177,6 +183,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     forbidden: string;
                     connectionNotSupported: string;
                     genericTitle: string;
+                    /**
+                     * `onRowClick` callback invoked when a row is clicked.
+                     */
                     genericText: string;
                 };
             };
@@ -282,11 +291,6 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     special_goods: string;
                     pickup: string;
                     location_fee: string;
-                    /**
-                     * # Shipments Grid Props
-                     *
-                     * @see {@link ShipmentsGrid.Element | This prop types usage in `<ShipmentsGrid />`}
-                     */
                     oversize: string;
                     returns: string;
                     notifications: string;
@@ -335,6 +339,27 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 fields: {
                     "requires-additional-handling": string;
                     addOns: 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 />`}
+                     */
                     contentDescription: string;
                     confirmation: string;
                     dimensions: {
@@ -461,6 +486,11 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 };
                 warehouse: {
                     title: string;
+                    /**
+                     * # Shipments Grid Props
+                     *
+                     * @see {@link ShipmentsGrid.Element | This prop types usage in `<ShipmentsGrid />`}
+                     */
                     subtitle: string;
                     inlineMessage: string;
                 };
@@ -478,7 +508,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 termsAndAgreementLinkText: {
                     shipEngineToS: string;
                     auctanePrivacyPolicy: string;
-                    aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
+                    aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string; /**
+                     * `showShipmentIdFilter` controls the display of the shipmentId search filter
+                     */
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
                     "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
@@ -608,9 +640,6 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         metric: string;
                     };
                     weight: {
-                        /**
-                         * `onRowClick` callback invoked when a row is clicked.
-                         */
                         title: string;
                         standard: string;
                         g: string;
@@ -650,9 +679,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 };
                 errorMessages: {
                     title: string;
-                    subtitle: string; /**
-                     * `showCreatedDateFilter` controls the display of the Created Date filter
-                     */
+                    subtitle: string;
                 };
             };
             "list-labels": {
@@ -667,6 +694,8 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -678,7 +707,10 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     button: string;
                 };
                 status: {
-                    voided: string;
+                    voided: string; /**
+                     * `onClickCancelShipment` is a callback function that controls the display of `Cancel shipment` option and
+                     *  will be invoked when the user clicks on it.
+                     */
                     error: string;
                     completed: string;
                     processing: string;
@@ -717,11 +749,13 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 search: string;
                 settingsModal: {
                     closeDialog: string;
-                    header: string; /**
-                     * `onRowClick` callback invoked when a row is clicked.
-                     */
+                    header: string;
                 };
                 status: {
+                    /**
+                     * `onClickCancelShipment` is a callback function that controls the display of `Cancel shipment` option and
+                     *  will be invoked when the user clicks on it.
+                     */
                     connected: string;
                 };
                 disconnectDropdown: {
@@ -762,7 +796,10 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         addressLine2: string;
                         cityLocality: string;
                         stateProvince: string;
-                        postalCode: string;
+                        postalCode: string; /**
+                         * `onClickCancelShipment` is a callback function that controls the display of `Cancel shipment` option and
+                         *  will be invoked when the user clicks on it.
+                         */
                         phone: string;
                         email: string;
                         addressResidentialIndicator: string;
@@ -781,7 +818,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         modified: string;
                         title: string;
                         originalAddress: string;
-                        matchedAddress: string;
+                        matchedAddress: string; /**
+                         * `showShipmentIdFilter` controls the display of the shipmentId search filter
+                         */
                         unableToValidate: string;
                         use: {
                             originalAddress: string;
@@ -789,7 +828,27 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         };
                     };
                     validation: {
-                        notValidated: string;
+                        notValidated: 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 />`}
+                         */
                         validated: string;
                     };
                 };
@@ -863,6 +922,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: string;
                         quantity: string;
                         sku: string;
                         value: string;
@@ -877,6 +937,17 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        recipientPays: string;
+                        tooltip: {
+                            title: string;
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
                     removeAllDeclarations: string;
                     total: string;
                 };
@@ -1026,6 +1097,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -1069,6 +1143,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1099,7 +1174,12 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;

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

@@ -45,6 +45,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -603,6 +604,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -797,6 +800,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: string;
                         quantity: string;
                         sku: string;
                         value: string;
@@ -811,6 +815,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        recipientPays: string;
+                        tooltip: {
+                            title: string;
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
                     removeAllDeclarations: string;
                     total: string;
                 };
@@ -960,6 +975,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -1003,6 +1021,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1033,7 +1052,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;

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

@@ -32,6 +32,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -590,6 +591,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -784,6 +787,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: string;
                         quantity: string;
                         sku: string;
                         value: string;
@@ -798,6 +802,17 @@ export declare const Element: ({ resources, ...props }: object & {
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        recipientPays: string;
+                        tooltip: {
+                            title: string;
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
                     removeAllDeclarations: string;
                     total: string;
                 };
@@ -947,6 +962,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -990,6 +1008,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1020,7 +1039,12 @@ export declare const Element: ({ resources, ...props }: object & {
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;

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

@@ -32,6 +32,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -590,6 +591,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -784,6 +787,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: string;
                         quantity: string;
                         sku: string;
                         value: string;
@@ -798,6 +802,17 @@ export declare const Element: ({ resources, ...props }: object & {
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        recipientPays: string;
+                        tooltip: {
+                            title: string;
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
                     removeAllDeclarations: string;
                     total: string;
                 };
@@ -947,6 +962,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -990,6 +1008,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1020,7 +1039,12 @@ export declare const Element: ({ resources, ...props }: object & {
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;

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

@@ -32,6 +32,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -590,6 +591,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -784,6 +787,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: string;
                         quantity: string;
                         sku: string;
                         value: string;
@@ -798,6 +802,17 @@ export declare const Element: ({ resources, ...props }: object & {
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        recipientPays: string;
+                        tooltip: {
+                            title: string;
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
                     removeAllDeclarations: string;
                     total: string;
                 };
@@ -947,6 +962,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -990,6 +1008,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1020,7 +1039,12 @@ export declare const Element: ({ resources, ...props }: object & {
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;

package/src/elements/void-label/components/actions/actions.d.ts

@@ -1,9 +1,10 @@
 import { SE } from "@shipengine/react-api";
 export type ActionsProps = {
     onComplete?: (request: SE.VoidRequest, shipment: SE.SalesOrderShipment) => void;
+    onFail?: () => Promise<void> | void;
     onSubmit?: () => Promise<void>;
     onViewShipment?: (shipment: SE.SalesOrderShipment) => void;
     shipment: SE.SalesOrderShipment;
     voidRequest?: SE.VoidRequest;
 };
-export declare const Actions: ({ onComplete, onSubmit, onViewShipment, shipment, voidRequest, }: ActionsProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Actions: ({ onComplete, onSubmit, onViewShipment, shipment, voidRequest, onFail, }: ActionsProps) => import("@emotion/react/jsx-runtime").JSX.Element;