@shipengine/elements 1.7.0 → 1.9.0

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

@@ -1,6 +1,7 @@
 /// <reference types="react" />
 import { SE } from "@shipengine/alchemy";
 import { ShipmentFeatures } from "../../components/templates/shipment";
+import { VatSettingsFeatures } from "../../features";
 /**
  * # View Shipment Component Props
  *
@@ -12,7 +13,7 @@ export type ComponentProps = {
     /**
      * `features` is a set of feature flags you would like to enable or disable in this component.
      */
-    features?: ShipmentFeatures;
+    features?: ShipmentFeatures & VatSettingsFeatures;
     /**
      * `onClickPrintLabel` is a callback function that will be invoked when the user clicks the
      * `Print Label` button.
@@ -125,6 +126,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 resultMessages: {
                     approved: string;
                     rejected: string;
+                    dpdwallet: string;
                 };
                 refund_process: string;
                 refund_rules: string;
@@ -144,6 +146,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     schedulePickup: string;
                     showItems: string;
                     void: string;
+                    download: string;
                 };
                 fields: {
                     dimensions: string;
@@ -155,20 +158,55 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipDate: string;
                     shipTo: string;
                     warehouse: string;
-                    weight: string;
+                    weight: string; /**
+                     * `features` is a set of feature flags you would like to enable or disable in this component.
+                     */
                     insuredValue: string;
                     deliveryConfirmation: string;
                 };
                 highVolumeForms: string;
                 multipleShippingServices: string;
                 sections: {
-                    labels: string; /**
+                    labels: string;
+                    shipmentSummary: string; /**
                      * `onClickVoidLabel` is a callback function that will be invoked when the user clicks the
                      * `Void Label` button.
                      */
                 };
                 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: {
@@ -184,6 +222,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         addressSubTitle: string;
                         info: string;
                     };
+                    vatSettings: {
+                        title: string;
+                    };
                     carriers: {
                         title: string;
                         subtitle: string;
@@ -193,10 +234,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                             title: string;
                         };
                         info: {
-                            title: string; /**
-                             * `onClickPurchaseLabel` is a callback function that will be invoked when the user clicks the
-                             * `Purchase Label` button.
-                             */
+                            title: string;
                             description: string;
                         };
                         poBox: {
@@ -223,8 +261,51 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
             };
             "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; /**
+                     * `onClickPrintLabel` is a callback function that will be invoked when the user clicks the
+                     * `Print Label` button.
+                     */
+                    adjustment: string;
+                    auctane_service_fee: string;
+                    product_price: string;
+                };
             };
             "purchase-label": {
                 title: string;
@@ -244,9 +325,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     insufficientBalanceCTA: string;
                 };
                 cta: {
-                    addPackageDetails: string; /**
-                     * `features` is a set of feature flags you would like to enable or disable in this component.
-                     */
+                    addPackageDetails: string;
                 };
                 errorMessages: {
                     customsItemsRequired: string;
@@ -315,6 +394,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     rateSavings: string;
                     upsGroundSaverTermsAcknowledgement: string;
                     dhlExpressTermsAcknowledgement: string;
+                    noRateService: string;
                 };
                 requirements: {
                     noWarehouse: string;
@@ -338,7 +418,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     today: string;
                     viewMap: string;
                     otherLocations: string;
-                    noServicePointsFound: string;
+                    noServicePointsForService: string;
+                    error: string;
+                    paperless: string;
+                    localTimeDisclaimer: string;
                 };
                 shipToAddressFormFields: string;
                 sections: {
@@ -381,6 +464,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     action: string;
                 };
                 termsAndAgreementLinkText: {
+                    shipEngineToS: string;
+                    auctanePrivacyPolicy: string;
                     aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
@@ -405,45 +490,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     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;
-                    /**
-                     * `features` is a set of feature flags you would like to enable or disable in this component.
-                     */
-                    dimensions: {
-                        title: string;
-                        standard: string;
-                        metric: string;
-                    };
-                    weight: {
-                        title: string;
-                        standard: string;
-                        g: string;
-                        kg: string;
-                    };
-                };
-            };
             "manage-warehouses": {
                 title: string;
                 addNew: string;
@@ -471,22 +517,30 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     error: {
                         title: string;
                         message: string;
-                    };
+                    }; /**
+                     * # View Shipment Component Props
+                     *
+                     * - These are the base props that will be passed into the `<ViewShipment />` component.
+                     *
+                     * @see {@link ViewShipment.Component | This prop types usage in the `<ViewShipment />` component}
+                     */
                     isEnabledCTA: string;
                     isEnabled: string;
                     isLoading: string;
                     lowBalancePurchaseThreshold: string;
