@shipengine/elements 2.11.1 → 2.13.0

package/src/elements/purchase-label/hooks/use-import-sales-order.d.ts

@@ -1,10 +1,11 @@
 export type UseImportSalesOrderProps = {
+    enabled: boolean;
     externalOrderId?: string;
     externalOrderNumber?: string;
     orderSourceCode?: string;
     salesOrderId?: string;
 };
-export declare const useImportSalesOrder: ({ externalOrderId, externalOrderNumber, orderSourceCode, salesOrderId, }: UseImportSalesOrderProps) => {
+export declare const useImportSalesOrder: ({ enabled, externalOrderId, externalOrderNumber, orderSourceCode, salesOrderId, }: UseImportSalesOrderProps) => {
     errors: import("@shipengine/react-api").CodedError[] | undefined;
     isLoading: boolean;
     salesOrder: import("@shipengine/react-api").SalesOrder | undefined;

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

@@ -1,5 +1,5 @@
 import { SE } from "@shipengine/react-api";
-import { ShippingPreset } from "../../../types";
+import { ShipFromAddress, ShippingPreset } from "../../../types";
 import { UseAddressProps } from "./use-address";
 import { UsePresetsProps } from "./use-presets";
 export type UseShipmentFormProps = {
@@ -10,9 +10,11 @@ export type UseShipmentFormProps = {
     onShipmentUpdated?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
     onSubmit?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
     salesOrder?: SE.SalesOrder;
+    shipFromAddresses?: ShipFromAddress[];
     shipment?: SE.SalesOrderShipment;
+    useWarehouses?: boolean;
 };
-export declare const useShipmentForm: ({ compatibleCountryCodes, onAddressValidation, onApplyPreset, onChangeAddress, onShipmentUpdated, onSubmit, salesOrder, shipment, }: UseShipmentFormProps) => {
+export declare const useShipmentForm: ({ compatibleCountryCodes, onAddressValidation, onApplyPreset, onChangeAddress, onShipmentUpdated, onSubmit, salesOrder, shipment, shipFromAddresses: shipFromAddressesProp, useWarehouses, }: UseShipmentFormProps) => {
     accountSettings: SE.ShipEngineAccountSettings | undefined;
     addressLoading: boolean;
     addressPreference: import("../../../components/templates").AddressPreference | undefined;
@@ -23,17 +25,24 @@ export declare const useShipmentForm: ({ compatibleCountryCodes, onAddressValida
     errors: SE.CodedError[] | undefined;
     onApplyPreset: (preset: ShippingPreset) => Promise<void>;
     onChangeAddress: (shipTo: SE.Address, { shouldValidate }: import("../../../components/templates").OnChangeAddressOptions) => Promise<SE.SalesOrderShipment>;
-    onChangeWarehouse: (warehouseId: string) => Promise<void>;
+    onChangeShipFromAddress: (id?: string, shipFromAddress?: ShipFromAddress) => Promise<void>;
     onSubmit: (values: Partial<SE.SalesOrderShipment>) => Promise<SE.SalesOrderShipment>;
-    onSubmitParseShipTo: ({ fullAddress }: {
+    onSubmitParseAddress: ({ fullAddress }: {
         fullAddress: string;
     }) => Promise<SE.AddressExtraction>;
-    onUpdateCustoms: (customs: SE.Customs, products: SE.Product[]) => Promise<SE.SalesOrderShipment>;
+    onUpdateCustoms: (customs: SE.Customs, products: SE.Product[], canadaDdpValue?: string | null | undefined) => Promise<SE.SalesOrderShipment>;
     onUpdateTaxableIds: (taxIds: SE.TaxIdentifier[], onError: (errors: SE.CodedError[]) => void) => Promise<SE.SalesOrderShipment>;
     parseAddressErrors: SE.CodedError[] | undefined;
     resetParseAddress: () => void;
     resetSalesOrderShipment: () => void;
     salesOrder: SE.SalesOrder | undefined;
+    shipFromAddresses: {
+        addressId: string;
+        originAddress: SE.Address;
+        returnAddress: SE.Address;
+        isDefault: boolean;
+        name?: string | undefined;
+    }[] | undefined;
     shipment: SE.SalesOrderShipment | undefined;
     warehouses: SE.Warehouse[] | undefined;
 };

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

@@ -1,10 +1,9 @@
 import React from "react";
+import { SE } from "@shipengine/react-api";
 import { UseShippingPresetsOptionsProps } from "../../hooks";
 import { PurchaseLabelFeatures } from "../../utilities";
 import { ConfigureShipmentProps } from "./configure-shipment";
-import { UseConfigureShipmentProps } from "./hooks";
-import { PurchaseLabelSalesOrderProps } from "./purchase-label-by-sales-order";
-import { PurchaseLabelByShipmentProps } from "./purchase-label-by-shipment";
+import { UseConfigureShipmentProps, UseImportSalesOrderProps } from "./hooks";
 /**
  * # Purchase Label Component Props
  *
@@ -14,6 +13,25 @@ import { PurchaseLabelByShipmentProps } from "./purchase-label-by-shipment";
  * @see {@link PurchaseLabel.Element | This prop types usage in `<PurchaseLabel.Element />`}
  */
 export type PurchaseLabelCommonProps = {
+    /**
+     * The Currency used through out the label purchase process. Default to USD
+     */
+    currency?: SE.Currency;
+    /**
+     * A unique ID assigned during the creation of a sales order. It can be used to locate the
+     * sales order and any subsequent shipments related to that order.
+     */
+    externalOrderId?: UseImportSalesOrderProps["externalOrderId"];
+    /**
+     * A unique ID assigned during the creation of a sales order. It can be used to locate the
+     * sales order and any subsequent shipments related to that order.
+     */
+    externalOrderNumber?: UseImportSalesOrderProps["externalOrderNumber"];
+    /**
+     * A unique ID assigned during the creation of a sales order. It can be used to locate the
+     * sales order and any subsequent shipments related to that order.
+     */
+    externalShipmentId?: string;
     /**
      * `features` is a set of feature flags you would like to enable or disable in this component.
      */
@@ -95,6 +113,10 @@ export type PurchaseLabelCommonProps = {
      * the formatted address that we return after validation.
      */
     onToggleAddressPreferenceDisclosure?: ConfigureShipmentProps["onToggleAddressPreferenceDisclosure"];
+    /**
+     * A unique Id refering the API code used to identify the type of order source, e.g. "amazon_ca"
+     */
+    orderSourceCode?: UseImportSalesOrderProps["orderSourceCode"];
     /**
      * `preferredServiceCodes` is an array of service codes you would like to be marked as preferred. The services
      * codes corresponding rate will get the same UI enhancements as the rates received from getPreferredRates.
@@ -105,6 +127,19 @@ export type PurchaseLabelCommonProps = {
      * purchasing a label. e.g. `4x6`
      */
     printLabelLayout?: ConfigureShipmentProps["printLabelLayout"];
+    /**
+     * A unique Id used to indentify a ShipEngine Sales Order
+     */
+    salesOrderId?: UseImportSalesOrderProps["salesOrderId"];
+    /**
+     * `shipFromAddresses` is an array of objects that contain the ship from and return to addresses to be used when purchasing a label.
+     * This can be used in lieu of a `warehouseId` if initializing the Purchase Label Element without a pre-existing shipment or sales order.
+     */
+    shipFromAddresses?: ConfigureShipmentProps["shipFromAddresses"];
+    /**
+     * A unique Id used to indentify a ShipEngine Shipment
+     */
+    shipmentId?: string;
     /**
      * `shippingPresets` is an object that contains configured shipment details/specs
      * (dimensions, shipping service, etc) that can be applied to a shipment when purchasing a label.
@@ -119,13 +154,9 @@ export type PurchaseLabelCommonProps = {
 /**
  * # PurchaseLabel Element Props
  *
- * - The Purchase Label `ElementProps` is a `union` of the `PurchaseLabelByShipmentProps` and
- * `PurchaseLabelSalesOrderProps` prop types. This is for ease of use when purchasing labels by
- * `shipment` or `sales order`.
- *
  * @see {@link PurchaseLabel.Element | This prop types usage in `<PurchaseLabel />`}
  */
-export type ElementProps = PurchaseLabelByShipmentProps | PurchaseLabelSalesOrderProps;
+export type ElementProps = PurchaseLabelCommonProps;
 /**
  * # Purchase Label Component
  *
@@ -150,7 +181,7 @@ export type ElementProps = PurchaseLabelByShipmentProps | PurchaseLabelSalesOrde
  *
  * @see {@link PurchaseLabel.Element | The **Element** created to render `<PurchaseLabel />`}
  */
-export declare const Component: ({ features, ...props }: ElementProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ features, externalOrderId, externalOrderNumber, externalShipmentId, onLoad, onShipmentUpdated, orderSourceCode, salesOrderId, shipFromAddresses, warehouseId, shipmentId, printLabelLayout, currency: currencyProp, ...props }: ElementProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
  * # Registered Purchase Label Element
  *
@@ -189,7 +220,7 @@ export declare const Component: ({ features, ...props }: ElementProps) => import
  *
  * @see {@link ShipmentSummary.Element | The next step in the label purchase workflow `<ShipmentSummary.Element />`}
  */
-export declare const Element: ({ resources, ...props }: ElementProps & {
+export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps & {
     resources?: {
         en: {
             "wallet-history": {
@@ -221,6 +252,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
@@ -230,7 +262,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 refund_process: string;
                 refund_rules: string;
                 resultTitles: {
-                    approved: string;
+                    approved: string; /**
+                     * A unique ID assigned during the creation of a sales order. It can be used to locate the
+                     * sales order and any subsequent shipments related to that order.
+                     */
                     rejected: string;
                 };
                 voidedOn: string;
@@ -406,6 +441,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     location_fee: string;
                     oversize: string;
                     returns: string;
+                    /**
+                     * # Purchase Label Component Props
+                     *
+                     * These are the shared props that will be passed into the `<PurchaseLabel.Element />`, and work
+                     * for either shipment-based or sales order-based label purchasing.
+                     *
+                     * @see {@link PurchaseLabel.Element | This prop types usage in `<PurchaseLabel.Element />`}
+                     */
                     notifications: string;
                     tip: string;
                     duties_and_taxes: string;
@@ -475,10 +518,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     addShipToAddress: string;
                     warehouse: string;
                     weight: {
-                        /**
-                         * `onBeforeLabelCreate` is an async/sync callback function that will be invoked before every
-                         * label purchase.
-                         */
                         whole: string;
                         fractional: string;
                     };
@@ -506,7 +545,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     uspsMediaMailAcknowledgement: string;
                     uspsFirstClassMailAcknowledgement_leof: string;
                     rateSavings: string;
-                    upsGroundSaverTermsAcknowledgement: string;
+                    upsGroundSaverTermsAcknowledgement: string; /**
+                     * `onChangeShipmentFormMode` is an async/sync callback function that will be invoked each time
+                     * the user toggles the `Shipment Form Mode` between `Browse Rates` and `Selected Rate`.
+                     */
                     dhlExpressTermsAcknowledgement: string;
                     noRateService: string;
                 };
@@ -516,18 +558,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         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.
-                     */
+                        b2b: string; /**
+                         * `onLabelCreateSuccess` is an async/sync callback provided by the client that is invoked if the
+                         * label is successfully created/purchased.
+                         */
+                    };
                     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;
@@ -561,7 +599,9 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     windsorFramework: string;
                     shipment: string;
                     rate_one: string;
-                    rate_other: string;
+                    rate_other: string; /**
+                     * A unique Id refering the API code used to identify the type of order source, e.g. "amazon_ca"
+                     */
                     payment: string;
                 };
             };
@@ -790,6 +830,8 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -852,14 +894,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 deleteCarrierErrorTitle: string;
                 deleteCarrierErrorMessage: string;
                 loadingDeletingCarrier: string;
-            }; /**
-             *`getPreferredRates is an async/sync optional callback function that will be invoked each time rates are caculated.
-             * This is an optional callback function that returns an array of ShipEngine rates. The rates from this response will
-             * be spliced into the normal get rates response the Elements makes internally. If a service code matches a service
-             * code on a rate returned from getPreferredRates, the rate returned from getPreferredRates will not be shown in the
-             * rate form. These preferred rates will be displayed with a set of UI enhancements that incude a dynamic cost savings
-             * flag and green checkmark when the rate is selected.
-             */
+            };
             common: {
                 actions: {
                     add: string;
@@ -899,6 +934,9 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     subFields: {
                         optional: string;
                     };
+                    /**
+                     * The Currency used through out the label purchase process. Default to USD
+                     */
                     parserFields: {
                         fullAddress: string;
                     };
@@ -947,10 +985,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         message: string;
                     };
                     address: {
-                        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.
-                         */
+                        message: string;
                         title: string;
                     };
                 };
@@ -967,10 +1002,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     addDeclaration: string;
                     noResults: string;
                     contents: {
-                        documents: string; /**
-                         * `onLabelCreateFailure` is an async/sync callback function that will be invoked each time a
-                         * label purchase fails.
-                         */
+                        documents: string;
                         gift: string;
                         merchandise: string;
                         returnedGoods: string;
@@ -997,13 +1029,8 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
+                        dutiesTaxes: 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;
@@ -1017,6 +1044,23 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
+                    canadaDeliveredDuty: {
+                        senderPrepay: string;
+                        recipientPays: string;
+                        tooltip: {
+                            title: 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.
+                             */
+                            restriction: string;
+                            requirement1: string;
+                            requirement2: string;
+                            requirement3: string;
+                        };
+                    };
                     removeAllDeclarations: string;
                     total: string;
                 };
@@ -1166,6 +1210,9 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -1209,6 +1256,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1239,7 +1287,12 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: {
+                        title: string;
+                        customStatusMessages: {
+                            success: string;
+                        };
+                    };
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;

package/src/elements/select-label-layout/select-label-layout-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/shipment-summary/shipment-summary.d.ts

@@ -121,11 +121,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 errorMessages: {
                     labelIdRequired: string;
+                    request_failed_to_complete: string;
                 };
                 resultMessages: {
                     approved: string;
                     rejected: string;
-                    dpdwallet: string;
+                    dpdwallet: string; /**
+                     * `features` is a set of feature flags you would like to enable or disable in this component.
+                     */
                 };
                 refund_process: string;
                 refund_rules: string;
@@ -688,6 +691,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     status: string;
                     trackingStatus: string;
                     labelId: string;
+                    externalOrderId: string;
+                    externalShipmentId: string;
                 };
                 empty: {
                     title: string;
@@ -702,7 +707,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     voided: string;
                     error: string;
                     completed: string;
-                    processing: string;
+                    processing: string; /**
+                     * `onClickPrintLabel` is a callback function that will be invoked when the user clicks the
+                     * `Print Label` button.
+                     */
                 };
                 trackingStatus: {
                     unknown: string;
@@ -714,10 +722,7 @@ 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;
@@ -910,7 +915,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
-                        quantity: string;
+                        dutiesTaxes: string;
+                        quantity: string; /**
+                         * # Shipment Summary Element Props
+                         *
+                         * - These are the base props that will be passed into the `<ShipmentSummary />` element.
+                         *
+                         * @see {@link ShipmentSummary.Element | See the full type that `typeof Element` will return}
+                         */
                         sku: string;
                         value: string;
                         valueQuantity: string;
@@ -924,6 +936,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;
                 };
@@ -1073,6 +1096,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     tooManyCharacters: string;
                     requiredShipmentId: string;
                     requiredLabelId: string;
+                    heightExceeded: string;
+                    widthExceeded: string;
+                    lengthExceeded: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -1116,6 +1142,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         edit: string;
                         remove: string;
                         viewDetails: string;
+                        cancelShipment: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -1146,7 +1173,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;