@shipengine/elements 2.13.1 → 2.15.0

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

@@ -1,9 +1,9 @@
 import React from "react";
 import { SE } from "@shipengine/react-api";
-import { UseShippingPresetsOptionsProps } from "../../hooks";
+import { UseConfigureShipmentProps, UseImportSalesOrderProps, UseShippingPresetsOptionsProps } from "../../hooks";
+import { HarmonizedTariffCode } from "../../types";
 import { PurchaseLabelFeatures } from "../../utilities";
 import { ConfigureShipmentProps } from "./configure-shipment";
-import { UseConfigureShipmentProps, UseImportSalesOrderProps } from "./hooks";
 /**
  * # Purchase Label Component Props
  *
@@ -45,6 +45,10 @@ export type PurchaseLabelCommonProps = {
      * flag and green checkmark when the rate is selected.
      */
     getPreferredRates?: ConfigureShipmentProps["getPreferredRates"];
+    /**
+     * `harmonizedTariffCodes` is an array of objects that contain the Harmonized Tariff Codes and descriptions used to populate the HS Codes dropdown within the Customs Form.
+     */
+    harmonizedTariffCodes?: HarmonizedTariffCode[];
     /**
      * `onAddressValidation` is an async/sync callback function that will be invoked on each Address
      * validation request. For example, whenever you update the `Ship To Address` or
@@ -262,10 +266,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                 refund_process: string;
                 refund_rules: string;
                 resultTitles: {
-                    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.
-                     */
+                    approved: string;
                     rejected: string;
                 };
                 voidedOn: string;
@@ -324,16 +325,18 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                 vatNumber: string;
                 vatRegistrationTooltip: string;
                 vatFormText: string;
-                vatFormRegisterLater: string;
                 vatNumberInputHint: string;
                 vatNumberInputPlaceholder: string;
                 verifiedVat: string;
+                vatNumberFieldLabel: string;
+                vatTypePlaceholder: string;
+                issuingAuthorityPlaceholder: string;
+                issuingAuthorityFieldLabel: string;
                 vatFormErrors: {
                     invalidFieldValue: string;
                     verificationFailure: string;
                     forbidden: string;
                     connectionNotSupported: string;
-                    genericTitle: string;
                     genericText: string;
                 };
             };
@@ -366,6 +369,10 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -441,14 +448,6 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     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;
@@ -526,7 +525,9 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                 };
                 hints: {
                     contentDescription: string;
-                };
+                }; /**
+                 * `harmonizedTariffCodes` is an array of objects that contain the Harmonized Tariff Codes and descriptions used to populate the HS Codes dropdown within the Customs Form.
+                 */
                 loading: {
                     calculatingRates: string;
                 };
@@ -534,7 +535,11 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     browseRates: string;
                     selectService: string;
                 };
