@shipengine/elements 2.18.0 → 2.19.0

package/src/elements/payment-method-settings/payment-method-settings-element.d.ts

@@ -23,6 +23,9 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -619,8 +622,10 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -640,6 +645,17 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -686,6 +702,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -848,6 +865,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -866,6 +884,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -879,6 +898,8 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;

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

@@ -28,6 +28,7 @@ export declare const useRatesForm: ({ getPreferredRates, disabledShippingService
     displayableRateErrors: string[] | undefined;
     errors: SE.CodedError[] | undefined;
     fetchServicePoints: (searchQuery?: import("../../../hooks").ServicePointSearchQuery | undefined) => void;
+    fundingOrigin: import("../../../hooks").FundingOrigin | undefined;
     isLoading: boolean;
     labelErrors: string[] | undefined;
     labels: SE.Label[];

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

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/react-api";
+import { CodedError, SE } from "@shipengine/react-api";
 import { HarmonizedTariffCode, ShipFromAddress } from "../../../types";
 import { UseAddressProps } from "./use-address";
 import { UsePresetsProps } from "./use-presets";
@@ -22,7 +22,7 @@ export declare const useShipmentForm: ({ compatibleCountryCodes, onAddressValida
     charsetWarning: import("../../../components/templates").CharsetWarning | undefined;
     customPackageTypes: SE.CustomPackage[] | undefined;
     displayableErrors: string[] | undefined;
-    errors: SE.CodedError[] | undefined;
+    errors: CodedError[] | undefined;
     onApplyPreset: (preset: import("../../../types").ShippingPreset) => Promise<void>;
     onChangeAddress: (shipTo: SE.Address, { shouldValidate }: import("../../../components/templates").OnChangeAddressOptions) => Promise<SE.SalesOrderShipment>;
     onChangeShipFromAddress: (id?: string, shipFromAddress?: ShipFromAddress) => Promise<void>;
@@ -31,8 +31,8 @@ export declare const useShipmentForm: ({ compatibleCountryCodes, onAddressValida
         fullAddress: string;
     }) => Promise<SE.AddressExtraction>;
     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;
+    onUpdateTaxableIds: (taxIds: SE.TaxIdentifier[], onError: (errors: CodedError[]) => void) => Promise<SE.SalesOrderShipment>;
+    parseAddressErrors: CodedError[] | undefined;
     resetParseAddress: () => void;
     resetSalesOrderShipment: () => void;
     salesOrder: SE.SalesOrder | undefined;

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

@@ -246,6 +246,9 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -848,8 +851,10 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -869,6 +874,17 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -915,6 +931,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -936,10 +953,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     };
                     paste: string;
                     preference: {
-                        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.
-                         */
+                        confirm: string;
                         addressNotValidated: string;
                         modified: string;
                         title: string;
@@ -947,7 +961,10 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                         matchedAddress: string;
                         unableToValidate: string;
                         use: {
-                            originalAddress: string;
+                            originalAddress: 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.
+                             */
                             matchedAddress: string;
                         };
                     };
@@ -1080,6 +1097,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -1098,6 +1116,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -1111,6 +1130,8 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;

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

@@ -22,6 +22,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -618,8 +621,10 @@ export declare const Element: ({ resources, ...props }: object & {
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -639,6 +644,17 @@ export declare const Element: ({ resources, ...props }: object & {
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -685,6 +701,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -847,6 +864,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -865,6 +883,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -878,6 +897,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;

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

@@ -111,6 +111,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -717,8 +720,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    /**
+                     * `onClickPurchaseLabel` is a callback function that will be invoked when the user clicks the
+                     * `Purchase Label` button.
+                     */
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -738,6 +747,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -784,6 +804,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -801,6 +822,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         optional: string;
                     };
                     parserFields: {
+                        /**
+                         * `onClickPurchaseLabel` is a callback function that will be invoked when the user clicks the
+                         * `Purchase Label` button.
+                         */
                         fullAddress: string;
                     };
                     paste: string;
@@ -813,31 +838,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         matchedAddress: string;
                         unableToValidate: string;
                         use: {
-                            /**
-                             * # Shipment Summary Component
-                             *
-                             * - The `<ShipmentSummary />` component is used to for viewing the shipment's tracking number, printing the label that
-                             * was created, and the option to void the label. When a label is voided, you can see a list of the
-                             * previously voided labels for a given shipment using this component.
-                             *
-                             * @param ComponentProps The base props that will be passed into the `<ShipmentSummary />` component.
-                             *
-                             * @returns Element An EmotionJSX.Element that will render the `<ShipmentSummary />` component
-                             * with all the appropriate wrappers.
-                             *
-                             * @example
-                             * You can see how the `<Component />` is used in the `createElement` function call below.
-                             * ```tsx
-                             * export const Element = createElement(Component, ErrorFallback, {
-                             *
-                             *   resources: { en },
-                             * });
-                             * ```
-                             *
-                             * <br />
-                             *
-                             * @see {@link ShipmentSummary.Element | The **Element** created to render `<ShipmentSummary />`}
-                             */
                             originalAddress: string;
                             matchedAddress: string;
                         };
@@ -918,13 +918,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         harmonizedTariffCode: string;
                         ifDeliveryFails: 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}
-                         */
+                        quantity: string;
                         sku: string;
                         value: string;
                         valueQuantity: string;
@@ -977,6 +971,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -995,6 +990,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -1008,6 +1004,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;

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

@@ -94,6 +94,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -718,8 +721,10 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -739,6 +744,17 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -752,10 +768,6 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     header: string;
                 };
                 status: {
-                    /**
-                     * `onClickCancelShipment` is a callback function that controls the display of `Cancel shipment` option and
-                     *  will be invoked when the user clicks on it.
-                     */
                     connected: string;
                 };
                 disconnectDropdown: {
@@ -789,6 +801,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -796,10 +809,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         addressLine2: string;
                         cityLocality: string;
                         stateProvince: string;
-                        postalCode: string; /**
-                         * `onClickCancelShipment` is a callback function that controls the display of `Cancel shipment` option and
-                         *  will be invoked when the user clicks on it.
-                         */
+                        postalCode: string;
                         phone: string;
                         email: string;
                         addressResidentialIndicator: string;
@@ -818,9 +828,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         modified: string;
                         title: string;
                         originalAddress: string;
-                        matchedAddress: string; /**
-                         * `showShipmentIdFilter` controls the display of the shipmentId search filter
-                         */
+                        matchedAddress: string;
                         unableToValidate: string;
                         use: {
                             originalAddress: string;
@@ -828,27 +836,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         };
                     };
                     validation: {
-                        notValidated: string; /**
-                         * # Shipments Grid Component
-                         *
-                         * - The `<ShipmentsGrid />` component is used to view the user's list of shipments.
-                         *
-                         * @param ShipmentsGridProps The base props that will be passed into the `<ShipmentsGrid />` component.
-                         *
-                         * @returns Element An EmotionJSX.Element that will render the `<ShipmentsGrid />` component.
-                         *
-                         * @example
-                         * You can see how the `<Component />` is used in the `createElement` function call below.
-                         * ```tsx
-                         * export const Element = createElement(Component, ErrorFallback, {
-                         *   resources: { en },
-                         * });
-                         * ```
-                         *
-                         * <br />
-                         *
-                         * @see {@link ShipmentsGrid.Element | The **Element** created to render `<ShipmentsGrid />`}
-                         */
+                        notValidated: string;
                         validated: string;
                     };
                 };
@@ -976,6 +964,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -994,6 +983,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -1007,6 +997,8 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;

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

@@ -24,6 +24,9 @@ export declare const Element: ({ resources, ...props }: ThemeCreatorProps & {
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -620,8 +623,10 @@ export declare const Element: ({ resources, ...props }: ThemeCreatorProps & {
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -641,6 +646,17 @@ export declare const Element: ({ resources, ...props }: ThemeCreatorProps & {
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -687,6 +703,7 @@ export declare const Element: ({ resources, ...props }: ThemeCreatorProps & {
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -849,6 +866,7 @@ export declare const Element: ({ resources, ...props }: ThemeCreatorProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -867,6 +885,7 @@ export declare const Element: ({ resources, ...props }: ThemeCreatorProps & {
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -880,6 +899,8 @@ export declare const Element: ({ resources, ...props }: ThemeCreatorProps & {
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;

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

@@ -22,6 +22,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -618,8 +621,10 @@ export declare const Element: ({ resources, ...props }: object & {
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -639,6 +644,17 @@ export declare const Element: ({ resources, ...props }: object & {
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -685,6 +701,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -847,6 +864,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -865,6 +883,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -878,6 +897,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;