@shipengine/elements 2.13.1 → 2.15.0

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

@@ -87,17 +87,17 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     rejected: string;
                     dpdwallet: string;
                 };
-                refund_process: string;
+                refund_process: string; /**
+                 * `features` provides optional feature configuration for the Element
+                 * If no value is defined, default configuration will be used.
+                 */
                 refund_rules: string;
                 resultTitles: {
                     approved: string;
                     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: {
@@ -152,16 +152,18 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                 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;
                 };
             };
@@ -194,6 +196,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -208,6 +214,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         error: {
                             title: 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.
+                         */
                         info: {
                             description: string;
                         };
@@ -218,6 +228,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         carrier: {
                             title: string;
                             confirmAddress: string;
+                            /**
+                             * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
+                             * `Print Forms` button.
+                             */
                             description: string;
                         };
                         blackBox: {
@@ -314,12 +328,18 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                 };
                 fields: {
                     "requires-additional-handling": string;
-                    addOns: string;
+                    addOns: string; /**
+                     * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
+                     * `Print Forms` button.
+                     */
                     contentDescription: string;
                     confirmation: string;
                     dimensions: {
                         length: string;
-                        width: string;
+                        width: string; /**
+                         * `onClickPrintLabel` is an optional callback function that will be invoked when the user clicks the
+                         * `Print Label` button.
+                         */
                         height: string;
                     };
                     dimensionsGroup: string;
@@ -593,7 +613,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         g: string;
                         kg: string;
                     };
-                };
+                }; /**
+                 * `features` provides optional feature configuration for the Element
+                 * If no value is defined, default configuration will be used.
+                 */
             };
             "list-shipments": {
                 title: string;
@@ -629,7 +652,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     title: string;
                     subtitle: string;
                 };
-            };
+            }; /**
+             * `labelStatus` is the status of the labels you wish to view.
+             * If no value is defined, all labels will be rendered.
+             */
             "list-labels": {
                 title: string;
                 headers: {
@@ -667,10 +693,6 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     error: string;
                 };
                 actions: {
-                    /**
-                     * `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;
@@ -774,7 +796,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                 };
                 billing: {
                     fields: {
-                        differentBillingAddress: string;
+                        differentBillingAddress: string; /**
+                         * `onClickPrintLabel` is an optional callback function that will be invoked when the user clicks the
+                         * `Print Label` button.
+                         */
                         name: string;
                         cardNumber: string;
                         expiration: string;
@@ -853,6 +878,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -890,6 +916,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -1000,7 +1027,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;

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

@@ -125,16 +125,18 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                 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;
                 };
             };
@@ -167,6 +169,10 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -866,6 +872,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -903,6 +910,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -1013,7 +1021,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;

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

@@ -147,16 +147,18 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                 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;
                 };
             };
@@ -211,6 +213,10 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -866,6 +872,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -903,6 +910,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -1013,7 +1021,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;

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

@@ -102,16 +102,18 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                 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;
                 };
             };
@@ -144,6 +146,10 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -799,6 +805,7 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -836,6 +843,7 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -946,7 +954,7 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;

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

@@ -119,16 +119,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;
                 };
             };
@@ -161,6 +163,10 @@ export declare const Element: ({ resources, ...props }: object & {
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -833,6 +839,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -870,6 +877,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -980,7 +988,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/payment-method-settings/payment-method-settings-element.d.ts

@@ -102,16 +102,18 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                 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;
                 };
             };
@@ -144,6 +146,10 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                         subtitle: string;
                     };
                     insuranceProviders: {
+                        connectionError: {
+                            title: string;
+                            description: string;
+                        };
                         parcelguard: {
                             description: string;
                             terms: string;
@@ -799,6 +805,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                         taxIssuingAuthority: string;
                         entityType: string;
                     };
+                    hsCode: string;
                     nonDelivery: {
                         returnToSender: string;
                         treatAsAbandoned: string;
@@ -836,6 +843,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                         shipments: string;
                         warehouses: string;
                     };
+                    labelHasBeenPurchased: string;
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
@@ -946,7 +954,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
-                    invalidAddressOnboarding: string;
+                    invalidAddressNameOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: 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, ShipFromAddress } from "../../types";
+import { HarmonizedTariffCode, PreferredRatesResponse, ShipFromAddress } from "../../types";
 import { PurchaseLabelFeatures } from "../../utilities";
 import { UseRatesFormProps, UseShipmentFormProps } from "./hooks";
 export type ShipmentFormMode = "browse_rates" | "select_service";
@@ -11,6 +11,7 @@ export type ConfigureShipmentProps = {
     errors?: ShipmentFormProps["errors"];
     features?: PurchaseLabelFeatures;
     getPreferredRates?: (shipment: SE.SalesOrderShipment, isInternational: boolean) => Promise<PreferredRatesResponse | undefined>;
+    harmonizedTariffCodes?: HarmonizedTariffCode[];
     insuranceAccount?: SE.InsuranceAccount;
     isLoading?: ShipmentFormProps["isLoading"];
     onAddressValidation?: UseShipmentFormProps["onAddressValidation"];
@@ -33,4 +34,4 @@ export type ConfigureShipmentProps = {
     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, shipFromAddresses, ...props }: ConfigureShipmentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const ConfigureShipment: ({ errors, features, currency, getPreferredRates, onAddressValidation, onApplyPreset, onBeforeLabelCreate, onChangeAddress, onChangeShipmentFormMode, 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,5 +1,3 @@
-export * from "./use-configure-shipment";
-export * from "./use-import-sales-order";
 export * from "./use-address";
 export * from "./use-customs";
 export * from "./use-presets";

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

@@ -1,9 +1,10 @@
 import { SE } from "@shipengine/react-api";
-import { ShipFromAddress, ShippingPreset } from "../../../types";
+import { HarmonizedTariffCode, ShipFromAddress, ShippingPreset } from "../../../types";
 import { UseAddressProps } from "./use-address";
 import { UsePresetsProps } from "./use-presets";
 export type UseShipmentFormProps = {
     compatibleCountryCodes?: UseAddressProps["compatibleCountryCodes"];
+    harmonizedTariffCodes?: HarmonizedTariffCode[];
     onAddressValidation?: UseAddressProps["onValidation"];
     onApplyPreset?: UsePresetsProps["onApply"];
     onChangeAddress?: UseAddressProps["onChange"];