@shipengine/elements 2.0.0 → 2.1.0

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

@@ -350,6 +350,11 @@ 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;
                     };
                 };
@@ -365,6 +370,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -553,8 +559,21 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
-                    title: string;
+                    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.
+                     */
                     subtitle: string;
                     action: string;
                 };
@@ -598,6 +617,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -645,6 +665,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -744,7 +765,17 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     toastTitle: string;
                     toastBody: string;
                 };
-            };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: 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.
+             */
             common: {
                 actions: {
                     add: string;
@@ -846,17 +877,29 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
-                        merchandise: string;
                         /**
                          * `onLabelCreateFailure` is an async/sync callback function that will be invoked each time a
                          * label purchase fails.
                          */
+                        merchandise: string;
                         returnedGoods: string;
                         sample: string;
                     };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string; /**
+                         * `onLoad` is an async/sync callback provided by the host application that is invoked after the
+                         * element is loaded. (This may be useful to grab the shipmentId of a one-off label)
+                         */
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
                     currencyChange: string;
                     declarations: string;
                     descriptionTooltip: {
@@ -874,6 +917,11 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         sku: string;
                         value: string;
                         valueQuantity: string;
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
                     };
                     nonDelivery: {
                         returnToSender: string;
@@ -946,6 +994,8 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -1024,6 +1074,16 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     gram: string;
                     kilogram: string;
                 };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                    };
+                };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -1039,7 +1099,11 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {

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

@@ -233,6 +233,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         };
                         poBox: {
                             title: string;
+                            /**
+                             * `onClickVoidLabel` is a callback function that will be invoked when the user clicks the
+                             * `Void Label` button.
+                             */
                             description: string;
                         };
                         carrier: {
@@ -265,6 +269,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -457,6 +462,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -502,6 +513,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -549,6 +561,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -648,6 +661,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -752,6 +768,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -759,6 +776,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string;
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
                     currencyChange: string;
                     declarations: string;
                     descriptionTooltip: {
@@ -776,6 +801,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         sku: string;
                         value: string;
                         valueQuantity: string;
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
                     };
                     nonDelivery: {
                         returnToSender: string;
@@ -848,6 +878,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -926,6 +958,16 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                    };
+                };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -941,7 +983,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {

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

@@ -179,6 +179,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -363,6 +364,12 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -408,6 +415,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -455,6 +463,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -554,6 +563,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -656,6 +668,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -663,6 +676,14 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string;
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
                     currencyChange: string;
                     declarations: string;
                     descriptionTooltip: {
@@ -680,6 +701,11 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         sku: string;
                         value: string;
                         valueQuantity: string;
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
                     };
                     nonDelivery: {
                         returnToSender: string;
@@ -752,6 +778,8 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -830,6 +858,16 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     gram: string;
                     kilogram: string;
                 };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                    };
+                };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -845,7 +883,11 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {

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

@@ -189,6 +189,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -373,6 +374,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -418,6 +425,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -465,6 +473,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -564,6 +573,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -666,6 +678,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -673,6 +686,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string;
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
                     currencyChange: string;
                     declarations: string;
                     descriptionTooltip: {
@@ -690,6 +711,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         sku: string;
                         value: string;
                         valueQuantity: string;
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
                     };
                     nonDelivery: {
                         returnToSender: string;
@@ -762,6 +788,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -840,6 +868,16 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                    };
+                };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -855,7 +893,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {

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

@@ -176,6 +176,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -360,6 +361,12 @@ export declare const Element: ({ resources, ...props }: object & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -405,6 +412,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -452,6 +460,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -551,6 +560,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -653,6 +665,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -660,6 +673,14 @@ export declare const Element: ({ resources, ...props }: object & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string;
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
                     currencyChange: string;
                     declarations: string;
                     descriptionTooltip: {
@@ -677,6 +698,11 @@ export declare const Element: ({ resources, ...props }: object & {
                         sku: string;
                         value: string;
                         valueQuantity: string;
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
                     };
                     nonDelivery: {
                         returnToSender: string;
@@ -749,6 +775,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -827,6 +855,16 @@ export declare const Element: ({ resources, ...props }: object & {
                     gram: string;
                     kilogram: string;
                 };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                    };
+                };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -842,7 +880,11 @@ export declare const Element: ({ resources, ...props }: object & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {