@wix/ditto-codegen-public 1.0.211 → 1.0.213

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

@@ -1,169 +0,0 @@
-
-<gift_vouchers_provider_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 Balance endpoint at `https://my-gift-cards.com/v1/balance`, the base URI you provide here is `https://my-gift-cards.com/`.</purpose>
-<use_cases>
-- Handle appInstanceId: App ID of the Gift Card provider. Deprecated.
-- Handle locationId: Physical location ID. Can be based on the Locations API or an external provider.
-- Handle transactionId: Transaction ID to void.
-- Handle code: Gift card code.
-- Handle locationId: The physical location ID. Can be based on the Locations API or an external provider.
-- Handle pin: Gift card PIN.
-- Handle amount: Amount to redeem from the gift card.
-- Handle currencyCode: Currency code.
-- Handle orderId: Order ID the gift card transaction is applied to. Order details can be collected from eCommerce Search Orders.
-</use_cases>
-<required_handlers>
-- _void() - Handler for ecom_gift-vouchers-provider - _void
-- void() - Handler to process: Physical location ID. Can be based on the Locations API or an external provider.
-- getBalance() - Handler to process: The physical location ID. Can be based on the Locations API or an external provider.
-- redeem() - Handler to process: Order ID the gift card transaction is applied to. Order details can be collected from eCommerce Search Orders.
-</required_handlers>
-<import>import { giftVouchersProvider } from '@wix/ecom/service-plugins'</import>
-<types>
-
-**_voidEnvelope**
-Properties:
-- metadata: Context
-- request: VoidRequest
-
-**AlreadyRedeemedWixError**
-
-**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.
-
-**CurrencyNotSupportedWixError**
-
-**GetBalanceEnvelope**
-Properties:
-- metadata: Context
-- request: GetBalanceRequest
-
-**GetBalanceRequest**
-Properties:
-- appInstanceId: string (deprecated) - App ID of the Gift Card provider. Deprecated.
-
-format GUID
-- code: string - Gift card code.
-
-minLength 8, maxLength 20
-- locationId: string - The physical location ID. Can be based on the Locations API or an external provider.
-
-maxLength 50
-- pin: string - Gift card PIN.
-
-maxLength 50
-
-**GetBalanceResponse**
-Properties:
-- balance: number - Current balance.
-
-max 999999999.99
-- currencyCode: string - Currency code.
-
-format CURRENCY
-- externalId: string - External ID in the gift card provider's system.
-Used for integration and tracking across different platforms.
-
-minLength 1, maxLength 50
-
-**GiftCardDisabledWixError**
-
-**GiftCardExpiredWixError**
-
-**GiftCardNotFoundWixError**
-
-**GiftCardProviderConfig**
-Properties:
-- 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 Balance endpoint at `https://my-gift-cards.com/v1/balance`, the base URI you provide here is `https://my-gift-cards.com/`.
-
-**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
-
-**InsufficientFundsWixError**
-
-**RedeemEnvelope**
-Properties:
-- metadata: Context
-- request: RedeemRequest
-
-**RedeemRequest**
-Properties:
-- amount: number - Amount to redeem from the gift card.
-
-max 999999999.99
-- appInstanceId: string (deprecated) - App ID of the Gift Card provider. Deprecated.
-
-format GUID
-- code: string - Gift card code.
-
-minLength 8, maxLength 20
-- currencyCode: string - Currency code.
-
-format CURRENCY
-- locationId: string - Physical location ID. Can be based on the Locations API or an external provider.
-
-maxLength 50
-- orderId: string - Order ID the gift card transaction is applied to. Order details can be collected from eCommerce Search Orders.
-
-format GUID
-- pin: string - Gift card PIN.
-
-maxLength 50
-
-**RedeemResponse**
-Properties:
-- currencyCode: string - Currency code.
-
-format CURRENCY
-- remainingBalance: number - Remaining balance on the Gift Card after the redemption.
-
-max 999999999.99
-- transactionId: string - Transaction ID.
-
-minLength 1, maxLength 100
-
-**VoidRequest**
-Properties:
-- appInstanceId: string (deprecated) - App ID of the Gift Card provider. Deprecated.
-
-format GUID
-- locationId: string - Physical location ID. Can be based on the Locations API or an external provider.
-
-maxLength 50
-- transactionId: string - Transaction ID to void.
-
-minLength 1, maxLength 100
-
-**VoidResponse**
-Properties:
-- currencyCode: string - Currency code.
-
-format CURRENCY
-- remainingBalance: number - Remaining balance on the Gift Card after voiding the transaction.
-
-max 999999999.99
-</types>
-</gift_vouchers_provider_service_plugin>