@wix/ecom 1.0.597 → 1.0.599

package/type-bundles/service-plugins-context.bundle.d.ts

@@ -0,0 +1,3196 @@
+interface GetShippingRatesRequest {
+    /** The line items to be shipped. */
+    lineItems?: ProductItem[];
+    /** Address to ship to. */
+    shippingDestination?: Address$3;
+    /** Address item is shipped from. This is the site owner's business address. */
+    shippingOrigin?: Address$3;
+    /** Buyer's contact details. */
+    buyerContactDetails?: FullAddressContactDetails$3;
+    /**
+     * Weight measurement unit used for all items in the shipment.
+     *
+     * Supported values:
+     * + `"KG"`: kilograms
+     * + `"LB"`: pounds
+     */
+    weightUnit?: WeightUnit$2;
+    /** Whether tax is included in the items' prices. */
+    taxIncludedInPrices?: boolean;
+    /** list of delivery preferences, for example preferred delivery code (shippingOptionId) */
+    deliveryPreferences?: DeliveryPreferences;
+    /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
+    purchaseFlowId?: string | null;
+}
+interface ProductItem {
+    /** Item name. */
+    name?: string;
+    /** The number of items ordered. */
+    quantity?: number;
+    /** Reference to the item's origin catalog. */
+    catalogReference?: CatalogReference$4;
+    /** Physical properties of the item. */
+    physicalProperties?: PhysicalProperties$3;
+    /** Price of a single item after discounts. */
+    price?: string;
+    /** Total line item price before discounts. */
+    totalPriceBeforeDiscount?: string | null;
+    /** Price of a single item before discounts. */
+    priceBeforeDiscount?: string | null;
+    /** Total line item price after discounts. This is equal to `price` multiplied by `quantity`. */
+    totalPrice?: string | null;
+    /** item delivery destination index in the shipping addresses list */
+    deliveryDestinationIndex?: number | null;
+    /** where the item is delivered from index in the from addresses list */
+    deliveryOriginIndex?: number | null;
+    /** whether tax is included in line item price */
+    taxIncludedInPrice?: boolean | null;
+}
+/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
+interface CatalogReference$4 {
+    /** ID of the item within the catalog it belongs to. */
+    catalogItemId?: string;
+    /**
+     * ID of the app providing the catalog.
+     *
+     * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
+     *
+     * For items from Wix catalogs, the following values always apply:
+     * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
+     * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
+     * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     */
+    appId?: string;
+    /**
+     * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
+     *
+     * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
+     */
+    options?: Record<string, any> | null;
+}
+interface PhysicalProperties$3 {
+    /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
+    weight?: number | null;
+    /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
+    sku?: string | null;
+    /** Whether this line item is shippable. */
+    shippable?: boolean;
+}
+/** Physical address */
+interface Address$3 extends AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress$3;
+    /** Main address line, usually street and number as free text. */
+    addressLine1?: string | null;
+    /** Country code. */
+    country?: string | null;
+    /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Zip/postal code. */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
+    addressLine2?: string | null;
+}
+/** @oneof */
+interface AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress$3;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+interface StreetAddress$3 {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+interface AddressLocation$3 {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface Subdivision {
+    /** Short subdivision code. */
+    code?: string;
+    /** Subdivision full name. */
+    name?: string;
+}
+declare enum SubdivisionType {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** State */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** County */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** City/town */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** Neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** Street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
+/** Subdivision Concordance values */
+interface StandardDetails {
+    /** subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30 */
+    iso31662?: string | null;
+}
+/** Full contact details for an address */
+interface FullAddressContactDetails$3 {
+    /** Contact's first name. */
+    firstName?: string | null;
+    /** Contact's last name. */
+    lastName?: string | null;
+    /** Contact's phone number. */
+    phone?: string | null;
+    /** Contact's company name. */
+    company?: string | null;
+    /** Email associated with the address. */
+    email?: string | null;
+    /** Tax info. Currently usable only in Brazil. */
+    vatId?: VatId$3;
+}
+interface VatId$3 {
+    /** Customer's tax ID. */
+    _id?: string;
+    /**
+     * Tax type.
+     *
+     * Supported values:
+     * + `CPF`: for individual tax payers
+     * + `CNPJ`: for corporations
+     */
+    type?: VatType$3;
+}
+/** tax info types */
+declare enum VatType$3 {
+    UNSPECIFIED = "UNSPECIFIED",
+    /** CPF - for individual tax payers. */
+    CPF = "CPF",
+    /** CNPJ - for corporations */
+    CNPJ = "CNPJ"
+}
+declare enum WeightUnit$2 {
+    /** Weight unit can't be classified, due to an error */
+    UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
+    /** Kilograms */
+    KG = "KG",
+    /** Pounds */
+    LB = "LB"
+}
+/**
+ * delivery preferences, for example preferred delivery "code" (shippingOptionId).
+ * enrich the delivery providers with more data about the delivery
+ */
+interface DeliveryPreferences {
+    preferredCode?: string | null;
+}
+interface GetShippingRatesResponse {
+    /** Available shipping rates. These define the shipping rate options that are displayed to site visitors on the cart and checkout pages. */
+    shippingRates?: ShippingOption[];
+}
+interface ShippingOption {
+    /** Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`. */
+    code?: string;
+    /** Shipping rate title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"`, or `"First-Class Package International"`. */
+    title?: string;
+    /** Shipping logistics. */
+    logistics?: DeliveryLogistics$2;
+    /** Shipping cost. */
+    cost?: ShippingPrice$1;
+}
+interface DeliveryLogistics$2 {
+    /** When the item is expected to be delivered in free text. For example, `"3-5 business days"`. */
+    deliveryTime?: string | null;
+    /** Instructions for delivery. For example, for pickup: `"Ensure to come during business hours, and please don't park in the disabled spot"`. */
+    instructions?: string | null;
+    /** Pickup details. Should be returned only if order is for pickup. */
+    pickupDetails?: PickupDetails$2;
+}
+interface PickupDetails$2 {
+    /** Pickup address. */
+    address?: Address$3;
+    /**
+     * Pickup method.
+     *
+     * Supported values:
+     * + `"STORE_PICKUP"`: When pickup is from the merchant's brick and mortar store.
+     * + `"PICKUP_POINT"`: When item is shipped to a specified pickup point.
+     */
+    pickupMethod?: PickupMethod$2;
+}
+declare enum PickupMethod$2 {
+    UNKNOWN_METHOD = "UNKNOWN_METHOD",
+    STORE_PICKUP = "STORE_PICKUP",
+    PICKUP_POINT = "PICKUP_POINT"
+}
+interface DeliveryTimeSlot$1 {
+    /** starting time of the delivery time slot */
+    from?: Date;
+    /** ending time of the delivery time slot */
+    to?: Date;
+}
+interface ShippingPrice$1 {
+    /** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */
+    price?: string;
+    /** Currency of the shipping rate price as a 3-letter [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217). Must align with the `currency` passed to the function under the `metadata` field. */
+    currency?: string;
+    /** Additional costs. For example, a handling fee for packaging fragile items. */
+    additionalCharges?: AdditionalCharge[];
+}
+interface AdditionalCharge {
+    /** Additional charge type. */
+    type?: ChargeType$1;
+    /** Details of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`. */
+    details?: string | null;
+    /** Cost of additional charge. For example, `12.5`. */
+    price?: string;
+}
+declare enum ChargeType$1 {
+    HANDLING_FEE = "HANDLING_FEE"
+}
+interface PartialOption {
+    /** Items that the delivery option is for. If empty, the delivery option is for all items. */
+    lineItemIds?: string[];
+}
+interface MissingPostalCodeError {
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface InvalidPostalCodeError {
+    error?: ApplicationError;
+}
+interface InvalidAddressError {
+    fields?: FieldViolation[];
+}
+interface FieldViolation {
+    field?: string;
+    description?: string;
+    violatedRule?: RuleType;
+    /** applicable when violated_rule=OTHER */
+    ruleName?: string | null;
+    data?: Record<string, any> | null;
+}
+declare enum RuleType {
+    VALIDATION = "VALIDATION",
+    OTHER = "OTHER",
+    MAX = "MAX",
+    MIN = "MIN",
+    MAX_LENGTH = "MAX_LENGTH",
+    MIN_LENGTH = "MIN_LENGTH",
+    MAX_SIZE = "MAX_SIZE",
+    MIN_SIZE = "MIN_SIZE",
+    FORMAT = "FORMAT",
+    DECIMAL_LTE = "DECIMAL_LTE",
+    DECIMAL_GTE = "DECIMAL_GTE",
+    DECIMAL_LT = "DECIMAL_LT",
+    DECIMAL_GT = "DECIMAL_GT",
+    DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
+    INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
+    REQUIRED_FIELD = "REQUIRED_FIELD",
+    FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
+    ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT"
+}
+interface GenericShippingRatesError {
+    errors?: ApplicationError[];
+}
+interface GetDashboardTablesRequest {
+    /** Delivery profile id. */
+    deliveryProfileId?: string;
+    /** Delivery region ids to get settings for. */
+    deliveryRegionId?: string[];
+}
+interface GetDashboardTablesResponse {
+    /** The list of settings for the given requests. */
+    dashboardTableResults?: RegionDashboardTables[];
+}
+interface RegionDashboardTables {
+    /** The delivery rule id. */
+    deliveryRegionId?: string;
+    /** The shipping table values that are associated with the delivery rule. Can be multiple if the provider is an aggregator of multiple carriers. */
+    dashboardTables?: DashboardTable[];
+}
+interface DashboardTable {
+    /** The title of the delivery settings that will be displayed in the UI. */
+    title?: string;
+    /** The columns of the delivery settings that will be displayed in the UI. */
+    columns?: Column[];
+    /** The content of the delivery settings. Each row is a map of column name to value. */
+    rows?: Row[];
+}
+interface Column {
+    /** The name of the column. This is used to get the data from the row. */
+    key?: string;
+    /** The title of the column that will be displayed in the UI. */
+    name?: string;
+}
+interface Row {
+    /** The external key of the data presented in a row. This is used to identify the row in the UI for editing. */
+    key?: string;
+    /**
+     * The data presented in the row. The key is the column `name` and the value is the data in the specific row and column.
+     * Data will be in JSON format.
+     */
+    data?: Record<string, any> | null;
+}
+interface ShippingRatesConfig {
+    /**
+     * Base URI where the endpoints are called.
+     * Wix eCommerce appends the endpoint path to the base URI.
+     * For example, to call the Get Shipping Rates endpoint at `https://my-shipping-provider.com/v1/getRates`,
+     * the base URI you provide here is `https://my-shipping-provider.com/`.
+     */
+    deploymentUri?: string;
+    /** Human-readable name of the shipping provider. */
+    name?: string;
+    /** Description of the shipping provider. */
+    description?: string | null;
+    /** URL to more info about the shipping provider. */
+    learnMoreUrl?: string | null;
+    /** URL to reach the shipping provider app's dashboard. */
+    dashboardUrl?: string | null;
+    /** Whether to require the site owner to define a fallback/default rate. Set to `true` if you do not provide rates as part of the integration. */
+    fallbackDefinitionMandatory?: boolean;
+    /**
+     * Thumbnail image of the shipping rates provider. Displayed in the shipping settings section in the Dashboard.
+     * The URL must be of an image uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager).
+     */
+    thumbnailUrl?: string | null;
+}
+/**
+ * this message is not directly used by any service,
+ * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
+ * e.g. SPIs, event-handlers, etc..
+ * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
+ *
+ * Example:
+ * ```typescript
+ * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
+ * ...
+ * }
+ * ```
+ */
+interface Context$4 {
+    /** A unique identifier for each request. Can be used for logging / troubleshooting */
+    requestId?: string | null;
+    /** 3 capital letters string representing a currency according to ISO-4217 */
+    currency?: string | null;
+    /** The identification type and identity data */
+    identity?: IdentificationData$4;
+    /** A string representing a language and region in the format of "xx-XX". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2 */
+    languages?: string[];
+    /** App instance ID of SPI in context */
+    instanceId?: string | null;
+}
+declare enum IdentityType$4 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface IdentificationData$4 extends IdentificationDataIdOneOf$4 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: IdentityType$4;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$4 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+
+declare class MissingPostalCodeWixError extends Error {
+    httpCode: string;
+    applicationCode: string;
+    errorDescription: string;
+    messageSchema: string;
+    data: MissingPostalCodeError;
+    constructor(data: MissingPostalCodeError);
+}
+declare class InvalidPostalCodeWixError extends Error {
+    httpCode: string;
+    applicationCode: string;
+    errorDescription: string;
+    messageSchema: string;
+    data: InvalidPostalCodeError;
+    constructor(data: InvalidPostalCodeError);
+}
+declare class InvalidAddressWixError extends Error {
+    httpCode: string;
+    applicationCode: string;
+    errorDescription: string;
+    messageSchema: string;
+    data: InvalidAddressError;
+    constructor(data: InvalidAddressError);
+}
+declare class GenericShippingRatesWixError extends Error {
+    httpCode: string;
+    applicationCode: string;
+    errorDescription: string;
+    messageSchema: string;
+    data: GenericShippingRatesError;
+    constructor(data: GenericShippingRatesError);
+}
+
+type ServicePluginMethodInput = {
+    request: any;
+    metadata: any;
+};
+type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata = {
+    name: string;
+    primaryHttpMappingPath: string;
+    transformations: {
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
+        toREST: (...args: unknown[]) => unknown;
+    };
+};
+type ServicePluginDefinition<Contract extends ServicePluginContract> = {
+    __type: 'service-plugin-definition';
+    componentType: string;
+    methods: ServicePluginMethodMetadata[];
+    __contract: Contract;
+};
+declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
+type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
+
+interface GetShippingRatesEnvelope {
+    request: GetShippingRatesRequest;
+    metadata: Context$4;
+}
+declare const provide$9: ServicePluginDefinition<{
+    getShippingRates(payload: GetShippingRatesEnvelope): GetShippingRatesResponse | Promise<GetShippingRatesResponse>;
+}>;
+
+declare const provide$8: BuildServicePluginDefinition<typeof provide$9>;
+
+type context$4_AdditionalCharge = AdditionalCharge;
+type context$4_AddressStreetOneOf = AddressStreetOneOf;
+type context$4_ApplicationError = ApplicationError;
+type context$4_Column = Column;
+type context$4_DashboardTable = DashboardTable;
+type context$4_DeliveryPreferences = DeliveryPreferences;
+type context$4_FieldViolation = FieldViolation;
+type context$4_GenericShippingRatesError = GenericShippingRatesError;
+type context$4_GenericShippingRatesWixError = GenericShippingRatesWixError;
+declare const context$4_GenericShippingRatesWixError: typeof GenericShippingRatesWixError;
+type context$4_GetDashboardTablesRequest = GetDashboardTablesRequest;
+type context$4_GetDashboardTablesResponse = GetDashboardTablesResponse;
+type context$4_GetShippingRatesRequest = GetShippingRatesRequest;
+type context$4_GetShippingRatesResponse = GetShippingRatesResponse;
+type context$4_InvalidAddressError = InvalidAddressError;
+type context$4_InvalidAddressWixError = InvalidAddressWixError;
+declare const context$4_InvalidAddressWixError: typeof InvalidAddressWixError;
+type context$4_InvalidPostalCodeError = InvalidPostalCodeError;
+type context$4_InvalidPostalCodeWixError = InvalidPostalCodeWixError;
+declare const context$4_InvalidPostalCodeWixError: typeof InvalidPostalCodeWixError;
+type context$4_MissingPostalCodeError = MissingPostalCodeError;
+type context$4_MissingPostalCodeWixError = MissingPostalCodeWixError;
+declare const context$4_MissingPostalCodeWixError: typeof MissingPostalCodeWixError;
+type context$4_PartialOption = PartialOption;
+type context$4_ProductItem = ProductItem;
+type context$4_RegionDashboardTables = RegionDashboardTables;
+type context$4_Row = Row;
+type context$4_RuleType = RuleType;
+declare const context$4_RuleType: typeof RuleType;
+type context$4_ShippingOption = ShippingOption;
+type context$4_ShippingRatesConfig = ShippingRatesConfig;
+type context$4_StandardDetails = StandardDetails;
+type context$4_Subdivision = Subdivision;
+type context$4_SubdivisionType = SubdivisionType;
+declare const context$4_SubdivisionType: typeof SubdivisionType;
+declare namespace context$4 {
+  export { type context$4_AdditionalCharge as AdditionalCharge, type Address$3 as Address, type AddressLocation$3 as AddressLocation, type context$4_AddressStreetOneOf as AddressStreetOneOf, type context$4_ApplicationError as ApplicationError, type CatalogReference$4 as CatalogReference, ChargeType$1 as ChargeType, type context$4_Column as Column, type Context$4 as Context, type context$4_DashboardTable as DashboardTable, type DeliveryLogistics$2 as DeliveryLogistics, type context$4_DeliveryPreferences as DeliveryPreferences, type DeliveryTimeSlot$1 as DeliveryTimeSlot, type context$4_FieldViolation as FieldViolation, type FullAddressContactDetails$3 as FullAddressContactDetails, type context$4_GenericShippingRatesError as GenericShippingRatesError, context$4_GenericShippingRatesWixError as GenericShippingRatesWixError, type context$4_GetDashboardTablesRequest as GetDashboardTablesRequest, type context$4_GetDashboardTablesResponse as GetDashboardTablesResponse, type context$4_GetShippingRatesRequest as GetShippingRatesRequest, type context$4_GetShippingRatesResponse as GetShippingRatesResponse, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, IdentityType$4 as IdentityType, type context$4_InvalidAddressError as InvalidAddressError, context$4_InvalidAddressWixError as InvalidAddressWixError, type context$4_InvalidPostalCodeError as InvalidPostalCodeError, context$4_InvalidPostalCodeWixError as InvalidPostalCodeWixError, type context$4_MissingPostalCodeError as MissingPostalCodeError, context$4_MissingPostalCodeWixError as MissingPostalCodeWixError, type context$4_PartialOption as PartialOption, type PhysicalProperties$3 as PhysicalProperties, type PickupDetails$2 as PickupDetails, PickupMethod$2 as PickupMethod, type context$4_ProductItem as ProductItem, type context$4_RegionDashboardTables as RegionDashboardTables, type context$4_Row as Row, context$4_RuleType as RuleType, type context$4_ShippingOption as ShippingOption, type ShippingPrice$1 as ShippingPrice, type context$4_ShippingRatesConfig as ShippingRatesConfig, type context$4_StandardDetails as StandardDetails, type StreetAddress$3 as StreetAddress, type context$4_Subdivision as Subdivision, context$4_SubdivisionType as SubdivisionType, type VatId$3 as VatId, VatType$3 as VatType, WeightUnit$2 as WeightUnit, provide$8 as provide };
+}
+
+interface CalculateAdditionalFeesRequest {
+    /**
+     * Line items to calculate additional fees for.
+     *
+     * Max: 300 items
+     */
+    lineItems?: LineItem$2[];
+    /** Shipping address. */
+    shippingAddress?: Address$2;
+    /** Information about the buyer, such as contact details. */
+    buyerDetails?: BuyerDetails$1;
+    /** Applied discounts. */
+    appliedDiscounts?: AppliedDiscount$2[];
+    /** Shipping information. */
+    shippingInfo?: ShippingInformation$1;
+    /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
+    purchaseFlowId?: string | null;
+}
+interface LineItem$2 {
+    /** Line item ID. */
+    _id?: string;
+    /**
+     * Quantity of item.
+     *
+     * Min: `1`
+     * Max: `100000`
+     */
+    quantity?: number | null;
+    /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
+    catalogReference?: CatalogReference$3;
+    /** Item name. */
+    productName?: string | null;
+    /** Price for a single item. */
+    price?: string;
+    /** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
+    physicalProperties?: PhysicalProperties$2;
+    /**
+     * Partial payment to be paid upfront during the checkout.
+     * Only eligible for catalog items with `lineItem.paymentOption` type of `DEPOSIT_ONLINE`.
+     */
+    depositAmount?: string | null;
+}
+/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
+interface CatalogReference$3 {
+    /** ID of the item within the catalog it belongs to. */
+    catalogItemId?: string;
+    /**
+     * ID of the app providing the catalog.
+     *
+     * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
+     *
+     * For items from Wix catalogs, the following values always apply:
+     * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
+     * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
+     * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     */
+    appId?: string;
+    /**
+     * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
+     *
+     * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
+     */
+    options?: Record<string, any> | null;
+}
+interface PhysicalProperties$2 {
+    /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
+    weight?: number | null;
+    /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
+    sku?: string | null;
+    /** Whether this line item is shippable. */
+    shippable?: boolean;
+}
+/** Physical address */
+interface Address$2 {
+    /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
+    country?: string | null;
+    /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Postal or zip code. */
+    postalCode?: string | null;
+    /** Street address. */
+    streetAddress?: StreetAddress$2;
+    /** Main address line (usually street name and number). */
+    addressLine1?: string | null;
+    /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
+    addressLine2?: string | null;
+}
+interface StreetAddress$2 {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+interface AddressLocation$2 {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface BuyerDetails$1 {
+    /** Contact details. */
+    contactDetails?: FullAddressContactDetails$2;
+}
+/** Full contact details for an address */
+interface FullAddressContactDetails$2 {
+    /** Contact's first name. */
+    firstName?: string | null;
+    /** Contact's last name. */
+    lastName?: string | null;
+    /** Contact's phone number. */
+    phone?: string | null;
+    /** Contact's company name. */
+    company?: string | null;
+    /** Email associated with the address. */
+    email?: string | null;
+    /** Tax info. Currently usable only in Brazil. */
+    vatId?: VatId$2;
+}
+interface VatId$2 {
+    /** Customer's tax ID. */
+    _id?: string;
+    /**
+     * Tax type.
+     *
+     * Supported values:
+     * + `CPF`: for individual tax payers
+     * + `CNPJ`: for corporations
+     */
+    type?: VatType$2;
+}
+/** tax info types */
+declare enum VatType$2 {
+    UNSPECIFIED = "UNSPECIFIED",
+    /** CPF - for individual tax payers. */
+    CPF = "CPF",
+    /** CNPJ - for corporations */
+    CNPJ = "CNPJ"
+}
+interface AppliedDiscount$2 extends AppliedDiscountDiscountSourceOneOf$2 {
+    /** Coupon details. */
+    coupon?: Coupon$2;
+    /** Merchant discount. */
+    merchantDiscount?: MerchantDiscount$2;
+    /** Discount rule */
+    discountRule?: DiscountRule$2;
+    /** Discount type. */
+    discountType?: DiscountType$2;
+    /** IDs of line items the discount applies to. */
+    lineItemIds?: string[];
+}
+/** @oneof */
+interface AppliedDiscountDiscountSourceOneOf$2 {
+    /** Coupon details. */
+    coupon?: Coupon$2;
+    /** Merchant discount. */
+    merchantDiscount?: MerchantDiscount$2;
+    /** Discount rule */
+    discountRule?: DiscountRule$2;
+}
+declare enum DiscountType$2 {
+    GLOBAL = "GLOBAL",
+    SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
+    SHIPPING = "SHIPPING"
+}
+/** Coupon */
+interface Coupon$2 {
+    /** Coupon ID. */
+    _id?: string;
+    /** Coupon code. */
+    code?: string;
+    /** Coupon name. */
+    name?: string;
+    amount?: string;
+}
+interface MerchantDiscount$2 {
+    amount?: string;
+}
+interface DiscountRule$2 {
+    /** Discount rule ID */
+    _id?: string;
+    /** Discount rule name */
+    name?: DiscountRuleName$2;
+    amount?: string;
+}
+interface DiscountRuleName$2 {
+    /** Original discount rule name (in site's default language). */
+    original?: string;
+    /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
+    translated?: string | null;
+}
+interface ShippingInformation$1 {
+    /** Selected carrier shipping option. */
+    selectedCarrierServiceOption?: SelectedCarrierServiceOption$1;
+}
+interface SelectedCarrierServiceOption$1 {
+    /** Unique identifier of selected option. For example, `"usps_std_overnight"`. */
+    code?: string;
+    /**
+     * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
+     * For example, "Standard" or "First-Class Package International".
+     * @readonly
+     */
+    title?: string;
+    /**
+     * Delivery logistics.
+     * @readonly
+     */
+    logistics?: DeliveryLogistics$1;
+    /**
+     * Shipping costs.
+     * @readonly
+     */
+    cost?: SelectedCarrierServiceOptionPrices$1;
+    /** Other charges. */
+    otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
+}
+interface DeliveryLogistics$1 {
+    /** Expected delivery time. For example, "3-5 business days". */
+    deliveryTime?: string | null;
+    /** Instructions for deliver. For example, "Please deliver during open hours and please don't park in disabled parking spot". */
+    instructions?: string | null;
+    /** Pickup details. */
+    pickupDetails?: PickupDetails$1;
+}
+interface PickupDetails$1 {
+    /** Pickup address. */
+    address?: Address$2;
+    /**
+     * Whether the pickup address is a business. This may affect tax calculation.
+     * @deprecated
+     */
+    businessLocation?: boolean;
+    /** Pickup method. */
+    pickupMethod?: PickupMethod$1;
+}
+declare enum PickupMethod$1 {
+    UNKNOWN_METHOD = "UNKNOWN_METHOD",
+    STORE_PICKUP = "STORE_PICKUP",
+    PICKUP_POINT = "PICKUP_POINT"
+}
+interface SelectedCarrierServiceOptionPrices$1 {
+    /** Price. */
+    price?: string;
+    /** Total shipping discount. */
+    totalDiscount?: string | null;
+}
+interface SelectedCarrierServiceOptionOtherCharge {
+    /** Type of charge. */
+    type?: ChargeType;
+    /**
+     * Details of the charge.
+     *
+     * Max: 200 characters
+     */
+    details?: string | null;
+    /**
+     * Cost.
+     *
+     * `cost` is `price` minus `totalDiscount`.
+     */
+    cost?: SelectedCarrierServiceOptionPrices$1;
+}
+declare enum ChargeType {
+    HANDLING_FEE = "HANDLING_FEE",
+    INSURANCE = "INSURANCE"
+}
+interface CalculateAdditionalFeesResponse {
+    /** Additional fees calculated. */
+    additionalFees?: AdditionalFee$1[];
+    /**
+     * Currency of additional fees calculated. In three-letter currency code
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     *
+     * The currency returned in the response object must match the wix site's currency or those fees will
+     * be filtered out and not returned. Extract the `currency` from the
+     * [request envelope](https://dev.wix.com/api/rest/getting-started/service-provider-interface#getting-started_service-provider-interface_request-envelope)
+     * to ensure the correct currency is used in your calculation.
+     */
+    currency?: string;
+}
+/** Additional fees calculated. */
+interface AdditionalFee$1 {
+    /** Additional fee's unique code or ID. */
+    code?: string | null;
+    /**
+     * Additional fee's name.
+     *
+     * Max: 50 characters
+     */
+    name?: string;
+    /** Total additional fees. This `price` does not include any taxes that may apply to these additional fees. */
+    price?: string;
+    /**
+     * Tax details.
+     *
+     * > **Note:** Tax is not calculated in the returned `price` even when `taxDetails.taxable` is `true`.
+     */
+    taxDetails?: TaxDetails;
+    /**
+     * Optional - Line items associated with this additional fee.
+     * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
+     */
+    lineItemIds?: string[];
+}
+/** Tax details. */
+interface TaxDetails {
+    /** Whether additional fee is taxable. */
+    taxable?: boolean;
+    /** Reserved for internal use. */
+    taxGroupId?: string | null;
+}
+interface AdditionalFeesSPIConfig {
+    /**
+     * Base URI where the endpoints are called.
+     * Wix eCommerce appends the endpoint path to the base URI.
+     * For example, to call the Calculate Additional Fees endpoint at `https://my-additional-fees.com/v1/calculateAdditionalFees`,
+     * the base URI you provide here is `https://my-additional-fees.com/`.
+     */
+    deploymentUri?: string;
+}
+/**
+ * this message is not directly used by any service,
+ * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
+ * e.g. SPIs, event-handlers, etc..
+ * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
+ *
+ * Example:
+ * ```typescript
+ * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
+ * ...
+ * }
+ * ```
+ */
+interface Context$3 {
+    /** A unique identifier for each request. Can be used for logging / troubleshooting */
+    requestId?: string | null;
+    /** 3 capital letters string representing a currency according to ISO-4217 */
+    currency?: string | null;
+    /** The identification type and identity data */
+    identity?: IdentificationData$3;
+    /** A string representing a language and region in the format of "xx-XX". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2 */
+    languages?: string[];
+    /** App instance ID of SPI in context */
+    instanceId?: string | null;
+}
+declare enum IdentityType$3 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface IdentificationData$3 extends IdentificationDataIdOneOf$3 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: IdentityType$3;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$3 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+
+interface CalculateAdditionalFeesEnvelope {
+    request: CalculateAdditionalFeesRequest;
+    metadata: Context$3;
+}
+declare const provide$7: ServicePluginDefinition<{
+    calculateAdditionalFees(payload: CalculateAdditionalFeesEnvelope): CalculateAdditionalFeesResponse | Promise<CalculateAdditionalFeesResponse>;
+}>;
+
+declare const provide$6: BuildServicePluginDefinition<typeof provide$7>;
+
+type context$3_AdditionalFeesSPIConfig = AdditionalFeesSPIConfig;
+type context$3_CalculateAdditionalFeesRequest = CalculateAdditionalFeesRequest;
+type context$3_CalculateAdditionalFeesResponse = CalculateAdditionalFeesResponse;
+type context$3_ChargeType = ChargeType;
+declare const context$3_ChargeType: typeof ChargeType;
+type context$3_SelectedCarrierServiceOptionOtherCharge = SelectedCarrierServiceOptionOtherCharge;
+type context$3_TaxDetails = TaxDetails;
+declare namespace context$3 {
+  export { type AdditionalFee$1 as AdditionalFee, type context$3_AdditionalFeesSPIConfig as AdditionalFeesSPIConfig, type Address$2 as Address, type AddressLocation$2 as AddressLocation, type AppliedDiscount$2 as AppliedDiscount, type AppliedDiscountDiscountSourceOneOf$2 as AppliedDiscountDiscountSourceOneOf, type BuyerDetails$1 as BuyerDetails, type context$3_CalculateAdditionalFeesRequest as CalculateAdditionalFeesRequest, type context$3_CalculateAdditionalFeesResponse as CalculateAdditionalFeesResponse, type CatalogReference$3 as CatalogReference, context$3_ChargeType as ChargeType, type Context$3 as Context, type Coupon$2 as Coupon, type DeliveryLogistics$1 as DeliveryLogistics, type DiscountRule$2 as DiscountRule, type DiscountRuleName$2 as DiscountRuleName, DiscountType$2 as DiscountType, type FullAddressContactDetails$2 as FullAddressContactDetails, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, IdentityType$3 as IdentityType, type LineItem$2 as LineItem, type MerchantDiscount$2 as MerchantDiscount, type PhysicalProperties$2 as PhysicalProperties, type PickupDetails$1 as PickupDetails, PickupMethod$1 as PickupMethod, type SelectedCarrierServiceOption$1 as SelectedCarrierServiceOption, type context$3_SelectedCarrierServiceOptionOtherCharge as SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices$1 as SelectedCarrierServiceOptionPrices, type ShippingInformation$1 as ShippingInformation, type StreetAddress$2 as StreetAddress, type context$3_TaxDetails as TaxDetails, type VatId$2 as VatId, VatType$2 as VatType, provide$6 as provide };
+}
+
+interface CustomTrigger {
+    /** Custom trigger ID. */
+    _id?: string;
+}
+interface ListTriggersRequest {
+}
+interface ListTriggersResponse {
+    /** Custom triggers. */
+    customTriggers?: ListTriggersResponseCustomTrigger[];
+}
+interface ListTriggersResponseCustomTrigger {
+    /** Custom trigger ID. */
+    _id?: string;
+    /** Custom trigger name to display in the dashboard. */
+    name?: string;
+}
+interface GetEligibleTriggersRequest {
+    /** List of line items in the cart/checkout. */
+    lineItems?: LineItem$1[];
+    /** List of triggers to be checked for discount eligibility. */
+    triggers?: TriggerToFilterBy[];
+    /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
+    purchaseFlowId?: string | null;
+}
+interface LineItem$1 {
+    /** Line item ID. */
+    _id?: string;
+    /** Item quantity in this line item. */
+    quantity?: number | null;
+    /**
+     * Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info.
+     * This field is empty in the case of a custom line item.
+     */
+    catalogReference?: CatalogReference$2;
+    /** Price of a single item. */
+    price?: string;
+}
+/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
+interface CatalogReference$2 {
+    /** ID of the item within the catalog it belongs to. */
+    catalogItemId?: string;
+    /**
+     * ID of the app providing the catalog.
+     *
+     * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
+     *
+     * For items from Wix catalogs, the following values always apply:
+     * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
+     * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
+     * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     */
+    appId?: string;
+    /**
+     * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
+     *
+     * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
+     */
+    options?: Record<string, any> | null;
+}
+interface TriggerToFilterBy {
+    /** Custom trigger info. */
+    customTrigger?: CustomTrigger;
+    /** Unique trigger identifier. The same value must be returned in `eligibleTriggers[i].identifier`. */
+    identifier?: string | null;
+}
+interface GetEligibleTriggersResponse {
+    /** List of eligible triggers. These are used by the Discount Rules API and Wix eCommerce to apply the relevant discount. */
+    eligibleTriggers?: EligibleTrigger[];
+}
+interface EligibleTrigger {
+    /** Custom trigger ID. Must be passed with relevant `identifier`. */
+    customTriggerId?: string;
+    /** Unique trigger identifier. The value must be the same as its equivalent in `triggers[i].identifier` in the request payload. */
+    identifier?: string | null;
+}
+interface CustomTriggerConfig {
+    /**
+     * Required. Base URI where the endpoints are called.
+     * Wix appends the endpoint path to the base URI. For example, to call the Get Eligible Triggers endpoint at `https://my-discount-app.com/v1/getEligibleTriggers`, the base URI you provide here is `https://my-discount-app.com/`.
+     */
+    deploymentUri?: string;
+}
+/**
+ * this message is not directly used by any service,
+ * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
+ * e.g. SPIs, event-handlers, etc..
+ * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
+ *
+ * Example:
+ * ```typescript
+ * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
+ * ...
+ * }
+ * ```
+ */
+interface Context$2 {
+    /** A unique identifier for each request. Can be used for logging / troubleshooting */
+    requestId?: string | null;
+    /** 3 capital letters string representing a currency according to ISO-4217 */
+    currency?: string | null;
+    /** The identification type and identity data */
+    identity?: IdentificationData$2;
+    /** A string representing a language and region in the format of "xx-XX". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2 */
+    languages?: string[];
+    /** App instance ID of SPI in context */
+    instanceId?: string | null;
+}
+declare enum IdentityType$2 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: IdentityType$2;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$2 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+
+interface ListTriggersEnvelope {
+    request: ListTriggersRequest;
+    metadata: Context$2;
+}
+interface GetEligibleTriggersEnvelope {
+    request: GetEligibleTriggersRequest;
+    metadata: Context$2;
+}
+declare const provide$5: ServicePluginDefinition<{
+    listTriggers(payload: ListTriggersEnvelope): ListTriggersResponse | Promise<ListTriggersResponse>;
+    getEligibleTriggers(payload: GetEligibleTriggersEnvelope): GetEligibleTriggersResponse | Promise<GetEligibleTriggersResponse>;
+}>;
+
+declare const provide$4: BuildServicePluginDefinition<typeof provide$5>;
+
+type context$2_CustomTrigger = CustomTrigger;
+type context$2_CustomTriggerConfig = CustomTriggerConfig;
+type context$2_EligibleTrigger = EligibleTrigger;
+type context$2_GetEligibleTriggersRequest = GetEligibleTriggersRequest;
+type context$2_GetEligibleTriggersResponse = GetEligibleTriggersResponse;
+type context$2_ListTriggersRequest = ListTriggersRequest;
+type context$2_ListTriggersResponse = ListTriggersResponse;
+type context$2_ListTriggersResponseCustomTrigger = ListTriggersResponseCustomTrigger;
+type context$2_TriggerToFilterBy = TriggerToFilterBy;
+declare namespace context$2 {
+  export { type CatalogReference$2 as CatalogReference, type Context$2 as Context, type context$2_CustomTrigger as CustomTrigger, type context$2_CustomTriggerConfig as CustomTriggerConfig, type context$2_EligibleTrigger as EligibleTrigger, type context$2_GetEligibleTriggersRequest as GetEligibleTriggersRequest, type context$2_GetEligibleTriggersResponse as GetEligibleTriggersResponse, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, IdentityType$2 as IdentityType, type LineItem$1 as LineItem, type context$2_ListTriggersRequest as ListTriggersRequest, type context$2_ListTriggersResponse as ListTriggersResponse, type context$2_ListTriggersResponseCustomTrigger as ListTriggersResponseCustomTrigger, type context$2_TriggerToFilterBy as TriggerToFilterBy, provide$4 as provide };
+}
+
+interface GetPaymentSettingsRequest {
+    /** Order. */
+    order?: Order;
+}
+interface Order {
+    /**
+     * Order ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Order number displayed in the site owner's dashboard (auto-generated).
+     * @readonly
+     */
+    number?: string;
+    /**
+     * Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Order line items.
+     * @readonly
+     */
+    lineItems?: OrderLineItem[];
+    /** Buyer information. */
+    buyerInfo?: BuyerInfo;
+    /**
+     * Order payment status.
+     * + `NOT_PAID` - This can be an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
+     * + This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.
+     * + `PAID` - All payments associated with this order are paid. For online payments: [`payment.regularPaymentDetails.status: APPROVED`](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/order-transactions-object). For gift cards: [`payment.giftCardPaymentDetails.voided: false`](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/order-transactions-object).
+     * + `PARTIALLY_REFUNDED` - Order was refunded, but refund amount is less than order total price.
+     * + `FULLY_REFUNDED` - Order fully refunded. Refund amount equals total price.
+     * + `PENDING` - Payments received but not yet confirmed by the payment provider.
+     * + `PARTIALLY_PAID` -  At least one payment was received and approved, covering less than total price amount.
+     */
+    paymentStatus?: PaymentStatus;
+    /**
+     * Order fulfillment status.
+     * @readonly
+     */
+    fulfillmentStatus?: FulfillmentStatus;
+    /**
+     * Language for communication with the buyer. Defaults to the site language.
+     * For a site that supports multiple languages, this is the language the buyer selected.
+     */
+    buyerLanguage?: string | null;
+    /** Weight measurement unit - defaults to site's weight unit. */
+    weightUnit?: WeightUnit$1;
+    /** Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. */
+    currency?: string | null;
+    /** Whether tax is included in line item prices. */
+    taxIncludedInPrices?: boolean;
+    /**
+     * Site language in which original values are shown.
+     * @readonly
+     */
+    siteLanguage?: string | null;
+    /**
+     * Order price summary.
+     * @readonly
+     */
+    priceSummary?: PriceSummary$1;
+    /** Billing address and contact details. */
+    billingInfo?: AddressWithContact$1;
+    /** Shipping info and selected shipping option details. */
+    shippingInfo?: ShippingInformation;
+    /** [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer. */
+    buyerNote?: string | null;
+    /**
+     * Order status.
+     * + `INITIALIZED` - Order was created, but not yet approved or declined.
+     * + `APPROVED` - Order was approved. This happens when either the online payment succeeded or the order is an offline order. Once an order is approved, many side effects are triggered. For example, holding of stock in the inventory and sending of notification emails.
+     * + `CANCELED` - Order was canceled by the user.
+     */
+    status?: OrderStatus;
+    /** Whether order is archived. */
+    archived?: boolean | null;
+    /**
+     * Tax summary.
+     * Deprecated. Use `taxInfo` instead.
+     * This field will be removed on September 30, 2024.
+     * @deprecated Tax summary.
+     * Deprecated. Use `taxInfo` instead.
+     * This field will be removed on September 30, 2024.
+     * @replacedBy tax_info
+     * @removalDate 2024-09-30
+     */
+    taxSummary?: TaxSummary;
+    /** Tax information. */
+    taxInfo?: OrderTaxInfo;
+    /** Applied discounts. */
+    appliedDiscounts?: AppliedDiscount$1[];
+    /**
+     * Order activities.
+     * @readonly
+     */
+    activities?: Activity[];
+    /** Order attribution source. */
+    attributionSource?: AttributionSource;
+    /**
+     * ID of the order's initiator.
+     * @readonly
+     */
+    createdBy?: CreatedBy;
+    /** Information about the sales channel that submitted this order. */
+    channelInfo?: ChannelInfo;
+    /** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
+    seenByAHuman?: boolean | null;
+    /** Checkout ID. */
+    checkoutId?: string | null;
+    /** Custom fields. */
+    customFields?: CustomField$1[];
+    /**
+     * Balance summary.
+     * @readonly
+     */
+    balanceSummary?: BalanceSummary;
+    /** Additional fees applied to the order. */
+    additionalFees?: AdditionalFee[];
+    /**
+     * Custom field data for the order object.
+     *
+     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+    /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
+    purchaseFlowId?: string | null;
+    /**
+     * Order recipient address and contact details.
+     *
+     * This field may differ from the address in `shippingInfo.logistics` when:
+     * + The chosen shipping option is pickup point or store pickup.
+     * + No shipping option is selected.
+     */
+    recipientInfo?: AddressWithContact$1;
+}
+interface OrderLineItem {
+    /** Line item ID. */
+    _id?: string;
+    /**
+     * Item name.
+     * + Stores - `product.name`
+     * + Bookings - `service.info.name`
+     * + Events - `ticket.name`
+     */
+    productName?: ProductName$1;
+    /**
+     * References to the line item's origin catalog.
+     * This field is empty in the case of a custom line item.
+     */
+    catalogReference?: CatalogReference$1;
+    /** Line item quantity. */
+    quantity?: number;
+    /**
+     * Total discount for this line item's entire quantity.
+     * @readonly
+     */
+    totalDiscount?: Price;
+    /** Line item description lines. Used for display purposes for the cart, checkout and order. */
+    descriptionLines?: DescriptionLine[];
+    /** Line item image. */
+    image?: string;
+    /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
+    physicalProperties?: PhysicalProperties$1;
+    /** Item type. Either a preset type or custom. */
+    itemType?: ItemType$1;
+    /**
+     * Fulfiller ID. Field is empty when the line item is self-fulfilled.
+     * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
+     */
+    fulfillerId?: string | null;
+    /**
+     * Number of items that were refunded.
+     * @readonly
+     */
+    refundQuantity?: number | null;
+    /**
+     * Number of items restocked.
+     * @readonly
+     */
+    restockQuantity?: number | null;
+    /** Line item price after line item discounts for display purposes. */
+    price?: Price;
+    /**
+     * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
+     * @readonly
+     */
+    priceBeforeDiscounts?: Price;
+    /**
+     * Total price after discounts, and before tax.
+     * @readonly
+     */
+    totalPriceBeforeTax?: Price;
+    /**
+     * Total price after all discounts and tax.
+     * @readonly
+     */
+    totalPriceAfterTax?: Price;
+    /**
+     * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
+     * + `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.
+     * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
+     * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
+     * + `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only.
+     */
+    paymentOption?: PaymentOptionType;
+    /**
+     * Deprecated. Use `taxInfo` instead.
+     * This field will be removed on September 30, 2024.
+     * Tax details for this line item.
+     * @deprecated Deprecated. Use `taxInfo` instead.
+     * This field will be removed on September 30, 2024.
+     * Tax details for this line item.
+     * @replacedBy tax_info
+     * @removalDate 2024-09-30
+     */
+    taxDetails?: ItemTaxFullDetails$1;
+    /** Represents all the relevant tax details for a specific line item. */
+    taxInfo?: LineItemTaxInfo;
+    /** Digital file identifier, relevant only for items with type DIGITAL. */
+    digitalFile?: DigitalFile;
+    /** Subscription info. */
+    subscriptionInfo?: SubscriptionInfo;
+    /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
+    priceDescription?: PriceDescription;
+    /**
+     * Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
+     * @readonly
+     */
+    depositAmount?: Price;
+}
+interface ProductName$1 {
+    /**
+     * __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
+     *
+     * Min: 1 character.
+     * Max: 200 characters.
+     */
+    original?: string;
+    /**
+     * Item name translated into the buyer's language.
+     *
+     * Min: 1 character.
+     * Max: 400 characters.
+     * Default: Same as `original`.
+     */
+    translated?: string | null;
+}
+/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
+interface CatalogReference$1 {
+    /** ID of the item within the catalog it belongs to. */
+    catalogItemId?: string;
+    /**
+     * ID of the app providing the catalog.
+     *
+     * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
+     *
+     * For items from Wix catalogs, the following values always apply:
+     * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
+     * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
+     * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     */
+    appId?: string;
+    /**
+     * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
+     *
+     * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
+     */
+    options?: Record<string, any> | null;
+}
+interface Price {
+    /** Amount. */
+    amount?: string;
+    /**
+     * Amount formatted with currency symbol.
+     * @readonly
+     */
+    formattedAmount?: string;
+}
+interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
+    /** Description line plain text value. */
+    plainText?: PlainTextValue;
+    /** Description line color value. */
+    colorInfo?: Color;
+    /** Description line name. */
+    name?: DescriptionLineName;
+}
+/** @oneof */
+interface DescriptionLineValueOneOf {
+    /** Description line plain text value. */
+    plainText?: PlainTextValue;
+    /** Description line color value. */
+    colorInfo?: Color;
+}
+/** @oneof */
+interface DescriptionLineDescriptionLineValueOneOf {
+}
+interface DescriptionLineName {
+    /** Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
+    original?: string;
+    /**
+     * Description line name translated into the buyer's language.
+     *
+     * Default: Same as `original`.
+     */
+    translated?: string | null;
+}
+interface PlainTextValue {
+    /** Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
+    original?: string;
+    /**
+     * Description line plain text value translated into the buyer's language.
+     *
+     * Default: Same as `original`.
+     */
+    translated?: string | null;
+}
+interface Color {
+    /** Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
+    original?: string;
+    /**
+     * Description line color name translated into the buyer's language.
+     *
+     * Default: Same as `original`.
+     */
+    translated?: string | null;
+    /** HEX or RGB color code for display. */
+    code?: string | null;
+}
+declare enum DescriptionLineType {
+    UNRECOGNISED = "UNRECOGNISED",
+    PLAIN_TEXT = "PLAIN_TEXT",
+    COLOR = "COLOR"
+}
+interface PhysicalProperties$1 {
+    /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
+    weight?: number | null;
+    /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
+    sku?: string | null;
+    /** Whether this line item is shippable. */
+    shippable?: boolean;
+}
+interface ItemType$1 extends ItemTypeItemTypeDataOneOf$1 {
+    /** Preset item type. */
+    preset?: ItemTypeItemType$1;
+    /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
+    custom?: string;
+}
+/** @oneof */
+interface ItemTypeItemTypeDataOneOf$1 {
+    /** Preset item type. */
+    preset?: ItemTypeItemType$1;
+    /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
+    custom?: string;
+}
+declare enum ItemTypeItemType$1 {
+    UNRECOGNISED = "UNRECOGNISED",
+    PHYSICAL = "PHYSICAL",
+    DIGITAL = "DIGITAL",
+    GIFT_CARD = "GIFT_CARD",
+    SERVICE = "SERVICE"
+}
+/** Type of selected payment option for catalog item */
+declare enum PaymentOptionType {
+    /** The entire payment for this item happens as part of the checkout. */
+    FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
+    /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
+    FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
+    /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
+    MEMBERSHIP = "MEMBERSHIP",
+    /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
+    DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
+    /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
+    MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
+}
+interface ItemTaxFullDetails$1 {
+    /** Taxable amount of this line item. */
+    taxableAmount?: Price;
+    /** Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`. */
+    taxRate?: string;
+    /** The calculated tax, based on the `taxableAmount` and `taxRate`. */
+    totalTax?: Price;
+}
+interface LineItemTaxInfo {
+    /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
+    taxAmount?: Price;
+    /** Amount for which tax is calculated. */
+    taxableAmount?: Price;
+    /** Tax rate %, as a decimal point. */
+    taxRate?: string | null;
+    /** Indicates whether the price already includes tax. */
+    taxIncludedInPrice?: boolean;
+    /** Tax information for a line item. */
+    taxBreakdown?: LineItemTaxBreakdown[];
+}
+/**
+ * TaxBreakdown represents tax information for a line item.
+ * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
+ */
+interface LineItemTaxBreakdown {
+    /** Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec". */
+    jurisdiction?: string | null;
+    /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000. */
+    rate?: string | null;
+    /** Amount of tax calculated for this line item. */
+    taxAmount?: Price;
+    /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
+    taxType?: string | null;
+    /**
+     * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
+     * This name should be explicit enough to allow the merchant to understand what tax was calculated.
+     */
+    taxName?: string | null;
+    /** Type of jurisdiction that taxes were calculated for. */
+    jurisdictionType?: JurisdictionType$1;
+    /** Non-taxable amount of the line item price. */
+    nonTaxableAmount?: Price;
+    /** Taxable amount of the line item price. */
+    taxableAmount?: Price;
+}
+/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
+declare enum JurisdictionType$1 {
+    UNDEFINED = "UNDEFINED",
+    COUNTRY = "COUNTRY",
+    STATE = "STATE",
+    COUNTY = "COUNTY",
+    CITY = "CITY",
+    SPECIAL = "SPECIAL"
+}
+interface DigitalFile {
+    /** ID of the secure file in media. */
+    fileId?: string;
+    /** Link will exist after the digital links have been generated on the order. */
+    link?: string | null;
+    /**
+     * Link expiration time and date.
+     * @readonly
+     */
+    expirationDate?: Date;
+}
+interface SubscriptionInfo {
+    /** Subscription ID. */
+    _id?: string | null;
+    /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
+    cycleNumber?: number;
+    /** Subscription option title. For example, `"Monthly coffee Subscription"`. */
+    subscriptionOptionTitle?: string;
+    /** Subscription option description. For example, `"1kg of selected coffee, once a month"`. */
+    subscriptionOptionDescription?: string | null;
+    /** Subscription detailed information. */
+    subscriptionSettings?: SubscriptionSettings$1;
+}
+interface SubscriptionSettings$1 {
+    /** Frequency of recurring payment. */
+    frequency?: SubscriptionFrequency$1;
+    /** Interval of recurring payment. */
+    interval?: number | null;
+    /** Whether subscription is renewed automatically at the end of each period. */
+    autoRenewal?: boolean;
+    /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
+    billingCycles?: number | null;
+}
+/** Frequency unit of recurring payment */
+declare enum SubscriptionFrequency$1 {
+    UNDEFINED = "UNDEFINED",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+interface PriceDescription {
+    /** __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
+    original?: string;
+    /**
+     * Price description translated into the buyer's language.
+     *
+     * Default: Same as `original`.
+     */
+    translated?: string | null;
+}
+interface LocationAndQuantity {
+    /** Location id in the associated owner app. */
+    _id?: string;
+    /** Location owner app, if not provided then the site business info locations will be used. */
+    appId?: string | null;
+    /** Quantity for specific location. */
+    quantity?: number;
+}
+/** Buyer Info */
+interface BuyerInfo extends BuyerInfoIdOneOf {
+    /** Visitor ID (if site visitor is not a member). */
+    visitorId?: string;
+    /** Member ID (if site visitor is a site member). */
+    memberId?: string;
+    /** Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction). */
+    contactId?: string | null;
+    /** Buyer email address. */
+    email?: string | null;
+}
+/** @oneof */
+interface BuyerInfoIdOneOf {
+    /** Visitor ID (if site visitor is not a member). */
+    visitorId?: string;
+    /** Member ID (if site visitor is a site member). */
+    memberId?: string;
+}
+declare enum PaymentStatus {
+    UNSPECIFIED = "UNSPECIFIED",
+    /** Order is not paid */
+    NOT_PAID = "NOT_PAID",
+    /** Order is paid */
+    PAID = "PAID",
+    /** Order was refunded, refund amount less than order total price */
+    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
+    /** Full order total price was refunded */
+    FULLY_REFUNDED = "FULLY_REFUNDED",
+    /** Payments received but not yet confirmed by the payment provider */
+    PENDING = "PENDING",
+    /** At least one payment was received and approved, covering less than total price amount */
+    PARTIALLY_PAID = "PARTIALLY_PAID"
+}
+declare enum FulfillmentStatus {
+    /** none of the order items are fulfilled or order was manually marked as unfulfilled */
+    NOT_FULFILLED = "NOT_FULFILLED",
+    /**
+     * All of the order items are fulfilled or order was manually marked as fulfilled
+     * Orders without shipping info are fulfilled automatically
+     */
+    FULFILLED = "FULFILLED",
+    /** Some, but not all of the order items are fulfilled */
+    PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
+}
+declare enum WeightUnit$1 {
+    /** Weight unit can't be classified, due to an error */
+    UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
+    /** Kilograms */
+    KG = "KG",
+    /** Pounds */
+    LB = "LB"
+}
+interface PriceSummary$1 {
+    /** Subtotal of all the line items, before discounts and before tax. */
+    subtotal?: Price;
+    /** Total shipping price, before discounts and before tax. */
+    shipping?: Price;
+    /** Total tax on this order. */
+    tax?: Price;
+    /** Total calculated discount value. */
+    discount?: Price;
+    /** Order’s total price after discounts and tax. */
+    total?: Price;
+    /** Total price of additional fees before tax. */
+    totalAdditionalFees?: Price;
+}
+/** Billing Info and shipping details */
+interface AddressWithContact$1 {
+    /** Address. */
+    address?: Address$1;
+    /** Contact details. */
+    contactDetails?: FullAddressContactDetails$1;
+}
+/** Physical address */
+interface Address$1 {
+    /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
+    country?: string | null;
+    /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Postal or zip code. */
+    postalCode?: string | null;
+    /** Street address. */
+    streetAddress?: StreetAddress$1;
+    /** Main address line (usually street name and number). */
+    addressLine1?: string | null;
+    /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
+    addressLine2?: string | null;
+}
+interface StreetAddress$1 {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+interface AddressLocation$1 {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+/** Full contact details for an address */
+interface FullAddressContactDetails$1 {
+    /** First name. */
+    firstName?: string | null;
+    /** Last name. */
+    lastName?: string | null;
+    /** Phone number. */
+    phone?: string | null;
+    /** Company name. */
+    company?: string | null;
+    /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
+    vatId?: VatId$1;
+}
+interface VatId$1 {
+    /** Customer's tax ID. */
+    _id?: string;
+    /**
+     * Tax type.
+     *
+     * Supported values:
+     * + `CPF`: for individual tax payers
+     * + `CNPJ`: for corporations
+     */
+    type?: VatType$1;
+}
+/** tax info types */
+declare enum VatType$1 {
+    UNSPECIFIED = "UNSPECIFIED",
+    /** CPF - for individual tax payers. */
+    CPF = "CPF",
+    /** CNPJ - for corporations */
+    CNPJ = "CNPJ"
+}
+interface ShippingInformation {
+    /** App Def Id of external provider which was a source of shipping info */
+    carrierId?: string | null;
+    /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
+    code?: string | null;
+    /**
+     * Shipping option title.
+     * For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
+     */
+    title?: string;
+    /** Shipping logistics. */
+    logistics?: DeliveryLogistics;
+    /** Shipping costs. */
+    cost?: ShippingPrice;
+    /** Shipping region. */
+    region?: ShippingRegion;
+}
+interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
+    /** Shipping address and contact details. */
+    shippingDestination?: AddressWithContact$1;
+    /** Pickup details. */
+    pickupDetails?: PickupDetails;
+    /** Expected delivery time in free text. For example, `"3-5 business days"`. */
+    deliveryTime?: string | null;
+    /** Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`. */
+    instructions?: string | null;
+    /**
+     * Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
+     * @deprecated
+     */
+    deliverByDate?: Date;
+    /** Expected delivery time. */
+    deliveryTimeSlot?: DeliveryTimeSlot;
+}
+/** @oneof */
+interface DeliveryLogisticsAddressOneOf {
+    /** Shipping address and contact details. */
+    shippingDestination?: AddressWithContact$1;
+    /** Pickup details. */
+    pickupDetails?: PickupDetails;
+}
+interface PickupDetails {
+    /** Pickup address. */
+    address?: PickupAddress;
+    /** Pickup method */
+    pickupMethod?: PickupMethod;
+}
+/** Physical address */
+interface PickupAddress {
+    /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
+    country?: string | null;
+    /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Postal or zip code. */
+    postalCode?: string | null;
+    /** Street address object, with number, name, and apartment number in separate fields. */
+    streetAddress?: StreetAddress$1;
+    /** Main address line (usually street name and number). */
+    addressLine1?: string | null;
+    /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
+    addressLine2?: string | null;
+}
+declare enum PickupMethod {
+    UNKNOWN_METHOD = "UNKNOWN_METHOD",
+    STORE_PICKUP = "STORE_PICKUP",
+    PICKUP_POINT = "PICKUP_POINT"
+}
+interface DeliveryTimeSlot {
+    /** Delivery slot starting time. */
+    from?: Date;
+    /** Delivery slot ending time. */
+    to?: Date;
+}
+interface ShippingPrice {
+    /** Shipping price for display purposes. */
+    price?: Price;
+    /**
+     * Total price of shipping after discounts (when relevant), and before tax.
+     * @readonly
+     */
+    totalPriceBeforeTax?: Price;
+    /**
+     * Shipping price after all discounts (if any exist), and after tax.
+     * @readonly
+     */
+    totalPriceAfterTax?: Price;
+    /** Tax details. */
+    taxDetails?: ItemTaxFullDetails$1;
+    /**
+     * Shipping discount before tax.
+     * @readonly
+     */
+    discount?: Price;
+}
+interface ShippingRegion {
+    /** Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`. */
+    name?: string | null;
+}
+declare enum OrderStatus {
+    INITIALIZED = "INITIALIZED",
+    APPROVED = "APPROVED",
+    CANCELED = "CANCELED"
+}
+interface TaxSummary {
+    /**
+     * Total tax.
+     * @readonly
+     */
+    totalTax?: Price;
+}
+interface OrderTaxInfo {
+    /** Calculated tax, added from line items. */
+    totalTax?: Price;
+    /** The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate. */
+    taxBreakdown?: OrderTaxBreakdown[];
+}
+/**
+ * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
+ * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
+ */
+interface OrderTaxBreakdown {
+    /** The name of the tax against which this tax amount was calculated. */
+    taxName?: string;
+    /** The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */
+    taxType?: string;
+    /** The name of the jurisdiction in which this tax detail applies. */
+    jurisdiction?: string;
+    /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
+    jurisdictionType?: JurisdictionType$1;
+    /** The rate at which this tax detail was calculated. */
+    rate?: string;
+    /** The sum of all the tax from line items that calculated by the tax identifiers. */
+    aggregatedTaxAmount?: Price;
+}
+interface AppliedDiscount$1 extends AppliedDiscountDiscountSourceOneOf$1 {
+    /** Applied coupon info. */
+    coupon?: Coupon$1;
+    /** Merchant discount. */
+    merchantDiscount?: MerchantDiscount$1;
+    /** Automatic Discount */
+    discountRule?: DiscountRule$1;
+    /**
+     * Discount type.
+     * * `"GLOBAL"` - discount applies to entire order.
+     * * `"SPECIFIC-ITEMS"` - discount applies to specific items.
+     * * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
+     */
+    discountType?: DiscountType$1;
+    /**
+     * IDs of line items discount applies to.
+     * Deprecated. Use `line_item_discounts` instead.
+     * @deprecated IDs of line items discount applies to.
+     * Deprecated. Use `line_item_discounts` instead.
+     * @replacedBy line_item_discounts
+     * @removalDate 2024-10-30
+     */
+    lineItemIds?: string[];
+    /** Discount id. */
+    _id?: string | null;
+}
+/** @oneof */
+interface AppliedDiscountDiscountSourceOneOf$1 {
+    /** Applied coupon info. */
+    coupon?: Coupon$1;
+    /** Merchant discount. */
+    merchantDiscount?: MerchantDiscount$1;
+    /** Automatic Discount */
+    discountRule?: DiscountRule$1;
+}
+declare enum DiscountType$1 {
+    GLOBAL = "GLOBAL",
+    SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
+    SHIPPING = "SHIPPING"
+}
+/** Coupon */
+interface Coupon$1 {
+    /** Coupon ID. */
+    _id?: string;
+    /** Coupon code. */
+    code?: string;
+    /** Coupon name. */
+    name?: string;
+    /** Coupon value. */
+    amount?: Price;
+}
+interface MerchantDiscount$1 extends MerchantDiscountMerchantDiscountReasonOneOf {
+    /**
+     * Pre-defined discount reason (optional).
+     * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
+     */
+    discountReason?: DiscountReason;
+    /** Discount description as free text (optional). */
+    description?: string | null;
+    /** Discount amount. */
+    amount?: Price;
+}
+/** @oneof */
+interface MerchantDiscountMerchantDiscountReasonOneOf {
+    /**
+     * Pre-defined discount reason (optional).
+     * * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
+     */
+    discountReason?: DiscountReason;
+    /** Discount description as free text (optional). */
+    description?: string | null;
+}
+declare enum DiscountReason {
+    UNSPECIFIED = "UNSPECIFIED",
+    EXCHANGED_ITEMS = "EXCHANGED_ITEMS"
+}
+interface DiscountRule$1 {
+    /** Discount rule ID */
+    _id?: string;
+    /** Discount rule name */
+    name?: DiscountRuleName$1;
+    /** Discount value. */
+    amount?: Price;
+}
+interface DiscountRuleName$1 {
+    /** Original discount rule name (in site's default language). */
+    original?: string;
+    /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
+    translated?: string | null;
+}
+interface LineItemDiscount {
+    /** ID of line item the discount applies to. */
+    _id?: string;
+    /** Total discount for this line item. */
+    totalDiscount?: Price;
+}
+interface Activity extends ActivityContentOneOf {
+    /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
+    customActivity?: CustomActivity;
+    /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
+    merchantComment?: MerchantComment;
+    /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
+    orderRefunded?: OrderRefunded;
+    /**
+     * Activity ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Activity author's email.
+     * @readonly
+     */
+    authorEmail?: string | null;
+    /**
+     * Activity creation date and time.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /** Activity type. */
+    type?: ActivityType;
+}
+/** @oneof */
+interface ActivityContentOneOf {
+    /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
+    customActivity?: CustomActivity;
+    /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
+    merchantComment?: MerchantComment;
+    /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
+    orderRefunded?: OrderRefunded;
+}
+interface CustomActivity {
+    /** ID of the app that created the custom activity. */
+    appId?: string;
+    /** Custom activity type. For example, `"Ticket number set"`. */
+    type?: string;
+    /** Additional data in key-value form. For example, `{ "Ticket number": "123456" }`. */
+    additionalData?: Record<string, string>;
+}
+/** Store owner added a comment */
+interface MerchantComment {
+    /** Merchant comment message. */
+    message?: string;
+}
+interface OrderRefunded {
+    /** Whether order was refunded manually. For example, via payment provider or using cash. */
+    manual?: boolean;
+    /** Refund amount. */
+    amount?: Price;
+    /** Reason for refund. */
+    reason?: string;
+}
+interface OrderCreatedFromExchange {
+    /** ID of the original order for which the exchange happened. */
+    originalOrderId?: string;
+}
+interface NewExchangeOrderCreated {
+    /** ID of the new order created as a result of an exchange of items. */
+    exchangeOrderId?: string;
+    /** IDs of the items that were exchanged. */
+    lineItems?: LineItemExchangeData[];
+}
+interface LineItemExchangeData {
+    /** ID of the exchanged line item. */
+    lineItemId?: string;
+    /** Line item quantity being exchanged. */
+    quantity?: number;
+}
+interface DraftOrderChangesApplied {
+    /** Draft order id. */
+    draftOrderId?: string;
+    /** Reason for edit, given by user (optional). */
+    reason?: string | null;
+    /** Changes applied to order. */
+    changes?: OrderChange[];
+}
+interface OrderChange extends OrderChangeValueOneOf {
+    lineItemChanged?: LineItemChanges;
+    lineItemAdded?: ManagedLineItem;
+    lineItemRemoved?: ManagedLineItem;
+    discountAdded?: ManagedDiscount;
+    discountRemoved?: ManagedDiscount;
+    additionalFeeAdded?: ManagedAdditionalFee;
+    additionalFeeRemoved?: ManagedAdditionalFee;
+    totalPriceChanged?: TotalPriceChange;
+}
+/** @oneof */
+interface OrderChangeValueOneOf {
+    lineItemChanged?: LineItemChanges;
+    lineItemAdded?: ManagedLineItem;
+    lineItemRemoved?: ManagedLineItem;
+    discountAdded?: ManagedDiscount;
+    discountRemoved?: ManagedDiscount;
+    additionalFeeAdded?: ManagedAdditionalFee;
+    additionalFeeRemoved?: ManagedAdditionalFee;
+    totalPriceChanged?: TotalPriceChange;
+}
+interface LineItemChanges {
+    /** Line item ID. */
+    _id?: string;
+    /** Item name. */
+    name?: ProductName$1;
+    /** Item quantity change. */
+    quantity?: LineItemQuantityChange;
+    /** Item price change. */
+    price?: LineItemPriceChange;
+}
+interface LineItemQuantityChange {
+    /** Item quantity before update. */
+    originalQuantity?: number;
+    /** Item quantity after update. */
+    newQuantity?: number;
+    /** Difference between original and new quantity. Absolute value. */
+    diff?: number;
+    /** Type of quantity change: increase or decrease. */
+    deltaType?: LineItemQuantityChangeType;
+}
+declare enum LineItemQuantityChangeType {
+    QUANTITY_INCREASED = "QUANTITY_INCREASED",
+    QUANTITY_DECREASED = "QUANTITY_DECREASED"
+}
+interface LineItemPriceChange {
+    /** Item price before update. */
+    originalPrice?: Price;
+    /** Item price after update. */
+    newPrice?: Price;
+}
+interface ManagedLineItem {
+    /** Line item ID. */
+    _id?: string;
+    /** Item name. */
+    name?: ProductName$1;
+    /** Added or removed item quantity. */
+    quantity?: number;
+}
+interface ManagedDiscount {
+    /** Discount id. */
+    _id?: string;
+    /** Discount name: coupon name / discount rule name / merchant discount description. */
+    name?: TranslatedValue;
+    /** Line items discount applies to. */
+    affectedLineItems?: LineItemAmount[];
+    /** Discount amount. */
+    totalAmount?: Price;
+}
+interface TranslatedValue {
+    /** Value in site default language. */
+    original?: string;
+    /** Translated value. */
+    translated?: string | null;
+}
+interface LineItemAmount {
+    /** Order line item id */
+    _id?: string;
+    /** Item name. */
+    name?: ProductName$1;
+    /** Amount associated with this item. (Discount amount for item / additional fee amount for item) */
+    amount?: Price;
+}
+interface ManagedAdditionalFee {
+    /** Additional fee id. */
+    _id?: string;
+    /** Additional fee name. */
+    name?: TranslatedValue;
+    /** Line items additional fee applies to. */
+    affectedLineItems?: LineItemAmount[];
+    /** Additional fee amount. */
+    totalAmount?: Price;
+}
+interface TotalPriceChange {
+    /** Order’s total price after discounts and tax. Before update */
+    originalTotal?: Price;
+    /** Order’s total price after discounts and tax. After update */
+    newTotal?: Price;
+}
+/** Payment method is saved for order */
+interface SavedPaymentMethod {
+    /** Payment method name */
+    name?: string;
+    /** Payment method description */
+    description?: string | null;
+}
+declare enum ActivityType {
+    ORDER_REFUNDED = "ORDER_REFUNDED",
+    ORDER_PLACED = "ORDER_PLACED",
+    ORDER_PAID = "ORDER_PAID",
+    ORDER_FULFILLED = "ORDER_FULFILLED",
+    ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
+    ORDER_CANCELED = "ORDER_CANCELED",
+    DOWNLOAD_LINK_SENT = "DOWNLOAD_LINK_SENT",
+    TRACKING_NUMBER_ADDED = "TRACKING_NUMBER_ADDED",
+    TRACKING_NUMBER_EDITED = "TRACKING_NUMBER_EDITED",
+    TRACKING_LINK_ADDED = "TRACKING_LINK_ADDED",
+    SHIPPING_CONFIRMATION_EMAIL_SENT = "SHIPPING_CONFIRMATION_EMAIL_SENT",
+    INVOICE_ADDED = "INVOICE_ADDED",
+    INVOICE_REMOVED = "INVOICE_REMOVED",
+    INVOICE_SENT = "INVOICE_SENT",
+    FULFILLER_EMAIL_SENT = "FULFILLER_EMAIL_SENT",
+    SHIPPING_ADDRESS_EDITED = "SHIPPING_ADDRESS_EDITED",
+    EMAIL_EDITED = "EMAIL_EDITED",
+    PICKUP_READY_EMAIL_SENT = "PICKUP_READY_EMAIL_SENT",
+    CUSTOM_ACTIVITY = "CUSTOM_ACTIVITY",
+    MERCHANT_COMMENT = "MERCHANT_COMMENT",
+    ORDER_CREATED_FROM_EXCHANGE = "ORDER_CREATED_FROM_EXCHANGE",
+    NEW_EXCHANGE_ORDER_CREATED = "NEW_EXCHANGE_ORDER_CREATED",
+    ORDER_PARTIALLY_PAID = "ORDER_PARTIALLY_PAID",
+    DRAFT_ORDER_CHANGES_APPLIED = "DRAFT_ORDER_CHANGES_APPLIED",
+    SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD"
+}
+declare enum AttributionSource {
+    UNSPECIFIED = "UNSPECIFIED",
+    FACEBOOK_ADS = "FACEBOOK_ADS"
+}
+interface CreatedBy extends CreatedByStringOneOf {
+    /**
+     * User ID - when the order was created by a Wix user on behalf of a buyer.
+     * For example, via POS (point of service).
+     */
+    userId?: string;
+    /** Member ID - when the order was created by a **logged in** site visitor. */
+    memberId?: string;
+    /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
+    visitorId?: string;
+    /** App ID - when the order was created by an external application. */
+    appId?: string;
+}
+/** @oneof */
+interface CreatedByStringOneOf {
+    /**
+     * User ID - when the order was created by a Wix user on behalf of a buyer.
+     * For example, via POS (point of service).
+     */
+    userId?: string;
+    /** Member ID - when the order was created by a **logged in** site visitor. */
+    memberId?: string;
+    /** Visitor ID - when the order was created by a site visitor that was **not** logged in. */
+    visitorId?: string;
+    /** App ID - when the order was created by an external application. */
+    appId?: string;
+}
+interface ChannelInfo {
+    /** Sales channel that submitted the order. */
+    type?: ChannelType;
+    /** Reference to an order ID from an external system. */
+    externalOrderId?: string | null;
+    /** URL to the order in the external system. */
+    externalOrderUrl?: string | null;
+}
+declare enum ChannelType {
+    UNSPECIFIED = "UNSPECIFIED",
+    WEB = "WEB",
+    POS = "POS",
+    EBAY = "EBAY",
+    AMAZON = "AMAZON",
+    OTHER_PLATFORM = "OTHER_PLATFORM",
+    WIX_APP_STORE = "WIX_APP_STORE",
+    WIX_INVOICES = "WIX_INVOICES",
+    BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
+    WISH = "WISH",
+    CLASS_PASS = "CLASS_PASS",
+    GLOBAL_E = "GLOBAL_E",
+    FACEBOOK = "FACEBOOK",
+    ETSY = "ETSY",
+    TIKTOK = "TIKTOK",
+    FAIRE_COM = "FAIRE_COM"
+}
+interface CustomField$1 {
+    /** Custom field value. */
+    value?: any;
+    /** Custom field title. */
+    title?: string;
+    /** Translated custom field title. */
+    translatedTitle?: string | null;
+}
+interface BalanceSummary {
+    /**
+     * Current amount left to pay.
+     * @readonly
+     */
+    balance?: Balance;
+    /**
+     * Sum of all approved and successful payments.
+     *
+     * The value includes payments that have subsequently been fully or partially refunded.
+     * @readonly
+     */
+    paid?: Price;
+    /**
+     * Sum of all successfully refunded payments.
+     * @readonly
+     */
+    refunded?: Price;
+}
+/**
+ * Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
+ * `amount` field depends on order payment status:
+ * + UNSPECIFIED, NOT_PAID: price_summary.total_price
+ * + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
+ * + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
+ */
+interface Balance {
+    /**
+     * Balance amount.
+     *
+     * A negative `amount` represents the amount to be refunded. This can happen due to overcharging or the order being modified after a payment has been made.
+     * @readonly
+     */
+    amount?: string;
+    /**
+     * Amount formatted with currency symbol.
+     * @readonly
+     */
+    formattedAmount?: string;
+}
+interface AdditionalFee {
+    /** Additional fee's unique code for future processing. */
+    code?: string | null;
+    /** Name of additional fee. */
+    name?: string;
+    /** Additional fee's price. */
+    price?: Price;
+    /** Tax details. */
+    taxDetails?: ItemTaxFullDetails$1;
+    /** SPI implementer's `appId`. */
+    providerAppId?: string | null;
+    /** Additional fee's price before tax. */
+    priceBeforeTax?: Price;
+    /** Additional fee's id. */
+    _id?: string;
+    /**
+     * Optional - Line items associated with this additional fee.
+     * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
+     */
+    lineItemIds?: string[];
+}
+interface FulfillmentStatusesAggregate {
+    /** Unique string values based on Fulfillment entities statuses */
+    statuses?: string[] | null;
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+interface TagList {
+    /** List of tag IDs */
+    tagIds?: string[];
+}
+interface GetPaymentSettingsResponse {
+    /** Retrieved payment settings. */
+    paymentSettings?: PaymentSettings;
+}
+interface PaymentSettings {
+    /**
+     * Whether to apply [3D Secure](https://support.wix.com/en/article/about-3d-secure-3ds-payments-with-third-party-payment-providers) during the payment process.
+     *
+     * > __Note:__
+     * > + Not all payment providers offer this feature in their Wix integration.
+     * > + If the service plugin call fails, the value set in the [extension configuration](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/payment-settings-integration-spi/introduction#configuration) for `fallbackValueForRequires3dSecure` will be used.
+     */
+    requires3dSecure?: boolean | null;
+}
+interface PaymentSettingsSPIConfig {
+    /**
+     * *Required.** Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI.
+     * For example, to call the Get Payment Settings endpoint at `https://my-payment-settings.com/v1/payment-settings`,
+     * the base URI you provide here is `https://my-payment-settings.com/`.
+     */
+    deploymentUri?: string;
+    /**
+     * The value to set for `paymentSettings.requires3dSecure` if the service plugin call fails.
+     *
+     * Default: `false`
+     */
+    fallbackValueForRequires3dSecure?: boolean;
+}
+/**
+ * this message is not directly used by any service,
+ * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
+ * e.g. SPIs, event-handlers, etc..
+ * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
+ *
+ * Example:
+ * ```typescript
+ * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
+ * ...
+ * }
+ * ```
+ */
+interface Context$1 {
+    /** A unique identifier for each request. Can be used for logging / troubleshooting */
+    requestId?: string | null;
+    /** 3 capital letters string representing a currency according to ISO-4217 */
+    currency?: string | null;
+    /** The identification type and identity data */
+    identity?: IdentificationData$1;
+    /** A string representing a language and region in the format of "xx-XX". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2 */
+    languages?: string[];
+    /** App instance ID of SPI in context */
+    instanceId?: string | null;
+}
+declare enum IdentityType$1 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: IdentityType$1;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$1 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+
+interface GetPaymentSettingsEnvelope {
+    request: GetPaymentSettingsRequest;
+    metadata: Context$1;
+}
+declare const provide$3: ServicePluginDefinition<{
+    getPaymentSettings(payload: GetPaymentSettingsEnvelope): GetPaymentSettingsResponse | Promise<GetPaymentSettingsResponse>;
+}>;
+
+declare const provide$2: BuildServicePluginDefinition<typeof provide$3>;
+
+type context$1_Activity = Activity;
+type context$1_ActivityContentOneOf = ActivityContentOneOf;
+type context$1_ActivityType = ActivityType;
+declare const context$1_ActivityType: typeof ActivityType;
+type context$1_AdditionalFee = AdditionalFee;
+type context$1_AttributionSource = AttributionSource;
+declare const context$1_AttributionSource: typeof AttributionSource;
+type context$1_Balance = Balance;
+type context$1_BalanceSummary = BalanceSummary;
+type context$1_BuyerInfo = BuyerInfo;
+type context$1_BuyerInfoIdOneOf = BuyerInfoIdOneOf;
+type context$1_ChannelInfo = ChannelInfo;
+type context$1_ChannelType = ChannelType;
+declare const context$1_ChannelType: typeof ChannelType;
+type context$1_Color = Color;
+type context$1_CreatedBy = CreatedBy;
+type context$1_CreatedByStringOneOf = CreatedByStringOneOf;
+type context$1_CustomActivity = CustomActivity;
+type context$1_DeliveryLogistics = DeliveryLogistics;
+type context$1_DeliveryLogisticsAddressOneOf = DeliveryLogisticsAddressOneOf;
+type context$1_DeliveryTimeSlot = DeliveryTimeSlot;
+type context$1_DescriptionLine = DescriptionLine;
+type context$1_DescriptionLineDescriptionLineValueOneOf = DescriptionLineDescriptionLineValueOneOf;
+type context$1_DescriptionLineName = DescriptionLineName;
+type context$1_DescriptionLineType = DescriptionLineType;
+declare const context$1_DescriptionLineType: typeof DescriptionLineType;
+type context$1_DescriptionLineValueOneOf = DescriptionLineValueOneOf;
+type context$1_DigitalFile = DigitalFile;
+type context$1_DiscountReason = DiscountReason;
+declare const context$1_DiscountReason: typeof DiscountReason;
+type context$1_DraftOrderChangesApplied = DraftOrderChangesApplied;
+type context$1_ExtendedFields = ExtendedFields;
+type context$1_FulfillmentStatus = FulfillmentStatus;
+declare const context$1_FulfillmentStatus: typeof FulfillmentStatus;
+type context$1_FulfillmentStatusesAggregate = FulfillmentStatusesAggregate;
+type context$1_GetPaymentSettingsRequest = GetPaymentSettingsRequest;
+type context$1_GetPaymentSettingsResponse = GetPaymentSettingsResponse;
+type context$1_LineItemAmount = LineItemAmount;
+type context$1_LineItemChanges = LineItemChanges;
+type context$1_LineItemDiscount = LineItemDiscount;
+type context$1_LineItemExchangeData = LineItemExchangeData;
+type context$1_LineItemPriceChange = LineItemPriceChange;
+type context$1_LineItemQuantityChange = LineItemQuantityChange;
+type context$1_LineItemQuantityChangeType = LineItemQuantityChangeType;
+declare const context$1_LineItemQuantityChangeType: typeof LineItemQuantityChangeType;
+type context$1_LineItemTaxBreakdown = LineItemTaxBreakdown;
+type context$1_LineItemTaxInfo = LineItemTaxInfo;
+type context$1_LocationAndQuantity = LocationAndQuantity;
+type context$1_ManagedAdditionalFee = ManagedAdditionalFee;
+type context$1_ManagedDiscount = ManagedDiscount;
+type context$1_ManagedLineItem = ManagedLineItem;
+type context$1_MerchantComment = MerchantComment;
+type context$1_MerchantDiscountMerchantDiscountReasonOneOf = MerchantDiscountMerchantDiscountReasonOneOf;
+type context$1_NewExchangeOrderCreated = NewExchangeOrderCreated;
+type context$1_Order = Order;
+type context$1_OrderChange = OrderChange;
+type context$1_OrderChangeValueOneOf = OrderChangeValueOneOf;
+type context$1_OrderCreatedFromExchange = OrderCreatedFromExchange;
+type context$1_OrderLineItem = OrderLineItem;
+type context$1_OrderRefunded = OrderRefunded;
+type context$1_OrderStatus = OrderStatus;
+declare const context$1_OrderStatus: typeof OrderStatus;
+type context$1_OrderTaxBreakdown = OrderTaxBreakdown;
+type context$1_OrderTaxInfo = OrderTaxInfo;
+type context$1_PaymentOptionType = PaymentOptionType;
+declare const context$1_PaymentOptionType: typeof PaymentOptionType;
+type context$1_PaymentSettings = PaymentSettings;
+type context$1_PaymentSettingsSPIConfig = PaymentSettingsSPIConfig;
+type context$1_PaymentStatus = PaymentStatus;
+declare const context$1_PaymentStatus: typeof PaymentStatus;
+type context$1_PickupAddress = PickupAddress;
+type context$1_PickupDetails = PickupDetails;
+type context$1_PickupMethod = PickupMethod;
+declare const context$1_PickupMethod: typeof PickupMethod;
+type context$1_PlainTextValue = PlainTextValue;
+type context$1_Price = Price;
+type context$1_PriceDescription = PriceDescription;
+type context$1_SavedPaymentMethod = SavedPaymentMethod;
+type context$1_ShippingInformation = ShippingInformation;
+type context$1_ShippingPrice = ShippingPrice;
+type context$1_ShippingRegion = ShippingRegion;
+type context$1_SubscriptionInfo = SubscriptionInfo;
+type context$1_TagList = TagList;
+type context$1_Tags = Tags;
+type context$1_TaxSummary = TaxSummary;
+type context$1_TotalPriceChange = TotalPriceChange;
+type context$1_TranslatedValue = TranslatedValue;
+declare namespace context$1 {
+  export { type context$1_Activity as Activity, type context$1_ActivityContentOneOf as ActivityContentOneOf, context$1_ActivityType as ActivityType, type context$1_AdditionalFee as AdditionalFee, type Address$1 as Address, type AddressLocation$1 as AddressLocation, type AddressWithContact$1 as AddressWithContact, type AppliedDiscount$1 as AppliedDiscount, type AppliedDiscountDiscountSourceOneOf$1 as AppliedDiscountDiscountSourceOneOf, context$1_AttributionSource as AttributionSource, type context$1_Balance as Balance, type context$1_BalanceSummary as BalanceSummary, type context$1_BuyerInfo as BuyerInfo, type context$1_BuyerInfoIdOneOf as BuyerInfoIdOneOf, type CatalogReference$1 as CatalogReference, type context$1_ChannelInfo as ChannelInfo, context$1_ChannelType as ChannelType, type context$1_Color as Color, type Context$1 as Context, type Coupon$1 as Coupon, type context$1_CreatedBy as CreatedBy, type context$1_CreatedByStringOneOf as CreatedByStringOneOf, type context$1_CustomActivity as CustomActivity, type CustomField$1 as CustomField, type context$1_DeliveryLogistics as DeliveryLogistics, type context$1_DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOf, type context$1_DeliveryTimeSlot as DeliveryTimeSlot, type context$1_DescriptionLine as DescriptionLine, type context$1_DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOf, type context$1_DescriptionLineName as DescriptionLineName, context$1_DescriptionLineType as DescriptionLineType, type context$1_DescriptionLineValueOneOf as DescriptionLineValueOneOf, type context$1_DigitalFile as DigitalFile, context$1_DiscountReason as DiscountReason, type DiscountRule$1 as DiscountRule, type DiscountRuleName$1 as DiscountRuleName, DiscountType$1 as DiscountType, type context$1_DraftOrderChangesApplied as DraftOrderChangesApplied, type context$1_ExtendedFields as ExtendedFields, context$1_FulfillmentStatus as FulfillmentStatus, type context$1_FulfillmentStatusesAggregate as FulfillmentStatusesAggregate, type FullAddressContactDetails$1 as FullAddressContactDetails, type context$1_GetPaymentSettingsRequest as GetPaymentSettingsRequest, type context$1_GetPaymentSettingsResponse as GetPaymentSettingsResponse, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, IdentityType$1 as IdentityType, type ItemTaxFullDetails$1 as ItemTaxFullDetails, type ItemType$1 as ItemType, ItemTypeItemType$1 as ItemTypeItemType, type ItemTypeItemTypeDataOneOf$1 as ItemTypeItemTypeDataOneOf, JurisdictionType$1 as JurisdictionType, type context$1_LineItemAmount as LineItemAmount, type context$1_LineItemChanges as LineItemChanges, type context$1_LineItemDiscount as LineItemDiscount, type context$1_LineItemExchangeData as LineItemExchangeData, type context$1_LineItemPriceChange as LineItemPriceChange, type context$1_LineItemQuantityChange as LineItemQuantityChange, context$1_LineItemQuantityChangeType as LineItemQuantityChangeType, type context$1_LineItemTaxBreakdown as LineItemTaxBreakdown, type context$1_LineItemTaxInfo as LineItemTaxInfo, type context$1_LocationAndQuantity as LocationAndQuantity, type context$1_ManagedAdditionalFee as ManagedAdditionalFee, type context$1_ManagedDiscount as ManagedDiscount, type context$1_ManagedLineItem as ManagedLineItem, type context$1_MerchantComment as MerchantComment, type MerchantDiscount$1 as MerchantDiscount, type context$1_MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOf, type context$1_NewExchangeOrderCreated as NewExchangeOrderCreated, type context$1_Order as Order, type context$1_OrderChange as OrderChange, type context$1_OrderChangeValueOneOf as OrderChangeValueOneOf, type context$1_OrderCreatedFromExchange as OrderCreatedFromExchange, type context$1_OrderLineItem as OrderLineItem, type context$1_OrderRefunded as OrderRefunded, context$1_OrderStatus as OrderStatus, type context$1_OrderTaxBreakdown as OrderTaxBreakdown, type context$1_OrderTaxInfo as OrderTaxInfo, context$1_PaymentOptionType as PaymentOptionType, type context$1_PaymentSettings as PaymentSettings, type context$1_PaymentSettingsSPIConfig as PaymentSettingsSPIConfig, context$1_PaymentStatus as PaymentStatus, type PhysicalProperties$1 as PhysicalProperties, type context$1_PickupAddress as PickupAddress, type context$1_PickupDetails as PickupDetails, context$1_PickupMethod as PickupMethod, type context$1_PlainTextValue as PlainTextValue, type context$1_Price as Price, type context$1_PriceDescription as PriceDescription, type PriceSummary$1 as PriceSummary, type ProductName$1 as ProductName, type context$1_SavedPaymentMethod as SavedPaymentMethod, type context$1_ShippingInformation as ShippingInformation, type context$1_ShippingPrice as ShippingPrice, type context$1_ShippingRegion as ShippingRegion, type StreetAddress$1 as StreetAddress, SubscriptionFrequency$1 as SubscriptionFrequency, type context$1_SubscriptionInfo as SubscriptionInfo, type SubscriptionSettings$1 as SubscriptionSettings, type context$1_TagList as TagList, type context$1_Tags as Tags, type context$1_TaxSummary as TaxSummary, type context$1_TotalPriceChange as TotalPriceChange, type context$1_TranslatedValue as TranslatedValue, type VatId$1 as VatId, VatType$1 as VatType, WeightUnit$1 as WeightUnit, provide$2 as provide };
+}
+
+interface GetValidationViolationsRequest {
+    /** Information about the source of the request. */
+    sourceInfo?: SourceInfo;
+    /** Information to validate. */
+    validationInfo?: ValidationInfo;
+}
+interface SourceInfo {
+    /** Source of the request. */
+    source?: Source;
+    /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
+    purchaseFlowId?: string | null;
+}
+declare enum Source {
+    /** Context cannot be recognized */
+    OTHER = "OTHER",
+    /** Called from Ecom's Cart service */
+    CART = "CART",
+    /** Called from Ecom's Checkout service */
+    CHECKOUT = "CHECKOUT"
+}
+/** ValidationsData is the main entity of ValidationsSPI, which contains all the data required for validations */
+interface ValidationInfo {
+    /** Buyer details. */
+    buyerDetails?: BuyerDetails;
+    /** Line items. Max: 300 line items */
+    lineItems?: LineItem[];
+    /**
+     * Applied gift card details.
+     *
+     * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/wix-stores-setting-up-wix-gift-cards).
+     */
+    giftCard?: GiftCard;
+    /**
+     * Weight measurement unit.
+     * Default: Site's weight unit
+     */
+    weightUnit?: WeightUnit;
+    /** Price summary. */
+    priceSummary?: PriceSummary;
+    /** Billing information. */
+    billingInfo?: AddressWithContact;
+    /** Shipping address and contact details. */
+    shippingAddress?: AddressWithContact;
+    /** Shipping information. */
+    shippingInfo?: ShippingInfo;
+    /** Custom fields. */
+    customFields?: CustomFields;
+    /** Applied discounts. */
+    appliedDiscounts?: AppliedDiscount[];
+}
+interface BuyerDetails {
+    /** Buyer's email address. */
+    email?: string | null;
+    /** Contact ID if one exists. */
+    contactId?: string | null;
+}
+interface LineItem {
+    /** Line item ID. */
+    _id?: string | null;
+    /**
+     * Item quantity.
+     * Min: `0`
+     * Max: `100000`
+     */
+    quantity?: number;
+    /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
+    catalogReference?: CatalogReference;
+    /**
+     * Product name. For example,
+     * + Stores: `product.name`
+     * + Bookings: `service.info.name`
+     * + Events: `ticket.name`
+     */
+    productName?: ProductName;
+    /** Price of the item **after** catalog-defined discount and line item discounts. */
+    price?: MultiCurrencyPrice;
+    /** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */
+    physicalProperties?: PhysicalProperties;
+    /** Item type. */
+    itemType?: ItemType;
+    /** [Subscription option](https://dev.wix.com/api/rest/wix-stores/subscription-options/introduction) information. A subscription is a product that is sold on a recurring basis. */
+    subscriptionOptionInfo?: SubscriptionOptionInfo;
+    /** Price breakdown for this line item. */
+    pricesBreakdown?: LineItemPricesData;
+}
+/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
+interface CatalogReference {
+    /** ID of the item within the catalog it belongs to. */
+    catalogItemId?: string;
+    /**
+     * ID of the app providing the catalog.
+     *
+     * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
+     *
+     * For items from Wix catalogs, the following values always apply:
+     * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
+     * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
+     * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     */
+    appId?: string;
+    /**
+     * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
+     *
+     * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
+     */
+    options?: Record<string, any> | null;
+}
+interface ProductName {
+    /**
+     * __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
+     *
+     * Min: 1 character.
+     * Max: 200 characters.
+     */
+    original?: string;
+    /**
+     * Item name translated into the buyer's language.
+     *
+     * Min: 1 character.
+     * Max: 400 characters.
+     * Default: Same as `original`.
+     */
+    translated?: string | null;
+}
+interface MultiCurrencyPrice {
+    /** Amount. */
+    amount?: string;
+    /**
+     * Converted amount.
+     * @readonly
+     */
+    convertedAmount?: string;
+    /**
+     * Amount formatted with currency symbol.
+     * @readonly
+     */
+    formattedAmount?: string;
+    /**
+     * Converted amount formatted with currency symbol.
+     * @readonly
+     */
+    formattedConvertedAmount?: string;
+}
+interface PhysicalProperties {
+    /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
+    weight?: number | null;
+    /** Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku). */
+    sku?: string | null;
+    /** Whether this line item is shippable. */
+    shippable?: boolean;
+}
+interface ItemType extends ItemTypeItemTypeDataOneOf {
+    /** Preset item type. */
+    preset?: ItemTypeItemType;
+    /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
+    custom?: string;
+}
+/** @oneof */
+interface ItemTypeItemTypeDataOneOf {
+    /** Preset item type. */
+    preset?: ItemTypeItemType;
+    /** Custom item type. When none of the preset types are suitable, specifies the custom type. */
+    custom?: string;
+}
+declare enum ItemTypeItemType {
+    UNRECOGNISED = "UNRECOGNISED",
+    PHYSICAL = "PHYSICAL",
+    DIGITAL = "DIGITAL",
+    GIFT_CARD = "GIFT_CARD",
+    SERVICE = "SERVICE"
+}
+interface SubscriptionOptionInfo {
+    /** Subscription option settings. */
+    subscriptionSettings?: SubscriptionSettings;
+    /** Subscription option title. */
+    title?: Title;
+    /** Subscription option description. */
+    description?: Description;
+}
+interface SubscriptionSettings {
+    /** Frequency of recurring payment. */
+    frequency?: SubscriptionFrequency;
+    /** Whether subscription is renewed automatically at the end of each period. */
+    autoRenewal?: boolean;
+    /** Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`. */
+    billingCycles?: number | null;
+}
+/** Frequency unit of recurring payment */
+declare enum SubscriptionFrequency {
+    UNDEFINED = "UNDEFINED",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+interface Title {
+    /** Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). */
+    original?: string;
+    /**
+     * Subscription option name translated into the buyer's language.
+     *
+     * Default: Same as `original`.
+     */
+    translated?: string | null;
+}
+interface Description {
+    /** Subscription option description. */
+    original?: string;
+    /** Translated subscription option description. */
+    translated?: string | null;
+}
+interface LineItemPricesData {
+    /** Total price after discounts and after tax. */
+    totalPriceAfterTax?: MultiCurrencyPrice;
+    /** Total price after discounts, and before tax. */
+    totalPriceBeforeTax?: MultiCurrencyPrice;
+    /** Tax details. */
+    taxDetails?: ItemTaxFullDetails;
+    /** Total discount for all line items. */
+    totalDiscount?: MultiCurrencyPrice;
+    /** Catalog price after catalog discount and automatic discounts. */
+    price?: MultiCurrencyPrice;
+    /** Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided. */
+    priceBeforeDiscounts?: MultiCurrencyPrice;
+    /** Total price **after** catalog-defined discount and line item discounts. */
+    lineItemPrice?: MultiCurrencyPrice;
+    /** Item price **before** line item discounts and **before** catalog-defined discount. Defaults to `price` when not provided. */
+    fullPrice?: MultiCurrencyPrice;
+}
+interface ItemTaxFullDetails {
+    /** The portion of the total amount of this estimate that was taxable. */
+    taxableAmount?: MultiCurrencyPrice;
+    /** Calculated tax, based on `taxable_amount`. */
+    totalTax?: MultiCurrencyPrice;
+    /** Indicates whether the price already includes tax. */
+    isTaxIncluded?: boolean | null;
+    /** A detailed description of all the tax authorities applied on this item. */
+    taxBreakdown?: TaxBreakdown[];
+}
+interface TaxBreakdown {
+    /** The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec". */
+    jurisdiction?: string | null;
+    /** The amount of this line item price that was considered nontaxable. (Decimal value) */
+    nonTaxableAmount?: MultiCurrencyPrice;
+    /** The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value) */
+    rate?: string | null;
+    /** The amount of tax estimated for this line item. (Decimal value) */
+    taxAmount?: MultiCurrencyPrice;
+    /** The taxable amount of this line item. */
+    taxableAmount?: MultiCurrencyPrice;
+    /** The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc. */
+    taxType?: string | null;
+    /**
+     * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
+     * This name should be explicit enough to allow the merchant to understand what tax was calculated.
+     */
+    taxName?: string | null;
+    /** The type of the jurisdiction in which this tax detail applies. */
+    jurisdictionType?: JurisdictionType;
+}
+/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
+declare enum JurisdictionType {
+    UNDEFINED = "UNDEFINED",
+    COUNTRY = "COUNTRY",
+    STATE = "STATE",
+    COUNTY = "COUNTY",
+    CITY = "CITY",
+    SPECIAL = "SPECIAL"
+}
+interface GiftCard {
+    /**
+     * Gift card ID.
+     * @deprecated
+     */
+    _id?: string;
+    /** Gift card obfuscated code. */
+    obfuscatedCode?: string;
+    /** Gift card value. */
+    amount?: MultiCurrencyPrice;
+    /** App ID of the gift card provider. */
+    appId?: string;
+}
+declare enum WeightUnit {
+    /** Weight unit can't be classified, due to an error */
+    UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
+    /** Kilograms */
+    KG = "KG",
+    /** Pounds */
+    LB = "LB"
+}
+interface PriceSummary {
+    /** Subtotal of all line items, before discounts and before tax. */
+    subtotal?: MultiCurrencyPrice;
+    /** Total shipping price, before discounts and before tax. */
+    shipping?: MultiCurrencyPrice;
+    /** Total tax. */
+    tax?: MultiCurrencyPrice;
+    /** Total calculated discount value. */
+    discount?: MultiCurrencyPrice;
+    /** Total price **after** discounts, gift cards, and tax. */
+    total?: MultiCurrencyPrice;
+    /** Total additional fees price **before** tax. */
+    additionalFees?: MultiCurrencyPrice;
+}
+/** Billing Info and shipping details */
+interface AddressWithContact {
+    /** Address. */
+    address?: Address;
+    /** Contact details. */
+    contactDetails?: FullAddressContactDetails;
+}
+/** Physical address */
+interface Address {
+    /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
+    country?: string | null;
+    /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Postal or zip code. */
+    postalCode?: string | null;
+    /** Street address. */
+    streetAddress?: StreetAddress;
+    /** Main address line (usually street name and number). */
+    addressLine1?: string | null;
+    /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
+    addressLine2?: string | null;
+}
+interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+/** Full contact details for an address */
+interface FullAddressContactDetails {
+    /** First name. */
+    firstName?: string | null;
+    /** Last name. */
+    lastName?: string | null;
+    /** Phone number. */
+    phone?: string | null;
+    /** Company name. */
+    company?: string | null;
+    /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
+    vatId?: VatId;
+}
+interface VatId {
+    /** Customer's tax ID. */
+    _id?: string;
+    /**
+     * Tax type.
+     *
+     * Supported values:
+     * + `CPF`: for individual tax payers
+     * + `CNPJ`: for corporations
+     */
+    type?: VatType;
+}
+/** tax info types */
+declare enum VatType {
+    UNSPECIFIED = "UNSPECIFIED",
+    /** CPF - for individual tax payers. */
+    CPF = "CPF",
+    /** CNPJ - for corporations */
+    CNPJ = "CNPJ"
+}
+interface ShippingInfo {
+    /** Selected option out of the options allowed for the `region`. */
+    selectedCarrierServiceOption?: SelectedCarrierServiceOption;
+}
+interface SelectedCarrierServiceOption {
+    /** Unique identifier of selected option. For example, `usps_std_overnight`. */
+    code?: string;
+    /**
+     * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
+     * For example, "Standard" or "First-Class Package International".
+     */
+    title?: string;
+    /** Shipping costs. */
+    cost?: SelectedCarrierServiceOptionPrices;
+}
+interface SelectedCarrierServiceOptionPrices {
+    /** Total shipping price, after discount and after tax. */
+    totalPriceAfterTax?: MultiCurrencyPrice;
+    /** Total price of shipping after discounts (when relevant), and before tax. */
+    totalPriceBeforeTax?: MultiCurrencyPrice;
+    /** Tax details. */
+    taxDetails?: ItemTaxFullDetails;
+    /** Shipping discount before tax. */
+    totalDiscount?: MultiCurrencyPrice;
+    /** Shipping price before discount and before tax. */
+    price?: MultiCurrencyPrice;
+}
+interface CustomFields {
+    /** List of custom fields */
+    fields?: CustomField[];
+}
+interface CustomField {
+    /** Custom field value. */
+    value?: any;
+    /** Custom field title. */
+    title?: string;
+    /** Translated custom field title. */
+    translatedTitle?: string | null;
+}
+interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
+    /** Coupon details. */
+    coupon?: Coupon;
+    /** Merchant discount. */
+    merchantDiscount?: MerchantDiscount;
+    /** Discount rule. */
+    discountRule?: DiscountRule;
+    /** Discount type. */
+    discountType?: DiscountType;
+    /** IDs of the line items the discount applies to. */
+    lineItemIds?: string[];
+}
+/** @oneof */
+interface AppliedDiscountDiscountSourceOneOf {
+    /** Coupon details. */
+    coupon?: Coupon;
+    /** Merchant discount. */
+    merchantDiscount?: MerchantDiscount;
+    /** Discount rule. */
+    discountRule?: DiscountRule;
+}
+declare enum DiscountType {
+    GLOBAL = "GLOBAL",
+    SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
+    SHIPPING = "SHIPPING"
+}
+/** Coupon */
+interface Coupon {
+    /** Coupon ID. */
+    _id?: string;
+    /** Coupon code. */
+    code?: string;
+    /** Coupon name. */
+    name?: string;
+    amount?: string;
+}
+interface MerchantDiscount {
+    amount?: string;
+}
+interface DiscountRule {
+    /** Discount rule ID. */
+    _id?: string;
+    /** Discount rule name. */
+    name?: DiscountRuleName;
+    amount?: string;
+}
+interface DiscountRuleName {
+    /** Original discount rule name (in site's default language). */
+    original?: string;
+    /** Translated discount rule name according to buyer language. Defaults to `original` when not provided. */
+    translated?: string | null;
+}
+interface GetValidationViolationsResponse {
+    /** List of validation violations. */
+    violations?: Violation[];
+}
+interface Violation {
+    /** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */
+    severity?: Severity;
+    /** Target location on a checkout or cart page where the violation will be displayed. */
+    target?: Target;
+    /** Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `<a href="https://www.wix.com">Click me</a>`. */
+    description?: string | null;
+}
+declare enum Severity {
+    /** The user is allowed to move forward in the flow. */
+    WARNING = "WARNING",
+    /**
+     * The user is blocked from moving forward in the flow.
+     * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.
+     */
+    ERROR = "ERROR"
+}
+interface Target extends TargetTargetTypeOneOf {
+    /** General (other) violation. */
+    other?: Other;
+    /** Specific line item violation. */
+    lineItem?: TargetLineItem;
+}
+/** @oneof */
+interface TargetTargetTypeOneOf {
+    /** General (other) violation. */
+    other?: Other;
+    /** Specific line item violation. */
+    lineItem?: TargetLineItem;
+}
+/** Available locations on the webpage */
+declare enum NameInOther {
+    /** default location, in case no specific location is specified */
+    OTHER_DEFAULT = "OTHER_DEFAULT"
+}
+/** Available locations on the line item */
+declare enum NameInLineItem {
+    /** default location, in case no specific location is specified */
+    LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
+}
+/** General (other) violation. */
+interface Other {
+    /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
+    name?: NameInOther;
+}
+/** Specific line item violation. */
+interface TargetLineItem {
+    /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
+    name?: NameInLineItem;
+    /** ID of the line item containing the violation. */
+    _id?: string | null;
+}
+interface ValidationsSPIConfig {
+    /** Whether to validate the cart page in addition to the checkout page. Default: `false` */
+    validateInCart?: boolean;
+    /**
+     * Required. Base URI where the endpoints are called. Wix appends the endpoint path to the base URI.
+     * For example, to call the Get Eligible Triggers endpoint at `https://my-validations.com/v1/get-violations`, the base URI you provide here is `https://my-validations.com`.
+     */
+    deploymentUri?: string;
+}
+/**
+ * this message is not directly used by any service,
+ * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
+ * e.g. SPIs, event-handlers, etc..
+ * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
+ *
+ * Example:
+ * ```typescript
+ * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
+ * ...
+ * }
+ * ```
+ */
+interface Context {
+    /** A unique identifier for each request. Can be used for logging / troubleshooting */
+    requestId?: string | null;
+    /** 3 capital letters string representing a currency according to ISO-4217 */
+    currency?: string | null;
+    /** The identification type and identity data */
+    identity?: IdentificationData;
+    /** A string representing a language and region in the format of "xx-XX". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2 */
+    languages?: string[];
+    /** App instance ID of SPI in context */
+    instanceId?: string | null;
+}
+declare enum IdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: IdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+
+interface GetValidationViolationsEnvelope {
+    request: GetValidationViolationsRequest;
+    metadata: Context;
+}
+declare const provide$1: ServicePluginDefinition<{
+    getValidationViolations(payload: GetValidationViolationsEnvelope): GetValidationViolationsResponse | Promise<GetValidationViolationsResponse>;
+}>;
+
+declare const provide: BuildServicePluginDefinition<typeof provide$1>;
+
+type context_Address = Address;
+type context_AddressLocation = AddressLocation;
+type context_AddressWithContact = AddressWithContact;
+type context_AppliedDiscount = AppliedDiscount;
+type context_AppliedDiscountDiscountSourceOneOf = AppliedDiscountDiscountSourceOneOf;
+type context_BuyerDetails = BuyerDetails;
+type context_CatalogReference = CatalogReference;
+type context_Context = Context;
+type context_Coupon = Coupon;
+type context_CustomField = CustomField;
+type context_CustomFields = CustomFields;
+type context_Description = Description;
+type context_DiscountRule = DiscountRule;
+type context_DiscountRuleName = DiscountRuleName;
+type context_DiscountType = DiscountType;
+declare const context_DiscountType: typeof DiscountType;
+type context_FullAddressContactDetails = FullAddressContactDetails;
+type context_GetValidationViolationsRequest = GetValidationViolationsRequest;
+type context_GetValidationViolationsResponse = GetValidationViolationsResponse;
+type context_GiftCard = GiftCard;
+type context_IdentificationData = IdentificationData;
+type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type context_IdentityType = IdentityType;
+declare const context_IdentityType: typeof IdentityType;
+type context_ItemTaxFullDetails = ItemTaxFullDetails;
+type context_ItemType = ItemType;
+type context_ItemTypeItemType = ItemTypeItemType;
+declare const context_ItemTypeItemType: typeof ItemTypeItemType;
+type context_ItemTypeItemTypeDataOneOf = ItemTypeItemTypeDataOneOf;
+type context_JurisdictionType = JurisdictionType;
+declare const context_JurisdictionType: typeof JurisdictionType;
+type context_LineItem = LineItem;
+type context_LineItemPricesData = LineItemPricesData;
+type context_MerchantDiscount = MerchantDiscount;
+type context_MultiCurrencyPrice = MultiCurrencyPrice;
+type context_NameInLineItem = NameInLineItem;
+declare const context_NameInLineItem: typeof NameInLineItem;
+type context_NameInOther = NameInOther;
+declare const context_NameInOther: typeof NameInOther;
+type context_Other = Other;
+type context_PhysicalProperties = PhysicalProperties;
+type context_PriceSummary = PriceSummary;
+type context_ProductName = ProductName;
+type context_SelectedCarrierServiceOption = SelectedCarrierServiceOption;
+type context_SelectedCarrierServiceOptionPrices = SelectedCarrierServiceOptionPrices;
+type context_Severity = Severity;
+declare const context_Severity: typeof Severity;
+type context_ShippingInfo = ShippingInfo;
+type context_Source = Source;
+declare const context_Source: typeof Source;
+type context_SourceInfo = SourceInfo;
+type context_StreetAddress = StreetAddress;
+type context_SubscriptionFrequency = SubscriptionFrequency;
+declare const context_SubscriptionFrequency: typeof SubscriptionFrequency;
+type context_SubscriptionOptionInfo = SubscriptionOptionInfo;
+type context_SubscriptionSettings = SubscriptionSettings;
+type context_Target = Target;
+type context_TargetLineItem = TargetLineItem;
+type context_TargetTargetTypeOneOf = TargetTargetTypeOneOf;
+type context_TaxBreakdown = TaxBreakdown;
+type context_Title = Title;
+type context_ValidationInfo = ValidationInfo;
+type context_ValidationsSPIConfig = ValidationsSPIConfig;
+type context_VatId = VatId;
+type context_VatType = VatType;
+declare const context_VatType: typeof VatType;
+type context_Violation = Violation;
+type context_WeightUnit = WeightUnit;
+declare const context_WeightUnit: typeof WeightUnit;
+declare const context_provide: typeof provide;
+declare namespace context {
+  export { type context_Address as Address, type context_AddressLocation as AddressLocation, type context_AddressWithContact as AddressWithContact, type context_AppliedDiscount as AppliedDiscount, type context_AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOf, type context_BuyerDetails as BuyerDetails, type context_CatalogReference as CatalogReference, type context_Context as Context, type context_Coupon as Coupon, type context_CustomField as CustomField, type context_CustomFields as CustomFields, type context_Description as Description, type context_DiscountRule as DiscountRule, type context_DiscountRuleName as DiscountRuleName, context_DiscountType as DiscountType, type context_FullAddressContactDetails as FullAddressContactDetails, type context_GetValidationViolationsRequest as GetValidationViolationsRequest, type context_GetValidationViolationsResponse as GetValidationViolationsResponse, type context_GiftCard as GiftCard, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, type context_ItemTaxFullDetails as ItemTaxFullDetails, type context_ItemType as ItemType, context_ItemTypeItemType as ItemTypeItemType, type context_ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOf, context_JurisdictionType as JurisdictionType, type context_LineItem as LineItem, type context_LineItemPricesData as LineItemPricesData, type context_MerchantDiscount as MerchantDiscount, type context_MultiCurrencyPrice as MultiCurrencyPrice, context_NameInLineItem as NameInLineItem, context_NameInOther as NameInOther, type context_Other as Other, type context_PhysicalProperties as PhysicalProperties, type context_PriceSummary as PriceSummary, type context_ProductName as ProductName, type context_SelectedCarrierServiceOption as SelectedCarrierServiceOption, type context_SelectedCarrierServiceOptionPrices as SelectedCarrierServiceOptionPrices, context_Severity as Severity, type context_ShippingInfo as ShippingInfo, context_Source as Source, type context_SourceInfo as SourceInfo, type context_StreetAddress as StreetAddress, context_SubscriptionFrequency as SubscriptionFrequency, type context_SubscriptionOptionInfo as SubscriptionOptionInfo, type context_SubscriptionSettings as SubscriptionSettings, type context_Target as Target, type context_TargetLineItem as TargetLineItem, type context_TargetTargetTypeOneOf as TargetTargetTypeOneOf, type context_TaxBreakdown as TaxBreakdown, type context_Title as Title, type context_ValidationInfo as ValidationInfo, type context_ValidationsSPIConfig as ValidationsSPIConfig, type context_VatId as VatId, context_VatType as VatType, type context_Violation as Violation, context_WeightUnit as WeightUnit, context_provide as provide };
+}
+
+export { context$3 as additionalFees, context$2 as customTriggers, context$1 as paymentSettings, context$4 as shippingRates, context as validations };