@shipengine/elements 1.7.0 → 1.9.0

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

@@ -224,6 +224,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 resultMessages: {
                     approved: string;
                     rejected: string;
+                    dpdwallet: string;
                 };
                 refund_process: string;
                 refund_rules: string;
@@ -243,6 +244,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     schedulePickup: string;
                     showItems: string;
                     void: string;
+                    download: string;
                 };
                 fields: {
                     dimensions: string;
@@ -262,9 +264,42 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 multipleShippingServices: string;
                 sections: {
                     labels: string;
+                    shipmentSummary: string;
                 };
                 noLabels: string;
             };
+            "vat-settings": {
+                addNew: string;
+                vatNumber: string;
+                vatRegistrationTooltip: string;
+                vatFormText: string;
+                vatFormRegisterLater: string;
+                vatNumberInputHint: string;
+                vatNumberInputPlaceholder: string;
+                verifiedVat: string;
+                vatFormErrors: {
+                    invalidFieldValue: string;
+                    verificationFailure: string;
+                    forbidden: string;
+                    connectionNotSupported: string;
+                    genericTitle: string;
+                    genericText: string;
+                };
+            };
+            "shipengine-carriers": {
+                title: string;
+                headers: {
+                    accountCarriers: string;
+                    carriers: string;
+                    settings: string;
+                };
+                actions: {
+                    status: {
+                        connected: string;
+                        notConnected: string;
+                    };
+                };
+            };
             "register-wallet": {
                 sections: {
                     setup: {
@@ -280,6 +315,17 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         addressSubTitle: string;
                         info: string;
                     };
+                    vatSettings: {
+                        title: string;
+                    };
+                    /**
+                     * # Purchase Label Component Props
+                     *
+                     * These are the shared props that will be passed into the `<PurchaseLabel.Element />`, and work
+                     * for either shipment-based or sales order-based label purchasing.
+                     *
+                     * @see {@link PurchaseLabel.Element | This prop types usage in `<PurchaseLabel.Element />`}
+                     */
                     carriers: {
                         title: string;
                         subtitle: string;
@@ -316,8 +362,48 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 };
             };
             "register-carrier": {
-                formTitle: string;
-                agreeToTerms: string;
+                formTitle: {
+                    default: string;
+                    new: string;
+                    edit: string;
+                };
+                notifications: {
+                    error: {
+                        title: string;
+                    };
+                };
+            };
+            "rate-details": {
+                total: string;
+                subtotal: string;
+                registerVat: string;
+                concepts: {
+                    confirmation: string;
+                    uncategorized: string;
+                    shipping: string;
+                    insurance: string;
+                    confirm: string;
+                    discount: string;
+                    fuel_charge: string;
+                    additional_fees: string;
+                    tariff: string;
+                    tax: string;
+                    delivery: string;
+                    handling: string;
+                    special_goods: string;
+                    pickup: string;
+                    location_fee: string;
+                    oversize: string;
+                    returns: string;
+                    notifications: string;
+                    tip: string;
+                    duties_and_taxes: string;
+                    brokerage_fee: string;
+                    admin_fee: string;
+                    adjustment: string;
+                    auctane_service_fee: string;
+                    product_price: string;
+                };
             };
             "purchase-label": {
                 title: string;
@@ -417,6 +503,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     rateSavings: string;
                     upsGroundSaverTermsAcknowledgement: string;
                     dhlExpressTermsAcknowledgement: string;
+                    noRateService: string;
                 };
                 requirements: {
                     noWarehouse: string;
@@ -440,7 +527,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     today: string;
                     viewMap: string;
                     otherLocations: string;
-                    noServicePointsFound: string;
+                    noServicePointsForService: string;
+                    error: string;
+                    paperless: string;
+                    localTimeDisclaimer: string;
                 };
                 shipToAddressFormFields: string;
                 sections: {
@@ -483,6 +573,8 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     action: string;
                 };
                 termsAndAgreementLinkText: {
+                    shipEngineToS: string;
+                    auctanePrivacyPolicy: string;
                     aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
@@ -499,7 +591,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 };
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
-                    "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
+                    "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string; /**
+                     * `onChangeShipmentFormMode` is an async/sync callback function that will be invoked each time
+                     * the user toggles the `Shipment Form Mode` between `Browse Rates` and `Selected Rate`.
+                     */
                     "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
                     RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
                     "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
@@ -507,42 +602,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
             };
