@shipengine/elements 2.4.0 → 2.5.0

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

@@ -306,7 +306,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -314,7 +313,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -328,7 +326,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
@@ -350,11 +347,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     billing: {
                         title: string;
                         subtitleCard: 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.
-                         */
                         subtitleBilling: string;
                     };
                 };
@@ -538,18 +530,15 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
             };
             onboarding: {
                 title: string;
-                inlineTitle: string;
-                accountRegistration: {
-                    action: string;
+                confirmation: {
                     title: string;
-                    subtitle: string;
-                    welcome: string;
-                    messageLine1: string;
-                    partnerMessageLine1: string;
-                    messageLine2: string;
+                    warehouse: string;
+                    billingAddress: string;
+                    paymentMethod: string;
+                    action: string;
                 };
                 stepLabel: {
-                    accountRegistration: string;
+                    confirmation: string;
                     termsAgreement: string;
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
@@ -566,14 +555,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     };
                 };
                 success: {
-                    title: 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.
-                     */
+                    title: string;
                     subtitle: string;
                     action: string;
                 };
@@ -594,6 +576,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
                     aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
                 };
+                /**
+                 * `onBeforeRateSave` is an async/sync callback function that will be invoked before each time a user
+                 * saves a rate.
+                 */
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
                     "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
@@ -603,6 +589,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
             };
             "manage-warehouses": {
                 title: string;
@@ -711,18 +705,38 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
             };
             "list-shipments": {
                 title: string;
+                none: string;
                 headers: {
                     created: string;
-                    download: string;
+                    modified: string;
+                    shipping: string;
                     shipmentId: string;
-                    shipDate: string;
-                    shipTo: string;
+                    parcels: string;
+                    recipient: string;
+                    status: string;
+                };
+                status: {
+                    cancelled: string;
+                    purchased: string;
+                    readyToBuy: string;
+                    processing: string;
                 };
                 actions: {
                     download: {
                         pdf: string;
                     };
                 };
+                emptyState: {
+                    title: string;
+                    subtitle: string;
+                    filtersTitle: string;
+                    filtersSubtitle: string;
+                    viewAll: string;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "list-labels": {
                 title: string;
@@ -756,6 +770,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     void: string;
                     printForms: string;
                 };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "connect-carrier": {
                 actions: {
@@ -970,6 +988,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -1063,6 +1082,11 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     invalidStateProvince: string;
                     invalidString: string;
                     nonnegative: string;
+                    /**
+                     * # Purchase Label Component Props
+                     *
+                     * @see {@link PurchaseLabel.Component | The **Common Props** used in the `<PurchaseLabel /> component`}
+                     */
                     nonnegativeList: string;
                     positive: string;
                     positiveList: string;
@@ -1084,6 +1108,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -1108,6 +1133,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;

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

@@ -206,7 +206,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -214,7 +213,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -228,15 +226,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
                             title: string;
-                            /**
-                             * `onClickVoidLabel` is a callback function that will be invoked when the user clicks the
-                             * `Void Label` button.
-                             */
                             description: string;
                         };
                         carrier: {
@@ -435,18 +428,15 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             onboarding: {
                 title: string;
-                inlineTitle: string;
-                accountRegistration: {
-                    action: string;
+                confirmation: {
                     title: string;
-                    subtitle: string;
-                    welcome: string;
-                    messageLine1: string;
-                    partnerMessageLine1: string;
-                    messageLine2: string;
+                    warehouse: string;
+                    billingAddress: string;
+                    paymentMethod: string;
+                    action: string;
                 };
                 stepLabel: {
-                    accountRegistration: string;
+                    confirmation: string;
                     termsAgreement: string;
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
@@ -493,6 +483,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
             };
             "manage-warehouses": {
                 title: string;
@@ -601,18 +599,45 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "list-shipments": {
                 title: string;
+                none: string;
                 headers: {
                     created: string;
-                    download: string;
+                    modified: string;
+                    shipping: string;
                     shipmentId: string;
-                    shipDate: string;
-                    shipTo: string;
+                    parcels: string;
+                    recipient: string;
+                    status: string;
+                };
+                status: {
+                    cancelled: string;
+                    purchased: string;
+                    readyToBuy: string;
+                    processing: string;
                 };
+                /**
+                 * # Shipment Summary Component Props
+                 *
+                 * - These are the base props that will be passed into the `<ShipmentSummary />` component.
+                 *
+                 * @see {@link ShipmentSummary.Component | This prop types usage in the `<ShipmentSummary />` component}
+                 */
                 actions: {
                     download: {
                         pdf: string;
                     };
                 };
+                emptyState: {
+                    title: string;
+                    subtitle: string;
+                    filtersTitle: string;
+                    filtersSubtitle: string;
+                    viewAll: string;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "list-labels": {
                 title: string;
@@ -646,6 +671,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     void: string;
                     printForms: string;
                 };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "connect-carrier": {
                 actions: {
@@ -848,6 +877,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -962,6 +992,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -986,6 +1017,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;

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

@@ -0,0 +1,161 @@
+/// <reference types="react" />
+import { SE } from "@shipengine/js-api";
+import { IGridFilters } from "../../../components";
+import { ShipmentsGridProps } from "../shipments-grid";
+export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter, }: ShipmentsGridProps) => {
+    clearAllFilters: () => void;
+    filters: IGridFilters;
+    getGridData: () => {
+        serviceName: string | null | undefined;
+        addressValidation?: SE.AddressValidation | undefined;
+        advancedOptions?: {
+            additionalHandling?: boolean | undefined;
+            ancillaryEndorsementsOption?: string | undefined;
+            billToAccount?: string | undefined;
+            billToCountryCode?: string | undefined;
+            billToParty?: SE.BillToParties | undefined;
+            billToPostalCode?: string | undefined;
+            collectOnDelivery?: {
+                paymentAmount: SE.Money;
+                paymentType: SE.PaymentTypes;
+            } | undefined;
+            containsAlcohol?: boolean | undefined;
+            customField1?: string | undefined;
+            customField2?: string | undefined;
+            customField3?: string | undefined;
+            deliveredDutyPaid?: boolean | undefined;
+            dryIce?: boolean | undefined;
+            dryIceWeight?: SE.WeightWithUnit | undefined;
+            eventNotification?: boolean | undefined;
+            fedexFreight?: {
+                bookingConfirmation?: string | undefined;
+                shipperLoadAndCount?: string | undefined;
+            } | undefined;
+            freightClass?: string | undefined;
+            limitedQuantity?: boolean | undefined;
+            nonMachinable?: boolean | undefined;
+            originType?: SE.OriginTypes | undefined;
+            ownDocumentUpload?: boolean | undefined;
+            returnPickupAttempts?: number | undefined;
+            saturdayDelivery?: boolean | undefined;
+            shipperRelease?: boolean | undefined;
+            thirdPartyConsignee?: boolean | undefined;
+            useUpsGroundFreightPricing?: boolean | undefined;
+        } | undefined;
+        carrierId: string;
+        comparisonRateType?: string | undefined;
+        confirmation: SE.ConfirmationType;
+        createdAt: string;
+        customs?: SE.Customs | undefined;
+        externalOrderId?: string | undefined;
+        externalShipmentId?: string | undefined;
+        insuranceProvider: SE.InsuranceProviderType;
+        isReturn?: boolean | undefined;
+        items: SE.ShipmentItem[];
+        modifiedAt: string;
+        orderSourceCode: SE.OrderSourceCode | null;
+        originType?: SE.OriginTypes | undefined;
+        packages: SE.ShipmentPackage[];
+        returnTo: SE.Address | null;
+        serviceCode: string | null;
+        shipDate?: string | undefined;
+        shipFrom: SE.Address | null;
+        shipmentId: string;
+        shipmentNumber?: string | undefined;
+        shipmentStatus: SE.ShipmentStatus;
+        shippingRuleId?: string | undefined;
+        shipTo: SE.Address;
+        tags: {
+            name: string;
+        }[];
+        taxIdentifiers?: SE.TaxIdentifier[] | undefined;
+        totalWeight: SE.WeightWithUnit;
+        validateAddress?: SE.AddressValidationOptions | undefined;
+        warehouseId?: string | undefined;
+    }[];
+    isAnyFilterActive: boolean;
+    isError: boolean;
+    isLoading: boolean;
+    pageConfig: {
+        currentPage: number;
+        pagerProps: {
+            currentPage: number;
+            currentPageSize: number;
+            onPageSelect: (page: number) => void;
+            onPageSizeSelect: (pageSize: number) => void;
+        };
+        pagesAmount: number;
+        pageSize: number;
+        totalElements: number;
+    };
+    setFilters: import("react").Dispatch<import("react").SetStateAction<IGridFilters>>;
+    shipments: {
+        serviceName: string | null | undefined;
+        addressValidation?: SE.AddressValidation | undefined;
+        advancedOptions?: {
+            additionalHandling?: boolean | undefined;
+            ancillaryEndorsementsOption?: string | undefined;
+            billToAccount?: string | undefined;
+            billToCountryCode?: string | undefined;
+            billToParty?: SE.BillToParties | undefined;
+            billToPostalCode?: string | undefined;
+            collectOnDelivery?: {
+                paymentAmount: SE.Money;
+                paymentType: SE.PaymentTypes;
+            } | undefined;
+            containsAlcohol?: boolean | undefined;
+            customField1?: string | undefined;
+            customField2?: string | undefined;
+            customField3?: string | undefined;
+            deliveredDutyPaid?: boolean | undefined;
+            dryIce?: boolean | undefined;
+            dryIceWeight?: SE.WeightWithUnit | undefined;
+            eventNotification?: boolean | undefined;
+            fedexFreight?: {
+                bookingConfirmation?: string | undefined;
+                shipperLoadAndCount?: string | undefined;
+            } | undefined;
+            freightClass?: string | undefined;
+            limitedQuantity?: boolean | undefined;
+            nonMachinable?: boolean | undefined;
+            originType?: SE.OriginTypes | undefined;
+            ownDocumentUpload?: boolean | undefined;
+            returnPickupAttempts?: number | undefined;
+            saturdayDelivery?: boolean | undefined;
+            shipperRelease?: boolean | undefined;
+            thirdPartyConsignee?: boolean | undefined;
+            useUpsGroundFreightPricing?: boolean | undefined;
+        } | undefined;
+        carrierId: string;
+        comparisonRateType?: string | undefined;
+        confirmation: SE.ConfirmationType;
+        createdAt: string;
+        customs?: SE.Customs | undefined;
+        externalOrderId?: string | undefined;
+        externalShipmentId?: string | undefined;
+        insuranceProvider: SE.InsuranceProviderType;
+        isReturn?: boolean | undefined;
+        items: SE.ShipmentItem[];
+        modifiedAt: string;
+        orderSourceCode: SE.OrderSourceCode | null;
+        originType?: SE.OriginTypes | undefined;
+        packages: SE.ShipmentPackage[];
+        returnTo: SE.Address | null;
+        serviceCode: string | null;
+        shipDate?: string | undefined;
+        shipFrom: SE.Address | null;
+        shipmentId: string;
+        shipmentNumber?: string | undefined;
+        shipmentStatus: SE.ShipmentStatus;
+        shippingRuleId?: string | undefined;
+        shipTo: SE.Address;
+        tags: {
+            name: string;
+        }[];
+        taxIdentifiers?: SE.TaxIdentifier[] | undefined;
+        totalWeight: SE.WeightWithUnit;
+        validateAddress?: SE.AddressValidationOptions | undefined;
+        warehouseId?: string | undefined;
+    }[] | undefined;
+    shouldShowFilters: boolean;
+};