-                multipleShippingServices: string;
+                multipleShippingServices: string; /**
+                 * `onAddressValidation` is an async/sync callback function that will be invoked on each Address
+                 * validation request. For example, whenever you update the `Ship To Address` or
+                 * `Ship From Address` for a given shipment.
+                 */
                 schemaErrors: {
                     shipFromUnitedStatesOnly: string;
                     shipFromAddressRequired: string;
@@ -545,10 +550,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     uspsMediaMailAcknowledgement: string;
                     uspsFirstClassMailAcknowledgement_leof: string;
                     rateSavings: 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`.
-                     */
+                    upsGroundSaverTermsAcknowledgement: string;
                     dhlExpressTermsAcknowledgement: string;
                     noRateService: string;
                 };
@@ -558,10 +560,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                         b2c: string;
                         c2b: string;
                         c2c: string;
-                        b2b: string; /**
-                         * `onLabelCreateSuccess` is an async/sync callback provided by the client that is invoked if the
-                         * label is successfully created/purchased.
-                         */
+                        b2b: string;
                     };
                     notAtRisk: string;
                     notAtRiskShipmentTootip: string;
@@ -599,9 +598,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     windsorFramework: string;
                     shipment: string;
                     rate_one: string;
-                    rate_other: string; /**
-                     * A unique Id refering the API code used to identify the type of order source, e.g. "amazon_ca"
-                     */
+                    rate_other: string;
                     payment: string;
                 };
             };
@@ -934,15 +931,15 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     subFields: {
                         optional: string;
                     };
-                    /**
-                     * The Currency used through out the label purchase process. Default to USD
-                     */
                     parserFields: {
                         fullAddress: string;
                     };
                     paste: string;
                     preference: {
-                        confirm: string;
+                        confirm: 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.
+                         */
                         addressNotValidated: string;
                         modified: string;
                         title: string;
@@ -1040,6 +1037,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -1049,12 +1047,6 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                         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;
@@ -1083,6 +1075,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -1193,7 +1186,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;

package/src/elements/select-label-layout/select-label-layout-element.d.ts

@@ -101,16 +101,18 @@ export declare const Element: ({ resources, ...props }: object & {
                 vatNumber: string;
                 vatRegistrationTooltip: string;
                 vatFormText: string;
-                vatFormRegisterLater: string;
                 vatNumberInputHint: string;
                 vatNumberInputPlaceholder: string;
                 verifiedVat: string;
+                vatNumberFieldLabel: string;
+                vatTypePlaceholder: string;
+                issuingAuthorityPlaceholder: string;
+                issuingAuthorityFieldLabel: string;
                 vatFormErrors: {
                     invalidFieldValue: string;
                     verificationFailure: string;
                     forbidden: string;
                     connectionNotSupported: string;
-                    genericTitle: string;
                     genericText: string;
                 };
             };
@@ -143,6 +145,10 @@ export declare const Element: ({ resources, ...props }: object & {
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -798,6 +804,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -835,6 +842,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -945,7 +953,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;

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

@@ -192,16 +192,20 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 vatNumber: string;
                 vatRegistrationTooltip: string;
                 vatFormText: string;
-                vatFormRegisterLater: string;
                 vatNumberInputHint: string;
                 vatNumberInputPlaceholder: string;
                 verifiedVat: string;
+                vatNumberFieldLabel: string;
+                vatTypePlaceholder: string;
+                issuingAuthorityPlaceholder: string;
+                issuingAuthorityFieldLabel: string; /**
+                 * `features` is a set of feature flags you would like to enable or disable in this component.
+                 */
                 vatFormErrors: {
                     invalidFieldValue: string;
                     verificationFailure: string;
                     forbidden: string;
                     connectionNotSupported: string;
-                    genericTitle: string;
                     genericText: string;
                 };
             };
@@ -234,6 +238,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -250,10 +258,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         };
                         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;
@@ -932,6 +937,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -969,6 +975,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -1079,7 +1086,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;

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

@@ -84,6 +84,7 @@ export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter,
             currentPageSize: number;
             onPageSelect: (page: number) => void;
             onPageSizeSelect: (pageSize: number) => void;
+            resetCurrentPage: () => void;
         };
         pagesAmount: number;
         pageSize: number;

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

@@ -173,19 +173,18 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 vatNumber: string;
                 vatRegistrationTooltip: string;
                 vatFormText: string;
-                vatFormRegisterLater: string;
                 vatNumberInputHint: string;
                 vatNumberInputPlaceholder: string;
                 verifiedVat: string;
+                vatNumberFieldLabel: string;
+                vatTypePlaceholder: string;
+                issuingAuthorityPlaceholder: string;
+                issuingAuthorityFieldLabel: string;
                 vatFormErrors: {
                     invalidFieldValue: string;
                     verificationFailure: string;
                     forbidden: string;
                     connectionNotSupported: string;
-                    genericTitle: string;
-                    /**
-                     * `onRowClick` callback invoked when a row is clicked.
-                     */
                     genericText: string;
                 };
             };
@@ -218,6 +217,10 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -933,6 +936,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -970,6 +974,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -1080,7 +1085,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;

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

@@ -114,16 +114,18 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 vatNumber: string;
                 vatRegistrationTooltip: string;
                 vatFormText: string;
-                vatFormRegisterLater: string;
                 vatNumberInputHint: string;
                 vatNumberInputPlaceholder: string;
                 verifiedVat: string;
+                vatNumberFieldLabel: string;
+                vatTypePlaceholder: string;
+                issuingAuthorityPlaceholder: string;
+                issuingAuthorityFieldLabel: string;
                 vatFormErrors: {
                     invalidFieldValue: string;
                     verificationFailure: string;
                     forbidden: string;
                     connectionNotSupported: string;
-                    genericTitle: string;
                     genericText: string;
                 };
             };
@@ -156,6 +158,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -811,6 +817,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -848,6 +855,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -958,7 +966,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;

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

@@ -101,16 +101,18 @@ export declare const Element: ({ resources, ...props }: object & {
                 vatNumber: string;
                 vatRegistrationTooltip: string;
                 vatFormText: string;
-                vatFormRegisterLater: string;
                 vatNumberInputHint: string;
                 vatNumberInputPlaceholder: string;
                 verifiedVat: string;
+                vatNumberFieldLabel: string;
+                vatTypePlaceholder: string;
+                issuingAuthorityPlaceholder: string;
+                issuingAuthorityFieldLabel: string;
                 vatFormErrors: {
                     invalidFieldValue: string;
                     verificationFailure: string;
                     forbidden: string;
                     connectionNotSupported: string;
-                    genericTitle: string;
                     genericText: string;
                 };
             };
@@ -143,6 +145,10 @@ export declare const Element: ({ resources, ...props }: object & {
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -798,6 +804,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -835,6 +842,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -945,7 +953,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;

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

@@ -101,16 +101,18 @@ export declare const Element: ({ resources, ...props }: object & {
                 vatNumber: string;
                 vatRegistrationTooltip: string;
                 vatFormText: string;
-                vatFormRegisterLater: string;
                 vatNumberInputHint: string;
                 vatNumberInputPlaceholder: string;
                 verifiedVat: string;
+                vatNumberFieldLabel: string;
+                vatTypePlaceholder: string;
+                issuingAuthorityPlaceholder: string;
+                issuingAuthorityFieldLabel: string;
                 vatFormErrors: {
                     invalidFieldValue: string;
                     verificationFailure: string;
                     forbidden: string;
                     connectionNotSupported: string;
-                    genericTitle: string;
                     genericText: string;
                 };
             };
@@ -143,6 +145,10 @@ export declare const Element: ({ resources, ...props }: object & {
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -798,6 +804,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -835,6 +842,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -945,7 +953,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;

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

@@ -101,16 +101,18 @@ export declare const Element: ({ resources, ...props }: object & {
                 vatNumber: string;
                 vatRegistrationTooltip: string;
                 vatFormText: string;
-                vatFormRegisterLater: string;
                 vatNumberInputHint: string;
                 vatNumberInputPlaceholder: string;
                 verifiedVat: string;
+                vatNumberFieldLabel: string;
+                vatTypePlaceholder: string;
+                issuingAuthorityPlaceholder: string;
+                issuingAuthorityFieldLabel: string;
                 vatFormErrors: {
                     invalidFieldValue: string;
                     verificationFailure: string;
                     forbidden: string;
                     connectionNotSupported: string;
-                    genericTitle: string;
                     genericText: string;
                 };
             };
@@ -143,6 +145,10 @@ export declare const Element: ({ resources, ...props }: object & {
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -798,6 +804,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -835,6 +842,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -945,7 +953,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;