@wix/ecom 1.0.520 → 1.0.522

package/build/cjs/src/interfaces-ecommerce-v1-validations-provider.universal.d.ts

@@ -1,535 +0,0 @@
-export declare const __debug: {
-    verboseLogging: {
-        on: () => boolean;
-        off: () => boolean;
-    };
-};
-export interface ValidationsProvider {
-}
-export interface GetValidationViolationsRequest {
-    /** Information about the source of the request. */
-    sourceInfo?: SourceInfo;
-    /** Information to validate. */
-    validationInfo?: ValidationInfo;
-}
-export interface SourceInfo {
-    /** Source of the request. */
-    source?: Source;
-    /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
-    purchaseFlowId?: string | null;
-}
-export 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 */
-export 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 SPI 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[];
-}
-export interface BuyerDetails {
-    /** Buyer's email address. */
-    email?: string | null;
-    /** Contact ID if one exists. */
-    contactId?: string | null;
-}
-export 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;
-}
-/** Used for grouping line items and is sent on add to cart */
-export interface CatalogReference {
-    /** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `bookingId` for Wix Bookings. */
-    catalogItemId?: string;
-    /**
-     * ID of the app providing the catalog. For items from Wix apps, the following values always apply:
-     * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
-     * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
-     */
-    appId?: string;
-    /**
-     * Additional info in key:value pairs. For example, to specify Wix Stores product options or variants:
-     * + `{"options": {"options": {"Size": "M", "Color": "Red"}}}`
-     * + `{"options": {"variantId": "<VARIANT_ID>"}}`
-     */
-    options?: Record<string, any> | null;
-}
-export interface ProductName {
-    /**
-     * __Required.__ Original item name in site's default language.
-     * Min: 1 character
-     * Max: 200 characters
-     */
-    original?: string;
-    /**
-     * Optional. Translated item name according to buyer language. Defaults to `original` when not provided.
-     * Min: 1 character
-     * Max: 400 characters
-     */
-    translated?: string | null;
-}
-export 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;
-}
-export interface PhysicalProperties {
-    /** Line item weight. Measurement unit (KG or LB) is taken from `order.weightUnit`. */
-    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;
-}
-export interface ItemType extends ItemTypeItemTypeDataOneOf {
-    /** Preset item type. */
-    preset?: ItemTypeItemType;
-    /** Custom item type. */
-    custom?: string;
-}
-/** @oneof */
-export interface ItemTypeItemTypeDataOneOf {
-    /** Preset item type. */
-    preset?: ItemTypeItemType;
-    /** Custom item type. */
-    custom?: string;
-}
-export declare enum ItemTypeItemType {
-    UNRECOGNISED = "UNRECOGNISED",
-    PHYSICAL = "PHYSICAL",
-    DIGITAL = "DIGITAL",
-    GIFT_CARD = "GIFT_CARD",
-    SERVICE = "SERVICE"
-}
-export interface SubscriptionOptionInfo {
-    /** Subscription option settings. */
-    subscriptionSettings?: SubscriptionSettings;
-    /** Subscription option title. */
-    title?: Title;
-    /** Subscription option description. */
-    description?: Description;
-}
-export 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: true`. */
-    billingCycles?: number | null;
-}
-/** Frequency unit of recurring payment */
-export declare enum SubscriptionFrequency {
-    UNDEFINED = "UNDEFINED",
-    DAY = "DAY",
-    WEEK = "WEEK",
-    MONTH = "MONTH",
-    YEAR = "YEAR"
-}
-export interface Title {
-    /** Subscription option name. */
-    original?: string;
-    /** Translated subscription option name. */
-    translated?: string | null;
-}
-export interface Description {
-    /** Subscription option description. */
-    original?: string;
-    /** Translated subscription option description. */
-    translated?: string | null;
-}
-export interface GiftCard {
-    /** Gift card ID. */
-    _id?: string;
-    /** Gift card obfuscated code. */
-    obfuscatedCode?: string;
-    /** Gift card value. */
-    amount?: MultiCurrencyPrice;
-    /** App ID of the gift card provider. */
-    appId?: string;
-}
-export 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"
-}
-export 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 */
-export interface AddressWithContact {
-    /** Address. */
-    address?: Address;
-    /** Contact details. */
-    contactDetails?: FullAddressContactDetails;
-}
-/** Physical address */
-export 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;
-}
-export interface StreetAddress {
-    /** Street number. */
-    number?: string;
-    /** Street name. */
-    name?: string;
-}
-export interface AddressLocation {
-    /** Address latitude. */
-    latitude?: number | null;
-    /** Address longitude. */
-    longitude?: number | null;
-}
-/** Full contact details for an address */
-export 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;
-}
-export 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 */
-export declare enum VatType {
-    UNSPECIFIED = "UNSPECIFIED",
-    /** CPF - for individual tax payers. */
-    CPF = "CPF",
-    /** CNPJ - for corporations */
-    CNPJ = "CNPJ"
-}
-export interface ShippingInfo {
-    /** Selected option out of the options allowed for the `region`. */
-    selectedCarrierServiceOption?: SelectedCarrierServiceOption;
-}
-export interface SelectedCarrierServiceOption {
-    /** Unique identifier of selected option. For example, `usps_std_overnight`. */
-    code?: string;
-}
-export interface CustomFields {
-    /** List of custom fields */
-    fields?: CustomField[];
-}
-export interface CustomField {
-    /** Custom field value. */
-    value?: any;
-    /** Custom field title. */
-    title?: string;
-    /** Translated custom field title. */
-    translatedTitle?: string | null;
-}
-export 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 */
-export interface AppliedDiscountDiscountSourceOneOf {
-    /** Coupon details. */
-    coupon?: Coupon;
-    /** Merchant discount. */
-    merchantDiscount?: MerchantDiscount;
-    /** Discount rule. */
-    discountRule?: DiscountRule;
-}
-export declare enum DiscountType {
-    GLOBAL = "GLOBAL",
-    SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
-    SHIPPING = "SHIPPING"
-}
-/** Coupon */
-export interface Coupon {
-    /** Coupon ID. */
-    _id?: string;
-    /** Coupon code. */
-    code?: string;
-    /** Coupon name. */
-    name?: string;
-    amount?: string;
-}
-export interface MerchantDiscount {
-    amount?: string;
-}
-export interface DiscountRule {
-    /** Discount rule ID. */
-    _id?: string;
-    /** Discount rule name. */
-    name?: DiscountRuleName;
-    amount?: string;
-}
-export 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;
-}
-export interface GetValidationViolationsResponse {
-    /** List of validation violations. */
-    violations?: Violation[];
-}
-export 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;
-}
-export 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"
-}
-export interface Target extends TargetTargetTypeOneOf {
-    /** Specific line item violation. */
-    other?: Other;
-    /** Other violation. */
-    lineItem?: TargetLineItem;
-}
-/** @oneof */
-export interface TargetTargetTypeOneOf {
-    /** Specific line item violation. */
-    other?: Other;
-    /** Other violation. */
-    lineItem?: TargetLineItem;
-}
-/** Available locations on the webpage */
-export declare enum NameInOther {
-    /** default location, in case no specific location is specified */
-    OTHER_DEFAULT = "OTHER_DEFAULT"
-}
-/** Available locations on the line item */
-export declare enum NameInLineItem {
-    /** default location, in case no specific location is specified */
-    LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
-}
-/** General (other) violation. */
-export interface Other {
-    /**
-     * Where on the checkout and cart page the violation will be displayed.
-     * Supported values:
-     * + `OTHER_DEFAULT`: The default location on a checkout or cart page where a general (other) violation will be displayed.
-     */
-    name?: NameInOther;
-}
-/** Specific line item violation. */
-export interface TargetLineItem {
-    /**
-     * Where on the checkout and cart page the violation belonging to a specific line item will be displayed.
-     * Supported values:
-     * + `LINE_ITEM_DEFAULT`: The default location on a checkout or cart page where a line item violation will be displayed.
-     */
-    name?: NameInLineItem;
-    /** ID of the line item containing the violation. */
-    _id?: string | null;
-}
-export interface ValidationsSPIConfig {
-    /** Whether to validate the cart page in addition to the checkout page. Default: `false` */
-    validateInCart?: boolean;
-    /** Base URI which Wix eCommerce will call to retrieve the validation violations. For example, `"deploymentUri": "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: OrderCanceledEvent, context: Context) {
- * ...
- * }
- * ```
- */
-export 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;
-}
-export declare enum IdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-export 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 */
-export 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;
-}
-export interface GetValidationViolationsResponseNonNullableFields {
-    violations: {
-        severity: Severity;
-        target?: {
-            other?: {
-                name: NameInOther;
-            };
-            lineItem?: {
-                name: NameInLineItem;
-            };
-        };
-    }[];
-}
-/**
- * This endpoint retrieves validation violations from your app.
- *
- * Wix calls this endpoint when certain actions are performed on a visitor's cart and checkout. For example, when an item is added to the cart, or when a coupon is added to a checkout.
- * This endpoint validates a visitor's cart and checkout, and returns any validation violations (using the structure provided by Wix eCommerce). Site visitors can see the validation violations in their cart and checkout pages. If there aren't any validation violations, the endpoint returns an object containing an empty list.
- *
- * > __Notes:__
- * > + By default, this endpoint only retrieves validation violations from a visitor's checkout. If you want to also retrieve validation violations from a visitor's cart, set the `validateInCart` parameter to `true` in the Ecom Validations Integration's config file located in the [Wix Developers Center](https://dev.wix.com/). For more information, see the [prerequisites](https://dev.wix.com/api/rest/drafts/validations-integration-spi/introduction#drafts_validations-integration-spi_introduction_prerequisites) section of the introduction.
- * > + You cannot try out this endpoint because it has to be implemented by an app and can have an arbitrary URL. Therefore, ignore the **Authorization** and **POST** sections below as well as the **Try It Out** button.
- * @public
- * @documentationMaturity preview
- */
-export declare function getValidationViolations(options?: GetValidationViolationsOptions): Promise<GetValidationViolationsResponse & GetValidationViolationsResponseNonNullableFields>;
-export interface GetValidationViolationsOptions {
-    /** Information about the source of the request. */
-    sourceInfo?: SourceInfo;
-    /** Information to validate. */
-    validationInfo?: ValidationInfo;
-}