@wix/ditto-codegen-public 1.0.6 → 1.0.8

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

@@ -0,0 +1,147 @@
+
+<recommendations_provider_service_plugin>
+<purpose>URI where the application implementing the SPI is deployed.</purpose>
+<use_cases>
+- Handle algorithmIds: List of algorithms used to find recommended items. Items will be returned in a separate object for each algorithm
+- Handle items: The set of items used by algorithms with the `RELATED_ITEMS` `algorithmType` to determine related item recommendations.
+</use_cases>
+<required_handlers>
+- getRecommendations() - Handler to process: The set of items used by algorithms with the `RELATED_ITEMS` `algorithmType` to determine related item recommendations.
+</required_handlers>
+<import>import { recommendationsProvider } from '@wix/ecom/service-plugins'</import>
+<types>
+
+**AlgorithmConfig**
+Properties:
+- additionalInfo: string - A supplemental `description`. It can be used to help break up and organize information. You can, for example, display this information as a tooltip or as an additional section that is collapsed by default.
+
+minLength 1, maxLength 300
+- algorithmId: string - Algorithm ID. This must be unique for a specific app but does not have to be unique across all apps on the site or in the project.
+
+format GUID
+- algorithmType: AlgorithmType - Algorithms may have the following types:
+* `RELATED_ITEMS` - This type of algorithm provides recommendations based on 1 or more other provided items. For example, when an item is added to a cart, the algorithm can suggest other items frequently bought together with that item.
+* `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
+- description: string - Algorithm description. This describes how the algorithm works and if it has any limitations regarding site content, number of items in the catalog, site traffic, and so on. This value is not translatable.
+
+minLength 1, maxLength 500
+- name: string - Algorithm name. This value is not translatable.
+
+minLength 1, maxLength 50
+
+**AlgorithmNotSupportedWixError**
+Properties:
+- data: RecommendationAlgorithmNotSupported
+
+**AlgorithmType**
+Enum values:
+- GLOBAL
+- RELATED_ITEMS
+- UNSPECIFIED
+
+**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)).
+
+**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.
+
+**GetRecommendationsEnvelope**
+Properties:
+- metadata: Context
+- request: GetRecommendationsRequest
+
+**GetRecommendationsRequest**
+Properties:
+- algorithmIds: string[] - List of algorithms used to find recommended items. Items will be returned in a separate object for each algorithm
+
+minSize 1, maxSize 10, format GUID
+- items: CatalogReference[] - The set of items used by algorithms with the `RELATED_ITEMS` `algorithmType` to determine related item recommendations.
+
+maxSize 300
+
+**GetRecommendationsResponse**
+Properties:
+- recommendationPerAlgorithm: RecommendationForAlgorithm[] - Related items returned by each algorithm.
+
+Each object in the array contains an `algorithmId` and a list of the item recommendations provided by that algorithm.
+
+maxSize 10
+
+**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
+
+**ItemAppIdNotSupportedError**
+Properties:
+- items: CatalogReference[] - Items with not supported catalogs.
+
+minSize 1, maxSize 300
+
+**ItemAppIdNotSupportedWixError**
+Properties:
+- data: ItemAppIdNotSupportedError
+
+**RecommendationAlgorithmNotSupported**
+Properties:
+- unsupportedAlgorithms: string[] - Not supported algorithms.
+
+minSize 1, maxSize 10
+
+**RecommendationForAlgorithm**
+Properties:
+- algorithmId: string - Id of the algorithm that provided the recommendation.
+
+format GUID
+- recommendedItems: CatalogReference[] - Item recommendations provided by the algorithm. Depending on the algorithm, these recommendations may be influenced by the items provided in the request.
+
+maxSize 100
+
+**RecommendationsProviderConfig**
+Properties:
+- catalogAppIds: string[] - App IDs of catalogs for which recommended items can be found.
+
+minSize 1, maxSize 100, minLength 1, maxLength 36
+- deploymentUri: string - URI where the application implementing the SPI is deployed.
+- supportedAlgorithms: AlgorithmConfig[] - The algorithms that this application can use to calculate item recommendations.
+
+minSize 1, maxSize 100
+</types>
+</recommendations_provider_service_plugin>

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

@@ -0,0 +1,352 @@
+
+<shipping_rates_service_plugin>
+<purpose>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/`.</purpose>
+<use_cases>
+- Handle buyerContactDetails: Buyer's contact details.
+- Handle deliveryPreferences: List of delivery preferences, for example preferred delivery code (`shippingOptionId`).
+- Handle externalReferences: Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
+Used for integration and tracking across different platforms.
+- Handle lineItems: The line items to be shipped.
+- Handle purchaseFlowId: Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
+- Handle shippingDestination: Address to ship to.
+- Handle shippingOrigin: Address item is shipped from. This is the site owner's business address.
+- Handle taxIncludedInPrices: Whether tax is included in the items' prices.
+- Handle weightUnit: Weight measurement unit used for all items in the shipment.
+
+Supported values:
++ `"KG"`: kilograms
++ `"LB"`: pounds
+</use_cases>
+<required_handlers>
+- getShippingRates() - Handler to process: Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
+Used for integration and tracking across different platforms.
+</required_handlers>
+<import>import { shippingRates } from '@wix/ecom/service-plugins'</import>
+<types>
+
+**AdditionalCharge**
+Properties:
+- details: string - Details of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
+- price: string - Cost of additional charge. For example, `12.5`.
+
+format DECIMAL_VALUE
+- type: string - Additional charge type.
+
+**Address**
+Properties:
+- addressLine1: string - Main address line, usually street and number as free text.
+- addressLine2: string - Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.
+- city: string - City name.
+- country: string - Country code.
+
+format COUNTRY
+- postalCode: string - Zip/postal code.
+- subdivision: string - Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY
+One of (street):
+- addressLine: string - Main address line, usually street and number as free text.
+- streetAddress: StreetAddress - Street name and number.
+
+**ApplicationError**
+Properties:
+- code: string - Error code.
+- data: Record<string, any> - Data related to the error.
+- description: string - Description of the error.
+
+**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)).
+
+**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.
+
+**DeliveryLogistics**
+Properties:
+- deliveryTime: string - When the item is expected to be delivered in free text. For example, `"3-5 business days"`.
+- instructions: string - Instructions for delivery. For example, for pickup: `"Ensure to come during business hours, and please don't park in the disabled spot"`.
+- pickupDetails: PickupDetails - Pickup details. Should be returned only if order is for pickup.
+
+**DeliveryPreferences**
+Properties:
+- preferredCode: string
+
+**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
+
+**FieldViolation**
+Properties:
+- data: Record<string, any>
+- description: string
+- field: string
+- ruleName: string - applicable when violated_rule=OTHER
+- violatedRule: RuleType
+
+**FullAddressContactDetails**
+Properties:
+- company: string - Contact's company name.
+- email: string - Email associated with the address.
+
+format EMAIL
+- firstName: string - Contact's first name.
+- lastName: string - Contact's last name.
+- phone: string - Contact's phone number.
+
+format PHONE
+- vatId: VatId - Tax info. Currently usable only in Brazil.
+
+**GenericShippingRatesError**
+Properties:
+- errors: ApplicationError[]
+
+**GenericShippingRatesWixError**
+Properties:
+- data: GenericShippingRatesError
+
+**GetShippingRatesEnvelope**
+Properties:
+- metadata: Context
+- request: GetShippingRatesRequest
+
+**GetShippingRatesRequest**
+Properties:
+- buyerContactDetails: FullAddressContactDetails - Buyer's contact details.
+- deliveryPreferences: DeliveryPreferences - List of delivery preferences, for example preferred delivery code (`shippingOptionId`).
+- externalReferences: ExternalReference[] - Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
+Used for integration and tracking across different platforms.
+
+maxSize 20
+- lineItems: ProductItem[] - The line items to be shipped.
+
+minSize 1, maxSize 500
+- purchaseFlowId: string - Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
+
+format GUID
+- shippingDestination: Address - Address to ship to.
+- shippingOrigin: Address - Address item is shipped from. This is the site owner's business address.
+- taxIncludedInPrices: boolean (deprecated) - Whether tax is included in the items' prices.
+- weightUnit: WeightUnit - Weight measurement unit used for all items in the shipment.
+
+Supported values:
++ `"KG"`: kilograms
++ `"LB"`: pounds
+
+**GetShippingRatesResponse**
+Properties:
+- shippingRates: ShippingOption[] - Available shipping rates. These define the shipping rate options that are displayed to site visitors on the cart and checkout pages.
+
+**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
+
+**InvalidAddressError**
+Properties:
+- fields: FieldViolation[]
+
+**InvalidAddressWixError**
+Properties:
+- data: InvalidAddressError
+
+**InvalidPostalCodeError**
+Properties:
+- error: ApplicationError
+
+**InvalidPostalCodeWixError**
+Properties:
+- data: InvalidPostalCodeError
+
+**MissingPostalCodeError**
+Properties:
+- error: ApplicationError
+
+**MissingPostalCodeWixError**
+Properties:
+- data: MissingPostalCodeError
+
+**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.
+
+**PickupDetails**
+Properties:
+- address: Address - Pickup address.
+- pickupMethod: PickupMethod - 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**
+Enum values:
+- PICKUP_POINT
+- STORE_PICKUP
+- UNKNOWN_METHOD
+
+**ProductItem**
+Properties:
+- catalogReference: CatalogReference - Reference to the item's origin catalog.
+- deliveryDestinationIndex: number - item delivery destination index in the shipping addresses list
+- deliveryOriginIndex: number - where the item is delivered from index in the from addresses list
+- name: string - Item name.
+- physicalProperties: PhysicalProperties - Physical properties of the item.
+- price: string - Price of a single item after discounts.
+
+format DECIMAL_VALUE
+- priceBeforeDiscount: string - Price of a single item before discounts.
+
+format DECIMAL_VALUE
+- quantity: number - The number of items ordered.
+
+max 999999999
+- taxIncludedInPrice: boolean - whether tax is included in line item price
+- totalPrice: string - Total line item price after discounts. This is equal to `price` multiplied by `quantity`.
+
+format DECIMAL_VALUE
+- totalPriceBeforeDiscount: string - Total line item price before discounts.
+
+format DECIMAL_VALUE
+
+**RuleType**
+Enum values:
+- DECIMAL_GT
+- DECIMAL_GTE
+- DECIMAL_LT
+- DECIMAL_LTE
+- DECIMAL_MAX_SCALE
+- EXACT_LENGTH
+- EXACT_SIZE
+- FIELD_NOT_ALLOWED
+- FORMAT
+- INVALID_ENUM_VALUE
+- MAX
+- MAX_LENGTH
+- MAX_SIZE
+- MIN
+- MIN_LENGTH
+- MIN_SIZE
+- ONE_OF_ALIGNMENT
+- OTHER
+- REQUIRED_FIELD
+- REQUIRED_ONE_OF_FIELD
+- VALIDATION
+
+**ShippingOption**
+Properties:
+- code: string - Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
+- cost: ShippingPrice - Shipping cost.
+- logistics: DeliveryLogistics - Shipping logistics.
+- title: string - Shipping rate title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"`, or `"First-Class Package International"`.
+
+**ShippingPrice**
+Properties:
+- additionalCharges: AdditionalCharge[] - Additional costs. For example, a handling fee for packaging fragile items.
+- currency: 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.
+
+format CURRENCY
+- price: string - The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).
+
+format DECIMAL_VALUE
+
+**ShippingRatesConfig**
+Properties:
+- dashboardUrl: string - URL to reach the shipping provider app's dashboard.
+
+minLength 1, maxLength 2048, format WEB_URL
+- deploymentUri: string - 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/`.
+
+minLength 1
+- description: string - Description of the shipping provider.
+
+maxLength 200
+- fallbackDefinitionMandatory: boolean - 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.
+- learnMoreUrl: string - URL to more info about the shipping provider.
+
+maxLength 200
+- name: string - Human-readable name of the shipping provider.
+
+minLength 1, maxLength 64
+- thumbnailUrl: string - 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).
+
+format WEB_URL
+
+**StreetAddress**
+Properties:
+- name: string - Street name.
+- number: string - Street number.
+
+**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
+
+**WeightUnit**
+Enum values:
+- KG: Kilograms.
+- LB: Pounds.
+- UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
+</types>
+</shipping_rates_service_plugin>