@shipengine/elements 1.5.0 → 1.6.0

package/src/elements/list-carriers/list-carriers.d.ts

@@ -1,4 +1,5 @@
-import { ListCarriersFeatures } from "../../components/templates/list-carriers";
+/// <reference types="react" />
+import { ListCarriersFeatures } from "../../features/list-carriers";
 /**
  * # List-Carriers Props
  *
@@ -34,3 +35,811 @@ export type ComponentProps = {
  * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<List-Carriers />` component}
  */
 export declare const Component: ({ features }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Element: ({ resources, ...props }: ComponentProps & {
+    resources?: {
+        en: {
+            "wallet-history": {
+                actions: {
+                    downloadCsv: string;
+                    chooseDate: string;
+                    tryAgain: string;
+                };
+                errors: {
+                    failureToFetch: string;
+                };
+                dateRange: string;
+                details: {
+                    inaccurateWeight: string;
+                };
+                historyOptions: {
+                    custom: string;
+                    last30days: string;
+                    thisMonth: string;
+                    lastMonth: string;
+                };
+            };
+            "void-label": {
+                title: string;
+                actions: {
+                    complete: string;
+                    confirmVoid: string;
+                    viewShipment: string;
+                };
+                errorMessages: {
+                    labelIdRequired: string;
+                };
+                resultMessages: {
+                    approved: string;
+                    rejected: string;
+                };
+                refund_process: string;
+                refund_rules: string;
+                resultTitles: {
+                    approved: string;
+                    rejected: string;
+                };
+                voidedOn: string;
+            };
+            "view-shipment": {
+                title: string;
+                actions: {
+                    buyAnotherLabel: string;
+                    hideItems: string;
+                    printForms: string;
+                    printLabel: string;
+                    schedulePickup: string;
+                    showItems: string;
+                    void: string;
+                };
+                fields: {
+                    dimensions: string;
+                    estimatedShipping: string;
+                    items: string;
+                    orderDate: string;
+                    orderValue: string;
+                    requestedShipping: string;
+                    shipDate: string;
+                    shipTo: string;
+                    warehouse: string;
+                    weight: string;
+                    insuredValue: string;
+                    deliveryConfirmation: string;
+                };
+                highVolumeForms: string;
+                multipleShippingServices: string;
+                sections: {
+                    labels: string;
+                };
+                noLabels: string;
+            };
+            "register-wallet": {
+                sections: {
+                    setup: {
+                        title: string;
+                        subtitle: string;
+                        descriptionTitle: string;
+                        description: string;
+                    };
+                    billing: {
+                        title: string;
+                        cardSubTitle: string;
+                        addressSubTitle: string;
+                        info: string;
+                    };
+                    carriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                    notifications: {
+                        error: {
+                            title: string;
+                        };
+                        info: {
+                            title: string;
+                            description: string;
+                        };
+                        poBox: {
+                            title: string;
+                            description: string;
+                        };
+                        carrier: {
+                            title: string;
+                            confirmAddress: string;
+                            description: string;
+                        };
+                        blackBox: {
+                            description: string;
+                        };
+                    };
+                };
+                settings: {
+                    title: string;
+                    billing: {
+                        title: string;
+                        subtitleCard: string;
+                        subtitleBilling: string;
+                    };
+                };
+            };
+            "register-carrier": {
+                formTitle: string;
+                agreeToTerms: string;
+            };
+            "purchase-label": {
+                title: string;
+                actions: {
+                    calculateRates_one: string;
+                    calculateRates_other: string;
+                    hideItems: string;
+                    purchaseLabel: string;
+                    purchaseNow: string;
+                    showItems: string;
+                    showMoreRates: string;
+                    showFewerRates: string;
+                    saveRate: string;
+                };
+                balance: {
+                    currentBalance: string;
+                    insufficientBalanceCTA: string;
+                };
+                cta: {
+                    addPackageDetails: string;
+                };
+                errorMessages: {
+                    customsItemsRequired: string;
+                    invalidAddress: string;
+                    noRates: string;
+                    salesOrderNotLoaded: string;
+                    unsupportedAddress: string;
+                    saveRateFailedMessage: string;
+                    saveRateFailedTitle: string;
+                };
+                errorTypes: {
+                    results: string;
+                };
+                fields: {
+                    "requires-additional-handling": string;
+                    addOns: string;
+                    contentDescription: string;
+                    confirmation: string;
+                    dimensions: {
+                        length: string;
+                        width: string;
+                        height: string;
+                    };
+                    dimensionsGroup: string;
+                    estimatedShipping: string;
+                    insurance: string;
+                    insuranceProvider: string;
+                    insuredValue: string;
+                    items: string;
+                    orderDate: string;
+                    orderValue: string;
+                    packageCode: string;
+                    requestedShipping: string;
+                    shipDate: string;
+                    service: string;
+                    shipTo: string;
+                    addShipToAddress: string;
+                    warehouse: string;
+                    weight: {
+                        whole: string;
+                        fractional: string;
+                    };
+                    weightGroup: string;
+                    today: string;
+                };
+                hints: {
+                    contentDescription: string;
+                };
+                loading: {
+                    calculatingRates: string;
+                };
+                modes: {
+                    browseRates: string;
+                    selectService: string;
+                };
+                multipleShippingServices: string;
+                schemaErrors: {
+                    shipFromUnitedStatesOnly: string;
+                    shipFromAddressRequired: string;
+                    needToAcknowledge: string;
+                };
+                rates: {
+                    uspsMediaMailAcknowledgement: string;
+                    uspsFirstClassMailAcknowledgement_leof: string;
+                    rateSavings: string;
+                    upsGroundSaverTermsAcknowledgement: string;
+                    dhlExpressTermsAcknowledgement: string;
+                };
+                requirements: {
+                    noWarehouse: string;
+                    noCarrier: string;
+                    noWarehouseOrCarrier: string;
+                };
+                servicePoints: {
+                    searchLabel: string;
+                    noRatesForType: string;
+                    dropOff: string;
+                    pickUp: string;
+                    closed: string;
+                    hideLocations: string;
+                    moreLocations: string;
+                    nearestLocation: string;
+                    open: string;
+                    nextOpeningDay: string;
+                    until: string;
+                    selected: string;
+                    select: string;
+                    today: string;
+                    viewMap: string;
+                    otherLocations: string;
+                    noServicePointsFound: string;
+                };
+                shipToAddressFormFields: string;
+                sections: {
+                    customsForm: string;
+                    shipment: string;
+                    rate_one: string;
+                    rate_other: string;
+                    payment: string;
+                };
+            };
+            "payment-method": {
+                title: string;
+            };
+            onboarding: {
+                title: string;
+                inlineTitle: string;
+                accountRegistration: {
+                    action: string;
+                    title: string;
+                    subtitle: string;
+                    welcome: string;
+                    messageLine1: string;
+                    partnerMessageLine1: string;
+                    messageLine2: string;
+                };
+                stepLabel: {
+                    accountRegistration: string;
+                    termsAgreement: string;
+                    shipFromAddress: string;
+                    fundingAndCarrierConnection: string;
+                };
+                warehouse: {
+                    title: string;
+                    subtitle: string;
+                    inlineMessage: string;
+                };
+                success: {
+                    title: string;
+                    subtitle: string;
+                    action: string;
+                };
+                termsAndAgreementLinkText: {
+                    aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
+                    "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
+                    "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
+                    "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
+                    aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
+                    "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
+                    "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
+                    "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
+                    aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
+                    "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
+                    aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
+                };
+                termsAndAgreementTitles: {
+                    "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
+                    "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
+                    "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
+                    RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
+                    "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": 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;
+                editWarehouse: string;
+                contactName: string;
+                default: string;
+                isDefault: string;
+                locationName: string;
+                residentialAddress: string;
+                returnTo: string; /**
+                 * `features` is a set of feature flags you would like to enable or disable in this component.
+                 */
+                returnToAddressIsDifferent: string;
+                setDefault: string;
+                shipFrom: string;
+            };
+            "manage-funding": {
+                actions: {
+                    addFunds: string;
+                    addFundsAndPurchase: string;
+                    addNow: string;
+                    saveRule: string;
+                };
+                autoFunding: {
+                    edit: string;
+                    editSettings: string;
+                    error: {
+                        title: string;
+                        message: string;
+                    };
+                    isEnabledCTA: string;
+                    isEnabled: string;
+                    isLoading: string;
+                    lowBalancePurchaseThreshold: string;
+                    maximumPurchasesPerDay: string;
+                    purchaseAmount: string;
+                    readSettings: string;
+                };
+                addFunds: {
+                    custom: string;
+                    error: {
+                        title: string;
+                        message: string;
+                    };
+                    isLoading: string;
+                    labels: {
+                        amount: string;
+                    };
+                    minimumPurchaseAmount: string;
+                    other: string;
+                };
+                fundAndPurchase: {
+                    finalBalance: string;
+                    insufficientFunds: string;
+                    insufficientFundsTitle: string;
+                    negativeBalance: string;
+                    negativeBalanceTitle: string;
+                    newBalance: string;
+                };
+                errors: {
+                    balanceUnknown: string;
+                    unableToFindBalance: string;
+                };
+                byoc: {
+                    invoiceNotification: string;
+                };
+                currentBalance: string;
+                maximumBalanceAmount: string;
+            };
+            "list-shipments": {
+                title: string;
+                headers: {
+                    created: string;
+                    download: string;
+                    shipmentId: string;
+                    shipDate: string;
+                    shipTo: string;
+                };
+                actions: {
+                    download: {
+                        pdf: string;
+                    };
+                };
+            };
+            "list-labels": {
+                title: string;
+                headers: {
+                    created: string;
+                    download: string;
+                    labelId: string;
+                    service: string;
+                    shipTo: string;
+                };
+                actions: {
+                    download: {
+                        pdf: string;
+                    };
+                };
+            };
+            "list-carriers": {
+                title: string;
+                headers: {
+                    accountCarriers: string;
+                    carriers: string;
+                    settings: string;
+                };
+                actions: {
+                    status: {
+                        connected: string;
+                        notConnected: string;
+                    };
+                };
+            };
+            common: {
+                actions: {
+                    add: string;
+                    cancel: string;
+                    close: string;
+                    confirm: string;
+                    connect: string;
+                    continue: string;
+                    delete: string;
+                    edit: string;
+                    hide: string;
+                    parse: string;
+                    purchase: string;
+                    remove: string;
+                    save: string;
+                    skipForNow: string;
+                    submit: string;
+                    tryAgain: string;
+                };
+                address: {
+                    fields: {
+                        name: string;
+                        company: string;
+                        county: string;
+                        countryCode: string;
+                        addressLine1: string;
+                        addressLine2: string;
+                        cityLocality: string;
+                        stateProvince: string;
+                        postalCode: string;
+                        phone: string;
+                        email: string;
+                        addressResidentialIndicator: string;
+                    };
+                    noResults: string;
+                    subFields: {
+                        optional: string;
+                    };
+                    parserFields: {
+                        fullAddress: string;
+                    };
+                    paste: string;
+                    preference: {
+                        confirm: string;
+                        addressNotValidated: string;
+                        modified: string;
+                        title: string;
+                        originalAddress: string;
+                        matchedAddress: string;
+                        unableToValidate: string;
+                        use: {
+                            originalAddress: string;
+                            matchedAddress: string;
+                        };
+                    };
+                    validation: {
+                        notValidated: string;
+                        validated: string;
+                    };
+                };
+                billing: {
+                    fields: {
+                        differentBillingAddress: string;
+                        name: string;
+                        cardNumber: string;
+                        expiration: string;
+                        cvv: string;
+                        cvvPlaceholder: string;
+                        expirationPlaceholder: string;
+                        cardNumberPlaceholder: string;
+                    };
+                };
+                carriers: {
+                    fields: {
+                        agreement: string;
+                    };
+                    terms: {
+                        agreeToTerms: string;
+                        title: string;
+                    };
+                };
+                charsetWarnings: {
+                    name: {
+                        message: string;
+                    };
+                    address: {
+                        message: string;
+                        title: string;
+                    };
+                };
+                confirmationTypes: {
+                    adultSignature: string;
+                    delivery: string;
+                    deliveryMailed: string;
+                    directSignature: string;
+                    none: string;
+                    signature: string;
+                    verbalConfirmation: string;
+                };
+                customs: {
+                    addDeclaration: string;
+                    contents: {
+                        documents: string;
+                        gift: string;
+                        merchandise: string;
+                        returnedGoods: string;
+                        sample: string;
+                    };
+                    currencyChange: string;
+                    declarations: string;
+                    descriptionTooltip: {
+                        message: string;
+                        example1: string;
+                        example2: string;
+                    };
+                    fields: {
+                        contentsType: string;
+                        countryOfOrigin: string;
+                        description: string;
+                        harmonizedTariffCode: string;
+                        ifDeliveryFails: string;
+                        quantity: string;
+                        sku: string;
+                        value: string;
+                        valueQuantity: string;
+                    };
+                    nonDelivery: {
+                        returnToSender: string;
+                        treatAsAbandoned: string;
+                    };
+                    removeAllDeclarations: string;
+                    total: string;
+                };
+                errorMessages: {
+                    invalidNameOrCompany: string;
+                    parsingFailure: string;
+                    incompleteLabelPurchaseRequirements: string;
+                    shipmentCancelled: string;
+                    unableToLoad: {
+                        accountSettings: string;
+                        autoFundingSettings: string;
+                        carrier: string;
+                        carriers: string;
+                        connectCarrierForm: string;
+                        fundingSourceMetadata: string;
+                        label: string;
+                        labels: string;
+                        salesOrder: string;
+                        shipment: string;
+                        shipments: string;
+                        warehouses: string;
+                    };
+                    emailIsRequired: string;
+                    unknown: string;
+                    noRatesAvailable: string;
+                };
+                errorTypes: {
+                    accountStatus: string;
+                    businessRules: string;
+                    integrations: string;
+                    purchase: string;
+                    rateInvalid: string;
+                    saveRate: string;
+                    security: string;
+                    shipmentStatus: string;
+                    system: string;
+                    unknown: string;
+                    validation: string;
+                };
+                grid: {
+                    "row-count_one": string;
+                    "row-count_other": string;
+                    rows: string;
+                };
+                insuranceProviders: {
+                    carrier: string;
+                    none: string;
+                    shipsurance: string;
+                    thirdParty: string;
+                };
+                loading: {
+                    accountSettings: string;
+                    carrier: string;
+                    carriers: string;
+                    connectCarrierForm: string;
+                    connectingCarriers: string;
+                    creatingFundingSource: string;
+                    data: string;
+                    importingSalesOrder: string;
+                    label: string;
+                    labels: string;
+                    onboarding: string;
+                    salesOrder: string;
+                    shipment: string;
+                    shipments: string;
+                    warehouses: string;
+                };
+                months: {
+                    january: string;
+                    february: string;
+                    march: string;
+                    april: string;
+                    may: string;
+                    june: string;
+                    july: string;
+                    august: string;
+                    september: string;
+                    october: string;
+                    november: string;
+                    december: string;
+                };
+                packageCategories: {
+                    customPackages: string;
+                };
+                packageCodes: {
+                    package: string;
+                };
+                "powered-by": string;
+                schema: {
+                    optionalLabel: string;
+                };
+                required: string;
+                schemaErrors: {
+                    notAValidPhoneNumber: string;
+                    mustAgreeToTerms: string;
+                    group: {
+                        allMeasurementsOrNone: string;
+                    };
+                    invalidAddressName: string;
+                    invalidAddressNameStrict: string;
+                    invalidAddressOnboarding: string;
+                    invalidAddressPoBox: string;
+                    invalidCreditCardType: string;
+                    invalidExpirationDate: string;
+                    invalidPostalCode: string;
+                    invalidStateProvince: string;
+                    invalidString: string;
+                    nonnegative: string;
+                    nonnegativeList: string;
+                    positive: string;
+                    positiveList: string;
+                    required: string;
+                    requiredList: string;
+                    tooFewCharacters: string;
+                    tooManyCharacters: string;
+                };
+                shippingPresets: {
+                    apply: string;
+                    platform: string;
+                    user: string;
+                };
+                terms: {
+                    fields: {
+                        agreement: string;
+                    };
+                    agreeToTerms: string;
+                    carriersTitle: string;
+                    fundingSourceTitle: string;
+                };
+                weight: {
+                    ounces: string;
+                    pounds_one: string;
+                    pounds_other: string;
+                    kilogram: string;
+                    gram: string;
+                };
+                units: {
+                    inch: string;
+                    lbs: string;
+                    oz: string;
+                    centimeter: string;
+                    gram: string;
+                    kilogram: string;
+                };
+                T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
+                "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
+                "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
+                QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
+                "QWRkcmVzcyBub3QgZm91bmQ=": string;
+                QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
+                UGxlYXNlIGFkZCBhIFN0YW1wcy5jb20gYWNjb3VudCB0byBTaGlwRW5naW5lIGluIG9yZGVyIHRvIGNyZWF0ZSBzaGlwcGluZyBsYWJlbHMu: string;
+                QSBzaGlwcGluZyBlcnJvciBvY2N1cnJlZDogTWlzc2luZyBvciBpbnZhbGlkIHNoaXBwZXIgbnVtYmVy: string;
+                QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcHBlciBuYW1l: string;
+                "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;
+                };
+                title: string;
+                sections: {
+                    accountBalance: string;
+                    paymentMethod: string;
+                    transactionHistory: string;
+                    adjustmentHistory: string;
+                    warehouses: string;
+                    carriers: string;
+                    /**
+                     * # List-Carriers Component
+                     *
+                     * @param ComponentProps The base props that will be passed into the `<List-Carriers />` component.
+                     *
+                     * @returns Element A React element that renders the `<List-Carriers />` component allowing users
+                     * to view a list of carriers that are connected to their ShipEngine account. This component is
+                     * composed in the `<AccountSettings />` Element.
+                     *
+                     * @example
+                     * ```tsx
+                     * (() => {
+                     *   const features = useFeatures("Global");
+                     *
+                     *   return <ListCarriers.Component features={features} />;
+                     * })();
+                     * ```
+                     *
+                     * <br />
+                     *
+                     * @see {@link ListCarriers.ComponentProps | The props that are passed into the `<List-Carriers />` component}
+                     * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<List-Carriers />` component}
+                     */
+                    externalCarriers: string;
+                    labelLayout: string;
+                    unitSettings: string;
+                };
+            };
+        };
+    } | undefined;
+}) => import("@emotion/react/jsx-runtime").JSX.Element;
+export type ElementProps = React.ComponentProps<typeof Element>;