-            "manage-defaults": {
-                label: {
-                    title: string;
-                    letter: {
-                        title: string;
-                        description: string;
-                    };
-                    purchase: {
-                        title: string;
-                        description: string;
-                    };
-                    thermal: {
-                        title: string;
-                        description: string;
-                    };
-                };
-                status: {
-                    saving: string;
-                    saved: string;
-                    savingFailed: string;
-                };
-                units: {
-                    title: string;
-                    dimensions: {
-                        title: string;
-                        standard: string;
-                        metric: string;
-                    };
-                    weight: {
-                        title: string;
-                        standard: string;
-                        g: string;
-                        kg: string;
-                    };
-                };
-            };
             "manage-warehouses": {
                 title: string;
                 addNew: string;
@@ -610,6 +669,42 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 currentBalance: string;
                 maximumBalanceAmount: string;
             };
+            "manage-defaults": {
+                label: {
+                    title: string;
+                    letter: {
+                        title: string;
+                        description: string;
+                    };
+                    purchase: {
+                        title: string;
+                        description: string;
+                    };
+                    thermal: {
+                        title: string;
+                        description: string;
+                    };
+                };
+                status: {
+                    saving: string;
+                    saved: string;
+                    savingFailed: string;
+                };
+                units: {
+                    title: string;
+                    dimensions: {
+                        title: string;
+                        standard: string;
+                        metric: string;
+                    };
+                    weight: {
+                        title: string;
+                        standard: string;
+                        g: string;
+                        kg: string;
+                    };
+                };
+            };
             "list-shipments": {
                 title: string;
                 headers: {
@@ -640,18 +735,31 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     };
                 };
             };
-            "shipengine-carriers": {
-                title: string;
-                headers: {
-                    accountCarriers: string;
-                    carriers: string;
-                    settings: string;
-                };
+            "connect-carrier": {
                 actions: {
-                    status: {
-                        connected: string;
-                        notConnected: string;
-                    };
+                    cancel: string;
+                    carrierSettings: string;
+                    connectCarriers: string;
+                    disconnect: string;
+                    disconnectCarrier: string;
+                };
+                noCarriersDescription: string;
+                registrationForm: {
+                    error: string;
+                    title: string;
+                    betaWarning: string;
+                };
+                search: string;
+                settingsModal: {
+                    closeDialog: string;
+                    header: string;
+                };
+                status: {
+                    connected: string;
+                };
+                disconnectDropdown: {
+                    toastTitle: string;
+                    toastBody: string;
                 };
             };
             common: {
@@ -775,7 +883,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     };
                     fields: {
                         contentsType: string;
-                        countryOfOrigin: string;
+                        countryOfOrigin: string; /**
+                         * `onRateSaved` is an async/sync callback function that will be invoked each time a rate is
+                         * saved by the user when rate shopping in the host application.
+                         */
                         description: string;
                         harmonizedTariffCode: string;
                         ifDeliveryFails: string;
@@ -805,7 +916,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         fundingSourceMetadata: string;
                         label: string;
                         labels: string;
-                        salesOrder: string;
+                        salesOrder: string; /**
+                         * `printLabelLayout` is a string that represents the label layout you would like to use when
+                         * purchasing a label. e.g. `4x6`
+                         */
                         shipment: string;
                         shipments: string;
                         warehouses: string;
@@ -842,6 +956,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     accountSettings: string;
                     carrier: string;
                     carriers: string;
+                    carrierServices: string;
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
@@ -932,6 +1047,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     gram: string;
                     kilogram: string;
                 };
+                ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
@@ -944,33 +1060,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
             };
-            "connect-carrier": {
-                actions: {
-                    cancel: string;
-                    carrierSettings: string;
-                    connectCarriers: string;
-                    disconnect: string;
-                    disconnectCarrier: string;
-                };
-                noCarriersDescription: string;
-                registrationForm: {
-                    error: string;
-                    title: string;
-                    betaWarning: string;
-                };
-                search: string;
-                settingsModal: {
-                    closeDialog: string;
-                    header: string;
-                };
-                status: {
-                    connected: string;
-                };
-                disconnectDropdown: {
-                    toastTitle: string;
-                    toastBody: string;
-                };
-            };
             "account-settings": {
                 messages: {
                     noFundingSources: string;
@@ -986,6 +1075,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;
+                    vatSettings: string;
                 };
             };
         };