@shipengine/elements 2.3.1 → 2.5.0

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

@@ -117,7 +117,6 @@ export declare const Element: ({ resources, ...props }: object & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -125,7 +124,6 @@ export declare const Element: ({ resources, ...props }: object & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -139,7 +137,6 @@ export declare const Element: ({ resources, ...props }: object & {
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
@@ -340,18 +337,15 @@ export declare const Element: ({ resources, ...props }: object & {
             };
             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;
@@ -398,6 +392,14 @@ export declare const Element: ({ resources, ...props }: object & {
                     "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
             };
             "manage-warehouses": {
                 title: string;
@@ -506,32 +508,74 @@ export declare const Element: ({ resources, ...props }: object & {
             };
             "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;
                 headers: {
                     created: string;
-                    download: string;
-                    labelId: string;
-                    service: string;
-                    shipTo: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    shipping: string;
+                    shipDate: string;
+                    status: string;
+                };
+                empty: {
+                    title: string;
+                    subtitle: string;
+                };
+                emptyWithFilters: {
+                    title: string;
+                    subtitle: string;
+                    button: string;
+                };
+                status: {
+                    voided: string;
+                    error: string;
+                    completed: string;
+                    processing: string;
                 };
                 actions: {
-                    download: {
-                        pdf: string;
-                    };
+                    title: string;
+                    print: string;
+                    void: string;
+                    printForms: string;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
                 };
             };
             "connect-carrier": {
@@ -733,6 +777,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -751,6 +796,13 @@ export declare const Element: ({ resources, ...props }: object & {
                     "row-count_one": string;
                     "row-count_other": string;
                     rows: string;
+                    clearAll: string;
+                    shipmentId: string;
+                    shipmentIdFilter: string;
+                    apply: string;
+                    clear: string;
+                    search: string;
+                    shipmentIdHint: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -826,6 +878,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -839,6 +892,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -863,6 +917,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;

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

@@ -208,7 +208,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -216,7 +215,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -230,13 +228,15 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
                             title: string;
                             description: string;
-                        };
+                        }; /**
+                         * `onSuccess` is a callback function that will be invoked when the request to void a given
+                         * shipping label is successful.
+                         */
                         carrier: {
                             title: string;
                             confirmAddress: string;
@@ -461,44 +461,39 @@ 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;
                 };
                 warehouse: {
                     title: string;
+                    /**
+                     * # Void Label Component Props
+                     *
+                     * - These are the base props that will be passed into the `<VoidLabel />` component.
+                     *
+                     * @see {@link VoidLabel.Component | This prop types usage in the `<VoidLabel />` component}
+                     */
                     subtitle: string;
                     inlineMessage: string;
                 };
                 errors: {
                     noCarriers: {
-                        /**
-                         * `onSuccess` is a callback function that will be invoked when the request to void a given
-                         * shipping label is successful.
-                         */
                         title: string;
                         subtitle: string;
                     };
                 };
                 success: {
-                    title: string; /**
-                     * `onViewShipment` is a callback function that will be invoked when the user clicks the
-                     * `View Shipment` button. This will take you back to the
-                     * {@link ShipmentSummary.Element | `Shipment Summary Element`} for the given shipment, where you
-                     * will be able to see the voided label listed.
-                     */
+                    title: string;
                     subtitle: string;
                     action: string;
                 };
@@ -528,6 +523,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;
@@ -638,32 +641,74 @@ 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;
                 };
                 actions: {
                     download: {
                         pdf: string;
                     };
                 };
+                emptyState: {
+                    title: string;
+                    subtitle: string;
+                    filtersTitle: string;
+                    filtersSubtitle: string;
+                    viewAll: string;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "list-labels": {
                 title: string;
                 headers: {
                     created: string;
-                    download: string;
-                    labelId: string;
-                    service: string;
-                    shipTo: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    shipping: string;
+                    shipDate: string;
+                    status: string;
+                };
+                empty: {
+                    title: string;
+                    subtitle: string;
+                };
+                emptyWithFilters: {
+                    title: string;
+                    subtitle: string;
+                    button: string;
+                };
+                status: {
+                    voided: string;
+                    error: string;
+                    completed: string;
+                    processing: string;
                 };
                 actions: {
-                    download: {
-                        pdf: string;
-                    };
+                    title: string;
+                    print: string;
+                    void: string;
+                    printForms: string;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
                 };
             };
             "connect-carrier": {
@@ -870,6 +915,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -888,6 +934,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "row-count_one": string;
                     "row-count_other": string;
                     rows: string;
+                    clearAll: string;
+                    shipmentId: string;
+                    shipmentIdFilter: string;
+                    apply: string;
+                    clear: string;
+                    search: string;
+                    shipmentIdHint: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -963,6 +1016,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -976,6 +1030,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -1000,6 +1055,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;

package/src/hooks/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./options";
 export * from "./use-address-validation";
 export * from "./use-black-box-detection";
+export * from "./use-get-service-name";
 export * from "./use-helpers";
 export * from "./use-nested-form";
 export * from "./use-page-layout";

package/src/hooks/use-get-service-name.d.ts

@@ -0,0 +1,4 @@
+import { SE } from '@shipengine/js-api';
+export declare const useGetServiceName: () => {
+    getServiceName: (itemSelected: SE.Label | SE.Shipment) => string | undefined | null;
+};

package/src/locales/en/index.d.ts

@@ -113,7 +113,6 @@ declare const _default: {
             setup: {
                 title: string;
                 subtitle: string;
-                hiddenTermsSubtitle: string;
                 descriptionTitle: string;
                 description: string;
             };
@@ -121,7 +120,6 @@ declare const _default: {
                 title: string;
                 cardSubTitle: string;
                 addressSubTitle: string;
-                info: string;
             };
             vatSettings: {
                 title: string;
@@ -135,7 +133,6 @@ declare const _default: {
                     title: string;
                 };
                 info: {
-                    title: string;
                     description: string;
                 };
                 poBox: {
@@ -336,18 +333,15 @@ declare const _default: {
     };
     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;
@@ -394,6 +388,14 @@ declare const _default: {
             "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
             UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
         };
+        tooltip: {
+            warehouse: string;
+        };
+        welcomePage: {
+            title: string;
+            message: string;
+            action: string;
+        };
     };
     "manage-warehouses": {
         title: string;
@@ -502,32 +504,74 @@ declare const _default: {
     };
     "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;
         headers: {
             created: string;
-            download: string;
-            labelId: string;
-            service: string;
-            shipTo: string;
+            shipmentId: string;
+            parcels: string;
+            recipient: string;
+            shipping: string;
+            shipDate: string;
+            status: string;
+        };
+        empty: {
+            title: string;
+            subtitle: string;
+        };
+        emptyWithFilters: {
+            title: string;
+            subtitle: string;
+            button: string;
+        };
+        status: {
+            voided: string;
+            error: string;
+            completed: string;
+            processing: string;
         };
         actions: {
-            download: {
-                pdf: string;
-            };
+            title: string;
+            print: string;
+            void: string;
+            printForms: string;
+        };
+        errorMessages: {
+            title: string;
+            subtitle: string;
         };
     };
     "connect-carrier": {
@@ -729,6 +773,7 @@ declare const _default: {
             emailIsRequired: string;
             unknown: string;
             noRatesAvailable: string;
+            refreshAndTryAgain: string;
         };
         errorTypes: {
             accountStatus: string;
@@ -747,6 +792,13 @@ declare const _default: {
             "row-count_one": string;
             "row-count_other": string;
             rows: string;
+            clearAll: string;
+            shipmentId: string;
+            shipmentIdFilter: string;
+            apply: string;
+            clear: string;
+            search: string;
+            shipmentIdHint: string;
         };
         insuranceProviders: {
             carrier: string;
@@ -822,6 +874,7 @@ declare const _default: {
             requiredList: string;
             tooFewCharacters: string;
             tooManyCharacters: string;
+            requiredShipmentId: string;
         };
         shippingPresets: {
             apply: string;
@@ -835,6 +888,7 @@ declare const _default: {
             agreeToTerms: string;
             carriersTitle: string;
             fundingSourceTitle: string;
+            shipEngineTitle: string;
         };
         weight: {
             ounces: string;
@@ -859,6 +913,7 @@ declare const _default: {
                 printForms: string;
                 edit: string;
                 remove: string;
+                viewDetails: string;
             };
         };
         ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;