@shipengine/elements 2.11.1 → 2.13.0

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

@@ -17,6 +17,8 @@ export declare const useLabelsGrid: ({ labelStatus, showShipmentIdFilter, showLa
         chargeEvent: SE.LabelChargeEvent;
         createdAt: string;
         displayScheme: SE.LabelDisplayScheme;
+        externalOrderId: string | null;
+        externalShipmentId: string | null;
         formDownload: SE.LinkedResource;
         insuranceClaim: SE.LinkedResource;
         insuranceCost: SE.Money;
@@ -64,6 +66,8 @@ export declare const useLabelsGrid: ({ labelStatus, showShipmentIdFilter, showLa
         chargeEvent: SE.LabelChargeEvent;
         createdAt: string;
         displayScheme: SE.LabelDisplayScheme;
+        externalOrderId: string | null;
+        externalShipmentId: string | null;
         formDownload: SE.LinkedResource;
         insuranceClaim: SE.LinkedResource;
         insuranceCost: SE.Money;

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

@@ -12,6 +12,16 @@ export type LabelsGridProps = {
      * If no value is defined, all labels will be rendered.
      */
     labelStatus?: SE.LabelStatus;
+    /**
+     * `onClickExternalOrderId` is an optional callback function that will be invoked when the user clicks the id number within the
+     * `External Order ID` column, if present.
+     */
+    onClickExternalOrderId?: (externalOrderId?: string) => void;
+    /**
+     * `onClickExternalShipmentId` is an optional callback function that will be invoked when the user clicks the id number within
+     * `External Shipment Id` column, if present.
+     */
+    onClickExternalShipmentId?: (externalShipmentId?: string) => void;
     /**
      * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
      * `Print Forms` button.
@@ -37,7 +47,7 @@ export type LabelsGridProps = {
      */
     onRowClick?: (label: SE.Label) => void;
 };
-export declare const Component: ({ labelStatus, features, onClickPrintLabel, onClickVoidLabel, onClickPrintForms, onClickViewDetails, onRowClick, }: LabelsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ labelStatus, features, onClickPrintLabel, onClickVoidLabel, onClickPrintForms, onClickViewDetails, onRowClick, onClickExternalOrderId, onClickExternalShipmentId, }: LabelsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export declare const Element: ({ resources, ...props }: LabelsGridProps & {
     resources?: {
         en: {
@@ -70,6 +80,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -83,7 +94,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     rejected: string;
                 };
                 voidedOn: string;
-            };
+            }; /**
+             * `onClickExternalOrderId` is an optional callback function that will be invoked when the user clicks the id number within the
+             * `External Order ID` column, if present.
+             */
             "view-shipment": {
                 title: string;
                 actions: {
@@ -128,9 +142,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                 highVolumeForms: string;
                 multipleShippingServices: string;
                 sections: {
-                    labels: string; /**
-                     * `onRowClick` callback invoked when a row is clicked.
-                     */
+                    labels: string;
                     shipmentSummary: string;
                 };
                 noLabels: string;
@@ -266,10 +278,7 @@ 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: {
@@ -292,10 +301,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     parcelguard: string;
                 };
                 errorMessages: {
-                    customsItemsRequired: string; /**
-                     * `features` provides optional feature configuration for the Element
-                     * If no value is defined, default configuration will be used.
-                     */
+                    customsItemsRequired: string;
                     invalidAddress: string;
                     noRates: string;
                     salesOrderNotLoaded: string;
@@ -539,10 +545,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     insufficientFunds: string;
                     insufficientFundsTitle: string;
                     negativeBalance: 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.
-                     */
+                    negativeBalanceTitle: string;
                     newBalance: string;
                 };
                 errors: {
@@ -639,6 +642,8 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -662,10 +667,11 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     error: string;
                 };
                 actions: {
-                    title: string; /**
+                    /**
                      * `labelStatus` is the status of the labels you wish to view.
                      * If no value is defined, all labels will be rendered.
                      */
+                    title: string;
                     print: string;
                     void: string;
                     printForms: string;
@@ -836,6 +842,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: string;
                         quantity: string;
                         sku: string;
                         value: string;
@@ -850,6 +857,17 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        recipientPays: string;
+                        tooltip: {
+                            title: string;
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
                     removeAllDeclarations: string;
                     total: string;
                 };
@@ -999,6 +1017,9 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -1042,6 +1063,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1072,13 +1094,15 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
                     externalCarriers: string;
                     labelLayout: string;
-                    unitSettings: string; /**
-                     * `features` provides optional feature configuration for the Element
-                     * If no value is defined, default configuration will be used.
-                     */
+                    unitSettings: string;
                     vatSettings: string;
                 };
             };

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

@@ -56,6 +56,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -636,6 +637,8 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -852,6 +855,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: string;
                         quantity: string;
                         sku: string;
                         value: string;
@@ -866,6 +870,17 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        recipientPays: string;
+                        tooltip: {
+                            title: string;
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
                     removeAllDeclarations: string;
                     total: string;
                 };
@@ -1015,6 +1030,9 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -1058,6 +1076,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1088,7 +1107,12 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;

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

@@ -56,6 +56,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -658,6 +659,8 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -852,6 +855,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: string;
                         quantity: string;
                         sku: string;
                         value: string;
@@ -866,6 +870,17 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        recipientPays: string;
+                        tooltip: {
+                            title: string;
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
                     removeAllDeclarations: string;
                     total: string;
                 };
@@ -1015,6 +1030,9 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -1058,6 +1076,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1088,7 +1107,12 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;

package/src/elements/manage-funding/manage-funding-element.d.ts

@@ -33,6 +33,7 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -591,6 +592,8 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -785,6 +788,7 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: string;
                         quantity: string;
                         sku: string;
                         value: string;
@@ -799,6 +803,17 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        recipientPays: string;
+                        tooltip: {
+                            title: string;
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
                     removeAllDeclarations: string;
                     total: string;
                 };
@@ -948,6 +963,9 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -991,6 +1009,7 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1021,7 +1040,12 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;

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

@@ -50,6 +50,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -608,6 +609,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -819,6 +822,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: string;
                         quantity: string;
                         sku: string;
                         value: string;
@@ -833,6 +837,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;
                 };
@@ -982,6 +997,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -1025,6 +1043,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1055,7 +1074,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/payment-method-settings/payment-method-settings-element.d.ts

@@ -33,6 +33,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -591,6 +592,8 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -785,6 +788,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: string;
                         quantity: string;
                         sku: string;
                         value: string;
@@ -799,6 +803,17 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        recipientPays: string;
+                        tooltip: {
+                            title: string;
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
                     removeAllDeclarations: string;
                     total: string;
                 };
@@ -948,6 +963,9 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -991,6 +1009,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1021,7 +1040,12 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;

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

@@ -2,7 +2,7 @@ import { SE } from "@shipengine/react-api";
 import { RateFormProps } from "../../components/templates/rate-form";
 import { ShipmentFormProps } from "../../components/templates/shipment-form";
 import { UseShippingPresetsOptionsProps } from "../../hooks";
-import { PreferredRatesResponse } from "../../types";
+import { PreferredRatesResponse, ShipFromAddress } from "../../types";
 import { PurchaseLabelFeatures } from "../../utilities";
 import { UseRatesFormProps, UseShipmentFormProps } from "./hooks";
 export type ShipmentFormMode = "browse_rates" | "select_service";
@@ -28,8 +28,9 @@ export type ConfigureShipmentProps = {
     preferredServiceCodes?: RateFormProps["preferredServiceCodes"];
     printLabelLayout?: UseRatesFormProps["printLabelLayout"];
     salesOrder?: SE.SalesOrder;
+    shipFromAddresses?: ShipFromAddress[];
     shipment?: SE.SalesOrderShipment;
     shippingPresets?: UseShippingPresetsOptionsProps;
     warehouseId?: string;
 };
-export declare const ConfigureShipment: ({ errors, features, currency, getPreferredRates, onAddressValidation, onApplyPreset, onBeforeLabelCreate, onChangeAddress, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, onRatesCalculated, onShipmentUpdated, printLabelLayout, preferredServiceCodes, salesOrder, shipment, onBeforeRateSaved, ...props }: ConfigureShipmentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const ConfigureShipment: ({ errors, features, currency, getPreferredRates, onAddressValidation, onApplyPreset, onBeforeLabelCreate, onChangeAddress, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, onRatesCalculated, onShipmentUpdated, printLabelLayout, preferredServiceCodes, salesOrder, shipment, onBeforeRateSaved, shipFromAddresses, ...props }: ConfigureShipmentProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -1,6 +1,5 @@
 export * from "./use-configure-shipment";
 export * from "./use-import-sales-order";
-export * from "./use-pending-shipment";
 export * from "./use-address";
 export * from "./use-customs";
 export * from "./use-presets";
@@ -9,4 +8,3 @@ export * from "./use-shipment-form";
 export * from "./use-rates-with-cache";
 export * from "./use-request-rates";
 export * from "./use-request-preferred-rates";
-export * from "./use-get-or-create-shipment";

package/src/elements/purchase-label/hooks/use-address.d.ts

@@ -16,7 +16,7 @@ export declare const useAddress: ({ compatibleCountryCodes, onChange, onValidati
     addressPreference: AddressPreference | undefined;
     charsetWarning: CharsetWarning | undefined;
     handleChangeAddress: (shipTo: SE.Address, { shouldValidate }: OnChangeAddressOptions) => Promise<SE.SalesOrderShipment>;
-    handleParseShipTo: ({ fullAddress }: AddressParserPayload) => Promise<SE.AddressExtraction>;
+    handleParseAddress: ({ fullAddress }: AddressParserPayload) => Promise<SE.AddressExtraction>;
     parseAddressErrors: SE.CodedError[] | undefined;
     resetParseAddress: () => void;
 };

package/src/elements/purchase-label/hooks/use-configure-shipment.d.ts

@@ -1,19 +1,30 @@
-import { SE } from "@shipengine/react-api";
+import { CodedError, SE } from "@shipengine/react-api";
 import { ConfigureShipmentProps } from "../configure-shipment";
-import { UsePendingShipmentProps } from "./use-pending-shipment";
 export type UseConfigureShipmentProps = {
     errorWhenShipmentCancelled?: boolean;
-    onLoad?: UsePendingShipmentProps["onLoad"];
-    onShipmentUpdated?: ConfigureShipmentProps["onShipmentUpdated"];
-    printLabelLayout?: SE.LabelLayout;
-    salesOrder?: SE.SalesOrder;
-    warehouseId?: UsePendingShipmentProps["warehouseId"];
+    externalOrderId?: string;
+    externalOrderNumber?: string;
+    externalShipmentId?: string;
+    onLoad?: (shipments: SE.SalesOrderShipment[], salesOrder?: SE.SalesOrder, pendingShipment?: SE.SalesOrderShipment) => Promise<void> | void;
+    onShipmentUpdated: ConfigureShipmentProps["onShipmentUpdated"];
+    orderSourceCode?: string;
+    salesOrderId?: string;
+    shipFromAddresses?: ConfigureShipmentProps["shipFromAddresses"];
+    shipmentId?: string;
+    useWarehouses?: boolean;
+    warehouseId?: string;
 };
-export declare const useConfigureShipment: ({ onLoad, errorWhenShipmentCancelled, onShipmentUpdated, salesOrder, warehouseId, printLabelLayout, }: UseConfigureShipmentProps) => {
-    errors: SE.CodedError[] | undefined;
+/**
+ * The high-level goal of this hook is to get or create the required data to run the Configure shipment component.
+ * To run the Configure Shipment Component you need shipments. To get a shipment you either need a Shipment ID or
+ * a Sales Order Id (or other relevant Sales Order entity id, external order id, order source code, external order number).
+ * My initial thought is to combine the hooks used in useGetOrCreateShipment and useImportSalesOrder to pull in all
+ * the relevant information. I will leverage the built-in functionality of the React Query Hooks to optimize this custom hook.
+ */
+export declare const useConfigureShipment: ({ onShipmentUpdated, onLoad, errorWhenShipmentCancelled, externalOrderId, externalOrderNumber, externalShipmentId, orderSourceCode, salesOrderId, shipFromAddresses, shipmentId, warehouseId, useWarehouses, }: UseConfigureShipmentProps) => {
+    errors: CodedError[] | undefined;
     isLoading: boolean;
-    onShipmentUpdated: (shipment: SE.SalesOrderShipment) => Promise<void>;
-    printLabelLayout: SE.LabelLayout;
+    refetchPendingSalesOrderShipments: () => Promise<SE.SalesOrderShipment | undefined>;
+    salesOrder: SE.SalesOrder | undefined;
     shipment: SE.SalesOrderShipment | undefined;
-    warehouseId: string | undefined;
 };

package/src/elements/purchase-label/hooks/use-customs.d.ts

@@ -5,6 +5,6 @@ export type UseCustomsProps = {
 };
 export declare const useCustoms: ({ onUpdate, shipment }: UseCustomsProps) => {
     customsErrors: SE.CodedError[] | null;
-    handleUpdateCustoms: (customs: SE.Customs, products: SE.Product[]) => Promise<SE.SalesOrderShipment>;
+    handleUpdateCustoms: (customs: SE.Customs, products: SE.Product[], canadaDdpValue?: string | null) => Promise<SE.SalesOrderShipment>;
     handleUpdateTaxableIds: (taxIds: SE.TaxIdentifier[], onError: (errors: SE.CodedError[]) => void) => Promise<SE.SalesOrderShipment>;
 };