@wix/ditto-codegen-public 1.0.7 → 1.0.8

package/dist/docs-output/service-plugins/ecom-validations-doc.txt

@@ -0,0 +1,579 @@
+
+<validations_service_plugin>
+<purpose>Required. Base URI where the endpoints are called. Wix appends the endpoint path to the base URI.
+For example, to call the Get Validation Violations endpoint at `https://my-validations.com/v1/get-violations`, the base URI you provide here is `https://my-validations.com`.</purpose>
+<use_cases>
+- Handle sourceInfo: Information about the source of the request.
+- Handle validationInfo: Information to validate.
+</use_cases>
+<required_handlers>
+- getValidationViolations() - Handler to process: Information about the source of the request.
+</required_handlers>
+<import>import { validations } from '@wix/ecom/service-plugins'</import>
+<types>
+
+**Address**
+Properties:
+- addressLine1: string - Main address line (usually street name and number).
+
+maxLength 150
+- addressLine2: string - Free text providing more detailed address info. Usually contains apt, suite, floor.
+
+maxLength 100
+- city: string - City name.
+
+maxLength 50
+- country: string - Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
+
+format COUNTRY
+- countryFullname: string - Country's full name.
+- postalCode: string - Postal or zip code.
+
+maxLength 50
+- streetAddress: StreetAddress - Street address.
+- subdivision: string - Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
+
+maxLength 50
+- subdivisionFullname: string - Subdivision full-name.
+
+**AddressWithContact**
+Properties:
+- address: Address - Address.
+- contactDetails: FullAddressContactDetails - Contact details.
+
+**ApplicableLineItems**
+Properties:
+- lineItemIds: string[] - Line items that the delivery solution is for.
+
+maxSize 300, minLength 1, maxLength 100
+
+**AppliedDiscount**
+Properties:
+- discountType: DiscountType - Discount type.
+- lineItemIds: string[] - IDs of the line items the discount applies to.
+
+format GUID
+One of (discountSource):
+- coupon: Coupon - Coupon details.
+- discountRule: DiscountRule - Discount rule.
+- merchantDiscount: MerchantDiscount - Merchant discount.
+
+**BuyerDetails**
+Properties:
+- contactId: string - Contact ID if one exists.
+
+format GUID
+- email: string - Buyer's email address.
+
+format EMAIL
+
+**Carrier**
+Properties:
+- appId: string - The carrier app id
+
+format GUID
+- code: string - Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
+
+maxLength 250
+
+**CatalogReference**
+Properties:
+- appId: string - ID of the app providing the catalog.
+
+You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-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"`
+
+minLength 1
+- catalogItemId: string - ID of the item within the catalog it belongs to.
+
+minLength 1, maxLength 36
+- options: Record<string, any> - 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
+
+**CheckoutStage**
+Enum values:
+- INITIALIZATION: Deprecated.
+Used during the initialization of the checkout (Create Checkout).
+- IN_PROGRESS: Used during the checkout process, such as updating or retrieving the checkout.
+- ORDER_CREATION: Used during the creation of an order from the checkout.
+- UNKNOWN_CHECKOUT_STAGE: Not implemented.
+
+**Context**
+Properties:
+- currency: string - [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.
+
+format CURRENCY
+- identity: IdentificationData - An object that describes the identity that triggered this request.
+- instanceId: string - The service provider app's instance ID.
+
+format GUID
+- languages: string[] - 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. For example, `"en-US"`.
+- requestId: string - A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs.
+
+**Coupon**
+Properties:
+- _id: string - Coupon ID.
+- amount: string
+
+decimalValue { gte:0, lte:1000000000000000 }
+- code: string - Coupon code.
+- name: string - Coupon name.
+
+**CustomField**
+Properties:
+- title: string - Custom field title.
+
+minLength 1, maxLength 500
+- translatedTitle: string - Translated custom field title.
+
+minLength 1, maxLength 500
+- value: any - Custom field value.
+
+**CustomFields**
+Properties:
+- fields: CustomField[] - List of custom fields
+
+maxSize 50
+
+**DeliveryAllocation**
+Properties:
+- applicableLineItems: ApplicableLineItems - Populated if the delivery solution is a partially supplied by this carrier.
+- deliveryCarrier: Carrier - The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers
+- deliveryRegion: Region - The delivery region that are relevant for this delivery solution.
+
+**Description**
+Properties:
+- original: string - Subscription option description.
+
+maxLength 500
+- translated: string - Translated subscription option description.
+
+maxLength 500
+
+**DiscountRule**
+Properties:
+- _id: string - Discount rule ID.
+
+format GUID
+- amount: string
+
+decimalValue { gte:0, lte:1000000000000000 }
+- name: DiscountRuleName - Discount rule name.
+
+**DiscountRuleName**
+Properties:
+- original: string - Original discount rule name (in site's default language).
+
+minLength 1, maxLength 256
+- translated: string - Translated discount rule name according to buyer language. Defaults to `original` when not provided.
+
+minLength 1, maxLength 500
+
+**DiscountType**
+Enum values:
+- GLOBAL: Global discount.
+- SHIPPING: Shipping discount.
+- SPECIFIC_ITEMS: Discount for specific items.
+
+**ExternalReference**
+Properties:
+- appId: string - ID of the app associated with the purchase flow.
+For example, the Wix Pay Links app ID.
+
+format GUID, immutable
+- resourceId: string - Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
+For example, a Wix Pay Link ID.
+
+minLength 1, maxLength 100, immutable
+
+**FreeTrialPeriod**
+Properties:
+- frequency: SubscriptionFrequency - Frequency of period. Values: DAY, WEEK, MONTH, YEAR
+- interval: number - interval of period
+
+min 1, max 999
+
+**FullAddressContactDetails**
+Properties:
+- company: string - Company name.
+
+maxLength 1000
+- firstName: string - First name.
+
+maxLength 100
+- lastName: string - Last name.
+
+maxLength 100
+- phone: string - Phone number.
+
+format PHONE
+- vatId: VatId - Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
+
+**GetValidationViolationsEnvelope**
+Properties:
+- metadata: Context
+- request: GetValidationViolationsRequest
+
+**GetValidationViolationsRequest**
+Properties:
+- sourceInfo: SourceInfo - Information about the source of the request.
+- validationInfo: ValidationInfo - Information to validate.
+
+**GetValidationViolationsResponse**
+Properties:
+- violations: Violation[] - List of validation violations.
+
+**GiftCard**
+Properties:
+- _id: string (deprecated) - Gift card ID.
+- amount: MultiCurrencyPrice - Gift card value.
+- appId: string - App ID of the gift card provider.
+
+format GUID
+- obfuscatedCode: string - Gift card obfuscated code.
+
+**IdentificationData**
+Properties:
+- identityType: IdentityType
+One of (id):
+- anonymousVisitorId: string - ID of a site visitor that has not logged in to the site.
+- appId: string - ID of an app.
+- memberId: string - ID of a site visitor that has logged in to the site.
+- wixUserId: string - ID of a Wix user (site owner, contributor, etc.).
+
+**IdentityType**
+Enum values:
+- ANONYMOUS_VISITOR
+- APP
+- MEMBER
+- UNKNOWN
+- WIX_USER
+
+**ItemTaxFullDetails**
+Properties:
+- isTaxIncluded: boolean - Indicates whether the price already includes tax.
+- taxableAmount: MultiCurrencyPrice - The portion of the total amount of this estimate that was taxable.
+- taxBreakdown: TaxBreakdown[] - A detailed description of all the tax authorities applied on this item.
+
+maxSize 1000
+- totalTax: MultiCurrencyPrice - Calculated tax, based on `taxable_amount`.
+
+**ItemType**
+One of (itemTypeData):
+- custom: string - Custom item type. When none of the preset types are suitable, specifies the custom type.
+- preset: ItemTypeItemType - Preset item type.
+
+**ItemTypeItemType**
+Enum values:
+- DIGITAL
+- GIFT_CARD
+- PHYSICAL
+- SERVICE
+- UNRECOGNISED
+
+**JurisdictionType**
+Enum values:
+- CITY: City jurisdiction.
+- COUNTRY: Country jurisdiction.
+- COUNTY: County jurisdiction.
+- SPECIAL: Special jurisdiction.
+- STATE: State jurisdiction.
+- UNDEFINED: Undefined jurisdiction type.
+
+**LineItem**
+Properties:
+- _id: string - Line item ID.
+
+format GUID
+- catalogReference: CatalogReference - Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.
+- itemType: ItemType - Item type.
+- physicalProperties: PhysicalProperties - Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
+- price: MultiCurrencyPrice - Price of the item **after** catalog-defined discount and line item discounts.
+- pricesBreakdown: LineItemPricesData - Price breakdown for this line item.
+- productName: ProductName - Product name. For example,
++ Stores: `product.name`
++ Bookings: `service.info.name`
++ Events: `ticket.name`
+- quantity: number - Item quantity.
+Min: `0`
+Max: `100000`
+
+max 100000
+- subscriptionOptionInfo: SubscriptionOptionInfo - [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.
+
+**LineItemPricesData**
+Properties:
+- fullPrice: MultiCurrencyPrice - Item price **before** all discounts. Defaults to `price` when not provided.
+- lineItemPrice: MultiCurrencyPrice - Total price **after** catalog-defined discount and automatic discounts, taking line item's quantity into account.
+- price: MultiCurrencyPrice - Catalog price **after** catalog-defined discount and automatic discounts.
+- priceBeforeDiscounts: MultiCurrencyPrice - Item price **before** automatic discounts, coupons, and global discounts, **after** catalog-defined discount. Defaults to `price` when not provided.
+- taxDetails: ItemTaxFullDetails - Tax details.
+- totalDiscount: MultiCurrencyPrice - Total discount applied for the line item.
+- totalPriceAfterTax: MultiCurrencyPrice - Total price after discounts and after tax.
+- totalPriceBeforeTax: MultiCurrencyPrice - Total price after discounts, and before tax.
+
+**MerchantDiscount**
+Properties:
+- amount: string
+
+decimalValue { gte:0, lte:1000000000000000 }
+
+**MultiCurrencyPrice**
+Properties:
+- amount: string - Amount.
+
+decimalValue { gte:0, lte:1000000000000000 }
+- convertedAmount: string - Converted amount.
+
+decimalValue { gte:0, lte:1000000000000000 }
+- formattedAmount: string - Amount formatted with currency symbol.
+- formattedConvertedAmount: string - Converted amount formatted with currency symbol.
+
+**Other**
+Properties:
+- name: string - Location on a checkout or a cart page where a general (other) violation will be displayed.
+
+**PhysicalProperties**
+Properties:
+- shippable: boolean - Whether this line item is shippable.
+- sku: string - Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
+
+maxLength 40
+- weight: number - Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
+
+**PriceSummary**
+Properties:
+- additionalFees: MultiCurrencyPrice - Total additional fees price **before** tax.
+- discount: MultiCurrencyPrice - Total calculated discount value.
+- shipping: MultiCurrencyPrice - Total shipping price, before discounts and before tax.
+- subtotal: MultiCurrencyPrice - Subtotal of all line items, before discounts and before tax.
+- tax: MultiCurrencyPrice - Total tax.
+- total: MultiCurrencyPrice - Total price **after** discounts, gift cards, and tax.
+
+**ProductName**
+Properties:
+- original: string - __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.
+
+minLength 1, maxLength 200
+- translated: string - Item name translated into the buyer's language.
+
+Min: 1 character.
+Max: 400 characters.
+Default: Same as `original`.
+
+minLength 1, maxLength 400
+
+**Region**
+Properties:
+- _id: string - The delivery region id.
+
+format GUID
+- name: string - The delivery region name.
+
+maxLength 100
+
+**SelectedCarrierServiceOption**
+Properties:
+- code: string - Unique identifier of selected option. For example, `usps_std_overnight`.
+
+maxLength 100
+- cost: SelectedCarrierServiceOptionPrices - Shipping costs.
+- deliveryAllocations: DeliveryAllocation[] - Delivery solution allocations to different delivery carriers and delivery regions
+
+maxSize 300
+- partial: boolean - If the delivery solution is a partial and doesn't apply to all items.
+- title: string - Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
+For example, "Standard" or "First-Class Package International".
+
+maxLength 250
+
+**SelectedCarrierServiceOptionPrices**
+Properties:
+- price: MultiCurrencyPrice - Shipping price before discount and before tax.
+- taxDetails: ItemTaxFullDetails - Tax details.
+- totalDiscount: MultiCurrencyPrice - Shipping discount before tax.
+- totalPriceAfterTax: MultiCurrencyPrice - Total shipping price, after discount and after tax.
+- totalPriceBeforeTax: MultiCurrencyPrice - Total price of shipping after discounts (when relevant), and before tax.
+
+**Severity**
+Enum values:
+- ERROR: 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.
+- WARNING: The user is allowed to move forward in the flow.
+
+**ShippingInfo**
+Properties:
+- selectedCarrierServiceOption: SelectedCarrierServiceOption - Selected option out of the options allowed for the `region`.
+
+**Source**
+Enum values:
+- CART: Called from Ecom's Cart service
+- CHECKOUT: Called from Ecom's Checkout service
+- OTHER: Context cannot be recognized
+
+**SourceInfo**
+Properties:
+- purchaseFlowId: string - Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
+
+format GUID
+- source: Source - Source of the request.
+- stage: Stage - The stage at which the service plugin is called.
+
+**Stage**
+One of (stages):
+- checkoutStage: CheckoutStage - Supported values:
+
+**StreetAddress**
+Properties:
+- name: string - Street name.
+- number: string - Street number.
+
+**SubscriptionFrequency**
+Enum values:
+- DAY
+- MONTH
+- UNDEFINED
+- WEEK
+- YEAR
+
+**SubscriptionOptionInfo**
+Properties:
+- description: Description - Subscription option description.
+- subscriptionSettings: SubscriptionSettings - Subscription option settings.
+- title: Title - Subscription option title.
+
+**SubscriptionSettings**
+Properties:
+- autoRenewal: boolean - Whether subscription is renewed automatically at the end of each period.
+- billingCycles: number - Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
+
+min 1
+- enableCustomerCancellation: boolean - Whether to allow the customer to cancel the subscription..
+- freeTrialPeriod: FreeTrialPeriod - Period until first cycle starts. If applied payNow will be 0
+If None => no free trial
+- frequency: SubscriptionFrequency - Frequency of recurring payment.
+- interval: number - Interval of recurring payment.
+
+Default: `1`.
+If SubscriptionFrequency is Day the minimum interval is 7
+
+min 1, max 3650
+
+**Target**
+One of (targetType):
+- lineItem: TargetLineItem - Specific line item violation.
+- other: Other - General (other) violation.
+
+**TargetLineItem**
+Properties:
+- _id: string - ID of the line item containing the violation.
+- name: string - Location on a checkout or a cart page where the specific line item violation will be displayed.
+
+**TaxBreakdown**
+Properties:
+- jurisdiction: string - The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
+
+maxLength 200
+- jurisdictionType: JurisdictionType - The type of the jurisdiction in which this tax detail applies.
+- nonTaxableAmount: MultiCurrencyPrice - The amount of this line item price that was considered nontaxable. (Decimal value)
+- rate: string - The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
+
+decimalValue { maxScale:6 }
+- taxableAmount: MultiCurrencyPrice - The taxable amount of this line item.
+- taxAmount: MultiCurrencyPrice - The amount of tax estimated for this line item. (Decimal value)
+- taxName: string - 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.
+
+maxLength 200
+- taxType: string - The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
+
+maxLength 200
+
+**Title**
+Properties:
+- original: string - 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).
+
+minLength 1, maxLength 150
+- translated: string - Subscription option name translated into the buyer's language.
+
+Default: Same as `original`.
+
+minLength 1, maxLength 150
+
+**ValidationInfo**
+Properties:
+- appliedDiscounts: AppliedDiscount[] - Applied discounts.
+
+maxSize 320
+- billingInfo: AddressWithContact - Billing information.
+- buyerDetails: BuyerDetails - Buyer details.
+- conversionCurrency: string - The currency selected by the buyer during the purchase flow, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+
+format CURRENCY
+- currency: string - The site's default currency, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+
+format CURRENCY
+- customFields: CustomFields - Custom fields.
+- externalReference: ExternalReference - References to an external app and resource associated with this checkout.
+Used for integration and tracking across different platforms.
+- giftCard: GiftCard - 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).
+- lineItems: LineItem[] - Line items. Max: 300 line items
+
+maxSize 300
+- paymentCurrency: string - Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+
+format CURRENCY
+- priceSummary: PriceSummary - Price summary.
+- shippingAddress: AddressWithContact - Shipping address and contact details.
+- shippingInfo: ShippingInfo - Shipping information.
+- weightUnit: WeightUnit - Weight measurement unit.
+Default: Site's weight unit
+
+**ValidationsSPIConfig**
+Properties:
+- deploymentUri: string - Required. Base URI where the endpoints are called. Wix appends the endpoint path to the base URI.
+For example, to call the Get Validation Violations endpoint at `https://my-validations.com/v1/get-violations`, the base URI you provide here is `https://my-validations.com`.
+
+minLength 1
+- validateInCart: boolean - Whether to validate the cart page in addition to the checkout page. Default: `false`
+
+**VatId**
+Properties:
+- _id: string - Customer's tax ID.
+- type: VatType - Tax type.
+
+Supported values:
++ `CPF`: for individual tax payers
++ `CNPJ`: for corporations
+
+**VatType**
+Enum values:
+- CNPJ: CNPJ - for corporations
+- CPF: CPF - for individual tax payers.
+- UNSPECIFIED
+
+**Violation**
+Properties:
+- description: string - 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>`.
+
+minLength 1, maxLength 1000
+- severity: Severity - 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.
+- target: Target - Target location on a checkout or cart page where the violation will be displayed.
+
+**WeightUnit**
+Enum values:
+- KG: Kilograms.
+- LB: Pounds.
+- UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
+</types>
+</validations_service_plugin>