-                    /**
+                    maximumPurchasesPerDay: string; /**
                      * `features` is a set of feature flags you would like to enable or disable in this component.
                      */
-                    maximumPurchasesPerDay: string;
                     purchaseAmount: string;
                     readSettings: string;
                 };
                 addFunds: {
                     custom: string;
                     error: {
-                        title: string;
+                        title: string; /**
+                         * `onClickPurchaseLabel` is a callback function that will be invoked when the user clicks the
+                         * `Purchase Label` button.
+                         */
                         message: string;
                     };
                     isLoading: string;
@@ -514,6 +568,42 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 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: {
@@ -544,18 +634,31 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                 };
             };
-            "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: {
@@ -587,10 +690,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         addressLine2: string;
                         cityLocality: string;
                         stateProvince: string;
-                        postalCode: string; /**
-                         * `onClickPrintLabel` is a callback function that will be invoked when the user clicks the
-                         * `Print Label` button.
-                         */
+                        postalCode: string;
                         phone: string;
                         email: string;
                         addressResidentialIndicator: string;
@@ -698,6 +798,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     invalidNameOrCompany: string;
                     parsingFailure: string;
                     incompleteLabelPurchaseRequirements: string;
+                    /**
+                     * # View Shipment Element Props
+                     *
+                     * - These are the base props that will be passed into the `<ViewShipment />` element.
+                     *
+                     * @see {@link ViewShipment.Element | See the full type that `typeof Element` will return}
+                     */
                     shipmentCancelled: string;
                     unableToLoad: {
                         accountSettings: string;
@@ -745,6 +852,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     accountSettings: string;
                     carrier: string;
                     carriers: string;
+                    carrierServices: string;
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
@@ -835,6 +943,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
@@ -847,35 +956,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 "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; /**
-                     * `features` is a set of feature flags you would like to enable or disable in this component.
-                     */
-                };
-                search: string;
-                settingsModal: {
-                    closeDialog: string;
-                    header: string;
-                };
-                status: {
-                    connected: string;
-                };
-                disconnectDropdown: {
-                    toastTitle: string;
-                    toastBody: string;
-                };
-            };
             "account-settings": {
                 messages: {
                     noFundingSources: string;
@@ -891,6 +971,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;
+                    vatSettings: string;
                 };
             };
         };

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

@@ -1,8 +1,8 @@
 import { SE } from "@shipengine/alchemy";
 export type ActionsProps = {
-    onComplete: (request: SE.VoidRequest, shipment: SE.SalesOrderShipment) => void;
-    onSubmit: () => Promise<void>;
-    onViewShipment: (shipment: SE.SalesOrderShipment) => void;
+    onComplete?: (request: SE.VoidRequest, shipment: SE.SalesOrderShipment) => void;
+    onSubmit?: () => Promise<void>;
+    onViewShipment?: (shipment: SE.SalesOrderShipment) => void;
     shipment: SE.SalesOrderShipment;
     voidRequest?: SE.VoidRequest;
 };

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

@@ -1,6 +1,7 @@
-import { SE } from "@shipengine/alchemy";
+import type { SE } from "@shipengine/alchemy";
 type MessageProps = {
+    carrier?: SE.Carrier["carrierCode"];
     voidRequest?: SE.VoidRequest;
 };
-export declare const Message: ({ voidRequest }: MessageProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Message: ({ voidRequest, carrier }: MessageProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export {};