@shipengine/elements 2.3.1 → 2.5.0

package/src/elements/manage-warehouses/manage-warehouses.d.ts

@@ -135,7 +135,6 @@ export declare const Element: ({ resources, ...props }: object & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -143,7 +142,6 @@ export declare const Element: ({ resources, ...props }: object & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -157,7 +155,6 @@ export declare const Element: ({ resources, ...props }: object & {
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
@@ -358,18 +355,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;
@@ -416,6 +410,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;
@@ -524,32 +526,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": {
@@ -768,6 +812,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -786,6 +831,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;
@@ -861,6 +913,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -874,6 +927,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -898,6 +952,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;

package/src/elements/payment-method-settings/payment-method-settings-element.d.ts

@@ -118,7 +118,6 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -126,7 +125,6 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -140,7 +138,6 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
@@ -341,18 +338,15 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
             };
             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;
@@ -399,6 +393,14 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
             };
             "manage-warehouses": {
                 title: string;
@@ -507,32 +509,74 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
             };
             "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": {
@@ -734,6 +778,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -752,6 +797,13 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     "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;
@@ -827,6 +879,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -840,6 +893,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -864,6 +918,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;

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,32 +705,74 @@ 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;
                 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": {
@@ -952,6 +988,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -970,6 +1007,13 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     "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;
@@ -1013,44 +1057,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 };
                 packageCategories: {
                     customPackages: string;
-                }; /**
-                 * # Registered Purchase Label Element
-                 *
-                 * @param ElementProps The props necessary to render the `<PurchaseLabel.Element />` for shipment
-                 * based or sales order based label purchasing.
-                 *
-                 * @example
-                 * The `<Component />` is the source JSX that is rendered when you make use of the `PurchaseLabel`
-                 * Element directly.
-                 * ```tsx
-                 * <PurchaseLabel.Element
-                 *   key={currentSalesOrderId}
-                 *   printLabelLayout='4x6'
-                 *   shippingPresets={presets}
-                 *   onShipmentUpdated={(shipment) => console.log('Shipment Updated', shipment)}
-                 *   onRateSaved={(
-                 *     shipment: SE.SalesOrderShipment,
-                 *     rate?: SE.Rate,
-                 *     rateOptions?: SE.Rate[]
-                 *   ) => console.log('Rate Saved', shipment, rate, rateOptions)}
-                 *   onRatesCalculated={() => console.log('Rates Calculated')}
-                 *   onBeforeLabelCreate={onBeforeLabelPurchase}
-                 *   onLabelCreateSuccess={onLabelPurchaseSuccess}
-                 *   onLabelCreateFailure={(rate) => console.log('Label Purchase Failed', rate)}
-                 *   warehouseId={defaultWarehouseId}
-                 * />
-                 * ```
-                 *
-                 * <br />
-                 *
-                 * - Once a label has been purchased using this Element, you can take the `shipmentId` for the
-                 * associated shipment and pass it into the `<ShipmentSummary.Element />` Element in order to view
-                 * the shipment details.
-                 *
-                 * @see {@link PurchaseLabel.PurchaseLabelCommonProps | The **Common props** used in `<PurchaseLabel.Element />`}
-                 *
-                 * @see {@link ShipmentSummary.Element | The next step in the label purchase workflow `<ShipmentSummary.Element />`}
-                 */
+                };
                 packageCodes: {
                     package: string;
                 };
@@ -1075,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;
@@ -1082,6 +1094,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -1095,6 +1108,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -1119,6 +1133,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;