@wix/ditto-codegen-public 1.0.211 → 1.0.213

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

@@ -1,460 +0,0 @@
-
-<catalog_service_plugin>
-<purpose>Base URI which Wix eCommerce will call to access Catalog service plugin endpoints. For example, to call the Get Catalog Items endpoint at `https://my-external-catalog.com/get-catalog-items`, the base URI you provide here is `https://my-external-catalog.com`.</purpose>
-<use_cases>
-- Handle catalogReferences: Catalog reference details for the items to retrieve, including quantity of each item.
-- Handle currency: Currency to return item prices in, in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. For example, `USD` or `EUR`.
-
-By default, Wix sends the currency specified in the site's settings.
-- Handle weightUnit: Weight measurement unit.
-
-By default, Wix sends the weight unit specified in the site's settings.
-</use_cases>
-<required_handlers>
-- getCatalogItems() - Handler to process: Currency to return item prices in, in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. For example, `USD` or `EUR`.
-
-By default, Wix sends the currency specified in the site's settings.
-</required_handlers>
-<import>import { catalog } from '@wix/ecom/service-plugins'</import>
-<types>
-
-**AdditionalFee**
-Properties:
-- code: string - Additional fee's unique code or ID.
-
-minLength 1, maxLength 100
-- name: string - Additional fee's name.
-
-Max: 50 characters
-
-minLength 1, maxLength 50
-- price: string - Total additional fees. This `price` does not include any taxes that may apply to these additional fees.
-
-decimalValue { gte:0, lte:1000000000000000, maxScale:2 }
-- taxDetails: TaxDetails - Tax details.
-
-> **Note:** Tax is not calculated in the returned `price` even when `taxDetails.taxable` is `true`.
-
-**AllItemsDiscountConfig**
-Properties:
-- enabled: boolean - Whether the discount is enabled.
-
-Default: `false`.
-- name: string - Translatable name for "all items discount" in the catalog.
-For example, for restaurant menus, this could be "All dishes".
-
-minLength 1, maxLength 100
-
-**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)).
-
-**CatalogReferenceAndQuantity**
-Properties:
-- catalogReference: CatalogReference - Catalog and item reference info. Holds IDs for the item and the catalog it belongs to, as well as further optional details. This is identical in the request and response.
-- quantity: number - Item quantity.
-
-**CatalogSPIConfig**
-Properties:
-- allItemsDiscount: AllItemsDiscountConfig - Configuration details for discounts applied to all items in the catalog.
-- deploymentUri: string - Base URI which Wix eCommerce will call to access Catalog service plugin endpoints. For example, to call the Get Catalog Items endpoint at `https://my-external-catalog.com/get-catalog-items`, the base URI you provide here is `https://my-external-catalog.com`.
-- specificItemsDiscount: SpecificItemsDiscountConfig - Configuration details for discounts applied to specific items in the catalog.
-
-**Color**
-Properties:
-- code: string - HEX or RGB color code for display.
-- original: string - 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).
-
-maxLength 500
-- translated: string - Description line color name translated into the buyer's language.
-
-Default: Same as `original`.
-
-maxLength 500
-
-**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.
-
-**Description**
-Properties:
-- original: string - Subscription option description.
-
-maxLength 500
-- translated: string - Translated subscription option description.
-
-maxLength 500
-
-**DescriptionLine**
-Properties:
-- name: DescriptionLineName - Description line name.
-One of (value):
-- colorInfo: Color - Description line color value.
-- plainText: PlainTextValue - Description line plain text value.
-
-**DescriptionLineName**
-Properties:
-- original: string - 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).
-
-maxLength 100
-- translated: string - Description line name translated into the buyer's language.
-
-Default: Same as `original`.
-
-maxLength 200
-
-**FreeTrialPeriod**
-Properties:
-- frequency: SubscriptionFrequency - Frequency of period. Values: DAY, WEEK, MONTH, YEAR
-- interval: number - interval of period
-
-min 1, max 999
-
-**GetCatalogItemsEnvelope**
-Properties:
-- metadata: Context
-- request: GetCatalogItemsRequest
-
-**GetCatalogItemsRequest**
-Properties:
-- catalogReferences: CatalogReferenceAndQuantity[] - Catalog reference details for the items to retrieve, including quantity of each item.
-
-minSize 1, maxSize 300
-- currency: string - Currency to return item prices in, in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. For example, `USD` or `EUR`.
-
-By default, Wix sends the currency specified in the site's settings.
-
-format CURRENCY
-- weightUnit: WeightUnit - Weight measurement unit.
-
-By default, Wix sends the weight unit specified in the site's settings.
-
-**GetCatalogItemsResponse**
-Properties:
-- catalogItems: Item[] - Details for each item, including catalog reference details and item data. Any items that don't exist in the catalog are excluded.
-If none of the requested items exist in the catalog, this array must be empty.
-
-**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
-
-**Item**
-Properties:
-- catalogReference: CatalogReference - Catalog and item reference info. Holds IDs for the item and the catalog it belongs to, as well as further optional details. This is identical in the request and response.
-- data: ItemData - Item data. Contains full details about the item.
-
-**ItemData**
-Properties:
-- additionalFees: AdditionalFee[] - Additional Fees to be added to this item calculation.
-
-maxSize 5
-- consentRequiredPaymentPolicy: string - Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
-
-minLength 1, maxLength 2500
-- depositAmount: string - Partial payment to be paid upfront during the checkout. Return when `paymentOption` is `DEPOSIT_ONLINE`.
-
-Default: If `paymentOption` is `DEPOSIT_ONLINE` but `depositAmount` is not provided, the item is treated as if `paymentOption` is `FULL_PAYMENT_ONLINE`.
-
-format DECIMAL_VALUE
-- descriptionLines: DescriptionLine[] - Line item description lines. Used for displaying the item in a cart, checkout or order. For example, if you want `Size: Large` to appear under the item name, create a description line with `"name": {"original": "Size"}` and  `"plainText": {"original": "Large"}`.
-
-Default: No description line.
-
-maxSize 20
-- fixedQuantity: boolean - Whether the line item quantity is fixed and cannot be changed.
-
-Default: `false`
-- fullPrice: string - Item price **before** applying any catalog-defined discount.
-
-Default: Value of `price` field, if no catalog-defined discount applies.
-
-format DECIMAL_VALUE
-- itemType: ItemType - __Required.__ Item type. Either one of the preset types or a custom type.
-- media: string - Line item image details. Supports images from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-accessing-the-media-manager) only.
-
-To use an image from another source, first upload it to the Media Manager.
-You can retrieve the ID, width and height of an image from the Wix Media Manager.
-- membersOnly: boolean - Whether the item can only be purchased by site members.
-
-Default: `false`
-- modifierGroups: ModifierGroup[] - Modifier groups that were added to the item.
-
-maxSize 25
-- paymentOption: PaymentOptionType - Type of selected payment option for current item.
-
-Default: `FULL_PAYMENT_ONLINE`
-- physicalProperties: PhysicalProperties - Physical properties of the item. Only return for physical items. When applicable, contains information such as SKU and item weight.
-- policies: Policy[] - Policies to be displayed to the customer on the checkout page.
-
-maxSize 5
-- price: string - __Required.__ Item price with discounts applied. If a catalog-defined discount applies, the discount is reflected in this price.
-
-decimalValue { gte:0, lte:1000000000000000 }
-- priceDescription: PriceDescription - Additional description for the price. Return when additional information about the price is needed.
-
-For example, when `price` is `"0"` but additional details about the actual price are needed, such as `"Starts at $67"`.
-- priceUndetermined: boolean - Whether the price is not yet defined, and will be updated after the order is created.
-
-Default: `false`
-- productName: ProductName - __Required.__ Item name.
-- quantityAvailable: number - Quantity of the item available for purchase. Only return if the catalog manages inventory.
-If not returned, a buyer can increase the quantity of this item to add to the cart or checkout without limit.
-
-max 100000000
-- rootCatalogItemId: string - Additional ID for the item in the catalog.
-This field provides an additional identifier for the item if your flow requires another ID as well as `catalogReference.catalogItemId`.
-Can be used for membership validation.
-
-Default: Same as `catalogReference.catalogItemId`.
-
-minLength 1, maxLength 36
-- savePaymentMethod: boolean - Whether to save the payment method on the order.
-
-Default: `false`
-- serviceProperties: ServiceProperties - Service properties. When applicable, this contains information such as time and number of participants.
-- subscriptionOptionInfo: SubscriptionOptionInfo - Subscription option info.
-- taxableAddress: TaxableAddress - Address to use for tax calculation purposes.
-- taxGroupId: string - The tax group ID associated with this item. Learn more about the [Tax Groups Service Plugin](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/tax-groups-integration-service-plugin/introduction).
-
-format GUID
-- url: string - URL for the item's page on the site.
-
-This is used to link back to the relevant item page from the cart page. If not provided, the site URL is used.
-
-**ItemModifier**
-Properties:
-- _id: string - Modifier ID.
-
-minLength 1, maxLength 36
-- details: TranslatableString - Additional details.
-- label: TranslatableString - Primary display label for the modifier.
-- price: string - The price of the modifier.
-
-decimalValue { gte:0, lte:1000000000000000, maxScale:3 }
-- quantity: number - The quantity of this modifier.
-
-min 1, max 100000
-
-**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
-
-**ModifierGroup**
-Properties:
-- _id: string - Modifier group ID.
-
-minLength 1, maxLength 36
-- modifiers: ItemModifier[] - List of modifiers in this group.
-
-minSize 1, maxSize 25
-- name: TranslatableString - Modifier group name.
-
-**PaymentOptionType**
-Enum values:
-- DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
-- FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
-- FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout.
-- MEMBERSHIP: Payment for this item is done by charging a membership. Any remaining amount not covered by the membership, such as item modifiers, is paid online.
-- MEMBERSHIP_OFFLINE: 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_ONLINE_WITH_OFFLINE_REMAINDER: Item price is charged to online membership. Any remaining amount not covered by the membership, such as item modifiers, is paid offline.
-
-**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.
-
-**PlainTextValue**
-Properties:
-- original: string - 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).
-
-maxLength 600
-- translated: string - Description line plain text value translated into the buyer's language.
-
-Default: Same as `original`.
-
-maxLength 600
-
-**Policy**
-Properties:
-- content: string - Policy content - should be translated
-
-minLength 1, maxLength 3000
-- title: string - Policy title - should be translated
-
-minLength 1, maxLength 29
-
-**PriceDescription**
-Properties:
-- original: string - __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).
-
-minLength 1, maxLength 100
-- translated: string - Price description translated into the buyer's language.
-
-Default: Same as `original`.
-
-minLength 1, maxLength 100
-
-**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
-
-**ServiceProperties**
-Properties:
-- numberOfParticipants: number - The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
-
-min 1, max 10000
-- scheduledDate: unknown - Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
-For example, the start time of a class.
-
-**SpecificItemsDiscountConfig**
-Properties:
-- enabled: boolean - Whether the discount is enabled.
-
-Default: `false`.
-- name: string - Translatable name for "all items discount" in the catalog.
-
-minLength 1, maxLength 100
-
-**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
-
-**TaxableAddress**
-One of (taxableAddressData):
-- addressType: TaxableAddressType - taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
-
-**TaxableAddressType**
-Enum values:
-- BILLING
-- BUSINESS
-- SHIPPING
-- UNKNOWN_TAXABLE_ADDRESS
-
-**TaxDetails**
-Properties:
-- taxable: boolean - Whether additional fee is taxable.
-- taxGroupId: string - Reserved for internal use.
-
-format GUID
-
-**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
-
-**TranslatableString**
-Properties:
-- original: string - __Required.__ String 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 - String translated into the buyer's language.
-
-Min: 1 character.
-Max: 400 characters.
-Default: Same as `original`.
-
-minLength 1, maxLength 400
-
-**WeightUnit**
-Enum values:
-- KG: Kilograms.
-- LB: Pounds.
-- UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
-</types>
-</catalog_service_plugin>

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

@@ -1,149 +0,0 @@
-
-<custom_triggers_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 Eligible Triggers endpoint at `https://my-discount-app.com/v1/getEligibleTriggers`, the base URI you provide here is `https://my-discount-app.com/`.</purpose>
-<use_cases>
-- Handle lineItems: List of line items in the cart/checkout.
-- Handle purchaseFlowId: Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
-- Handle triggers: List of triggers to be checked for discount eligibility.
-</use_cases>
-<required_handlers>
-- getEligibleTriggers() - Handler to process: Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
-- listTriggers() - Handler for ecom_custom-triggers - list triggers
-</required_handlers>
-<import>import { customTriggers } from '@wix/ecom/service-plugins'</import>
-<types>
-
-**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.
-
-**CustomTrigger**
-Properties:
-- _id: string - Custom trigger ID.
-
-minLength 1, maxLength 100
-
-**CustomTriggerConfig**
-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 Eligible Triggers endpoint at `https://my-discount-app.com/v1/getEligibleTriggers`, the base URI you provide here is `https://my-discount-app.com/`.
-
-**EligibleTrigger**
-Properties:
-- customTriggerId: string - Custom trigger ID. Must be passed with relevant `identifier`.
-
-minLength 1, maxLength 100
-- identifier: string - Unique trigger identifier. The value must be the same as its equivalent in `triggers[i].identifier` in the request payload.
-
-minLength 1, maxLength 100
-
-**GetEligibleTriggersEnvelope**
-Properties:
-- metadata: Context
-- request: GetEligibleTriggersRequest
-
-**GetEligibleTriggersRequest**
-Properties:
-- lineItems: LineItem[] - List of line items in the cart/checkout.
-
-maxSize 1000
-- purchaseFlowId: string - Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
-
-format GUID
-- triggers: TriggerToFilterBy[] - List of triggers to be checked for discount eligibility.
-
-minSize 1, maxSize 100
-
-**GetEligibleTriggersResponse**
-Properties:
-- eligibleTriggers: EligibleTrigger[] - List of eligible triggers. These are used by the Discount Rules API and Wix eCommerce to apply the relevant discount.
-
-maxSize 100
-
-**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
-
-**LineItem**
-Properties:
-- _id: string - Line item ID.
-
-minLength 1, maxLength 100
-- catalogReference: CatalogReference - Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info.
-This field may be empty in the case of a custom line item.
-- price: string - Price of a single item.
-
-decimalValue { gte:0 }
-- quantity: number - Item quantity in this line item.
-
-max 100000
-
-**ListTriggersEnvelope**
-Properties:
-- metadata: Context
-- request: ListTriggersRequest
-
-**ListTriggersRequest**
-
-**ListTriggersResponse**
-Properties:
-- customTriggers: ListTriggersResponseCustomTrigger[] - Custom triggers.
-
-**ListTriggersResponseCustomTrigger**
-Properties:
-- _id: string - Custom trigger ID.
-
-minLength 1, maxLength 100
-- name: string - Custom trigger name to display in the dashboard.
-
-minLength 1, maxLength 200
-
-**TriggerToFilterBy**
-Properties:
-- customTrigger: CustomTrigger - Custom trigger info.
-- identifier: string - Unique trigger identifier. The same value must be returned in `eligibleTriggers[i].identifier`.
-
-minLength 1, maxLength 100
-</types>
-</custom_triggers_service_plugin>