import { CreateAutomationRequest as CreateAutomationRequest$1, CreateAutomationResponse as CreateAutomationResponse$1, GetAutomationRequest as GetAutomationRequest$1, GetAutomationResponse as GetAutomationResponse$1, UpdateAutomationRequest as UpdateAutomationRequest$1, UpdateAutomationResponse as UpdateAutomationResponse$1, MigrationUpdateAutomationRequest as MigrationUpdateAutomationRequest$1, MigrationUpdateAutomationResponse as MigrationUpdateAutomationResponse$1, DeleteAutomationRequest as DeleteAutomationRequest$1, DeleteAutomationResponse as DeleteAutomationResponse$1, QueryAutomationsRequest as QueryAutomationsRequest$1, QueryAutomationsResponse as QueryAutomationsResponse$1, OverrideApplicationAutomationRequest as OverrideApplicationAutomationRequest$1, OverrideApplicationAutomationResponse as OverrideApplicationAutomationResponse$1, ValidateAutomationByIdRequest as ValidateAutomationByIdRequest$1, ValidateAutomationByIdResponse as ValidateAutomationByIdResponse$1, ValidateAutomationRequest as ValidateAutomationRequest$1, ValidateAutomationResponse as ValidateAutomationResponse$1, GetAutomationActivationReportsRequest as GetAutomationActivationReportsRequest$1, GetAutomationActivationReportsResponse as GetAutomationActivationReportsResponse$1, GetActionsQuotaInfoRequest as GetActionsQuotaInfoRequest$1, GetActionsQuotaInfoResponse as GetActionsQuotaInfoResponse$1, GenerateActionInputMappingFromTemplateRequest as GenerateActionInputMappingFromTemplateRequest$1, GenerateActionInputMappingFromTemplateResponse as GenerateActionInputMappingFromTemplateResponse$1 } from './index.typings.mjs'; import '@wix/sdk-types'; /** Automation */ interface Automation { /** * Automation ID * @format GUID * @readonly */ id?: string | null; /** Revision */ revision?: string | null; /** * Automation name * @maxLength 500 */ name?: string; /** * Automation description * @maxLength 2000 */ description?: string; /** * Automation Type * @readonly */ type?: TypeWithLiterals; /** Automation Status */ status?: StatusWithLiterals; /** Rule that contains a trigger & some actions */ rule?: Rule; /** * Source Application Automation * @readonly */ source?: Source; /** * Metadata * @readonly */ metadata?: AutomationMetadata; /** * Created date * @readonly */ createdDate?: Date | null; /** * Updated date * @readonly */ updatedDate?: Date | null; /** * ESB Configuration ID * @format GUID * @readonly */ esbConfigurationId?: string | null; /** * Was this automation migrated from v1 * @readonly */ migratedFromV1?: boolean | null; /** @readonly */ migratedToV3?: boolean | null; /** @internal */ extendedFields?: ExtendedFields; } declare enum Type { CUSTOM = "CUSTOM", APPLICATION = "APPLICATION" } /** @enumType */ type TypeWithLiterals = Type | 'CUSTOM' | 'APPLICATION'; declare enum Status { ACTIVE = "ACTIVE", INACTIVE = "INACTIVE" } /** @enumType */ type StatusWithLiterals = Status | 'ACTIVE' | 'INACTIVE'; interface Rule { /** an event triggered by visitors on a site, or by a site manager (owner & team). */ trigger?: Trigger; /** * the actions responding to the trigger happening. * ** IMPORTANT NOTE: the order of the actions is important, and will be executed in the order they appear in the list ** * @minSize 1 * @maxSize 30 */ actions?: Action[]; } interface Trigger { /** * the id of the app defining the trigger * @format GUID */ appId?: string; /** * Identifier for this trigger - human readable action key * @minLength 1 * @maxLength 100 */ triggerKey?: string; /** * optional list of filters on schema fields * @maxSize 5 */ filters?: Filter[]; /** * optional - allows to define a trigger whose following actions will be executed only if the same event for the same resource has not in the last X seconds. * for example, if the trigger is "session booked", the resource is a contact and the timeframe is 3600 seconds (contact hasn't booked another session in the last hour), * then the actions will be executed only if the same event (session booked for that contact) has not happened in the last hour. */ debounce?: Debounce; } interface Filter { /** * the filter identifier * @format GUID */ id?: string | null; /** * the field key from the schema, for example "formId" * @minLength 1 * @maxLength 110 */ fieldKey?: string; /** * filter expression that evaluates to a boolean, for example - {{ contains(["guid1","guid2"];formId) }} * @minLength 5 */ filterExpression?: string; } interface Debounce { /** * Amount of time in seconds to wait for any additional events to occur before triggering the actions. * If no additional events occur within the specified time, the actions will be triggered. * If additional events occur within the specified time, the timer will be reset. * @min 1 */ timeFrameInSeconds?: number; /** * The field key in the trigger's payload of the entity/event to debounce on * For example: if the trigger is "user logged in", the resource is a contact and the resource key is "contactId", * Another example: if the trigger is "visitor logged in", the resource is a visitor and the resource key is "visitorId". * @minLength 1 * @maxLength 110 */ fieldKey?: string; } interface Action { /** * the id of the action for delayed events * @format GUID * @readonly */ id?: string | null; /** * the id of the app defining the action * @format GUID */ appId?: string; /** * Identifier for this action - human readable action key - unique per app def id * @maxLength 80 */ actionKey?: string; /** * input mapping expression for the action inputs * for example: * `{ "subject": "Thanks for reaching out!" * "message": "Hi {{contact.name.first}}, thanks for contacting our business" * }` * where the value for "contact.name.first" comes from the trigger's payload * @maxLength 20000 */ actionConfig?: string; /** * output mapping expression for the action output * for example in get-contact action: * `{ "author": "{{$}}" }` * This will map the entire entity of contact under `author` namespace * @maxLength 3000 */ outputActionConfig?: string | null; /** Optional delay configuration for the action */ delay?: Delay; /** allows you define an activation policy - like number of activations in a time frame, or limit by some identifier, like contact (e.g. send email to user only at first login) */ rateLimit?: RateLimit; /** * allows the user to define a condition for the action to be executed, if the condition fails the action (and following actions) will not be executed * @deprecated allows the user to define a condition for the action to be executed, if the condition fails the action (and following actions) will not be executed * @replacedBy conditions * @targetRemovalDate 2023-08-01 */ condition?: Condition; conditions?: Conditions; /** * allows the user to define a namespace for the action output * @minLength 1 * @maxLength 100 */ namespace?: string | null; } declare enum BlockType { UNKNOWN = "UNKNOWN", OR = "OR", AND = "AND" } /** @enumType */ type BlockTypeWithLiterals = BlockType | 'UNKNOWN' | 'OR' | 'AND'; interface ConditionBlock { type?: BlockTypeWithLiterals; /** * @minSize 1 * @maxSize 20 */ lineExpressions?: string[]; } interface Offset extends OffsetValueOneOf { /** A delay in seconds */ seconds?: number; /** The key of the field in the trigger payload which contains a delay, in seconds. */ delayFieldKey?: string; } /** @oneof */ interface OffsetValueOneOf { /** A delay in seconds */ seconds?: number; /** The key of the field in the trigger payload which contains a delay, in seconds. */ delayFieldKey?: string; } /** calculated as date + delay */ interface Until { /** The key of the field in the trigger payload which contains the date to delay until */ dateFieldKey?: string; /** Optional: a delay to add together with the date described in the payload */ offset?: Offset; } interface Delay extends DelayTypeOneOf { /** A delay which is calculated based on the immediate time when the action is triggered. */ for?: Offset; /** A delay which is calculated based on a date field in the trigger payload. May also be used together with an Offset delay. */ until?: Until; } /** @oneof */ interface DelayTypeOneOf { /** A delay which is calculated based on the immediate time when the action is triggered. */ for?: Offset; /** A delay which is calculated based on a date field in the trigger payload. May also be used together with an Offset delay. */ until?: Until; } interface RateLimit { /** * time frame in minutes * @min 1 */ timeFrame?: number | null; /** * number of activations allowed in the given time frame * @min 1 */ activations?: number; /** * limit the activation by an entity, for example activate once per contact. example: {{contact.id}} * @minLength 1 * @maxLength 300 */ uniqueIdentifierExpression?: string | null; } interface Condition { /** * entity object is deprecated due to the new approach to conditions * the condition expression, for example - {{and(gt(price;10);lt(price;100))}} * @minLength 1 * @maxLength 2000 */ conditionExpression?: string; } interface Conditions { /** * condition evaluates to `true` if either of the blocks evaluate to `true` (aka OR between all) * @minSize 1 * @maxSize 10 */ conditionBlocks?: ConditionBlock[]; } interface Source { /** Automation ID */ automationId?: string | null; /** Application ID */ appId?: string | null; /** Component ID */ componentId?: string | null; /** Version */ version?: number | null; } interface AutomationMetadata { /** Is this Automation hidden on a site? */ hidden?: boolean; /** Can this Automation be dismissed (inactivated) on a site? */ alwaysActive?: boolean; /** Is this Automation's scheduling modification is disabled on a site? */ schedulingModificationDisabled?: boolean; /** Is the removal of this Automation's actions disabled? */ actionRemovalDisabled?: boolean; /** Is conditions editing for this Automation allowed on a site? */ actionConditionsEditingDisabled?: boolean; /** * Domain * @internal * @immutable */ domain?: DomainWithLiterals; } declare enum Domain { /** User domain (default) */ USER = "USER", /** Wix domain */ WIX = "WIX" } /** @enumType */ type DomainWithLiterals = Domain | 'USER' | 'WIX'; interface ExtendedFields { /** * Extended field data. Each key corresponds to the namespace of the app that created the extended fields. * The value of each key is structured according to the schema defined when the extended fields were configured. * * You can only access fields for which you have the appropriate permissions. * * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). */ namespaces?: Record>; } interface GetApplicationAutomationRequest { /** * Application Automation ID * @format GUID */ automationId?: string; } interface GetApplicationAutomationResponse { /** Automation */ automation?: Automation; } interface QueryApplicationAutomationsRequest { /** Query */ query?: QueryV2; } interface QueryV2 extends QueryV2PagingMethodOneOf { /** Paging options to limit and offset the number of items. */ paging?: Paging; /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging; /** * Filter object. * * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters). */ filter?: Record | null; /** * Sort object. * * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting). */ sort?: Sorting[]; /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */ fields?: string[]; /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */ fieldsets?: string[]; } /** @oneof */ interface QueryV2PagingMethodOneOf { /** Paging options to limit and offset the number of items. */ paging?: Paging; /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging; } interface Sorting { /** * Name of the field to sort by. * @maxLength 512 */ fieldName?: string; /** Sort order. */ order?: SortOrderWithLiterals; /** * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked. * * If multiple filters are provided, they are combined with AND operator. * * Example: * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]} * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] } * @internal * @maxSize 10 */ selectItemsBy?: Record[] | null; /** * Origin point for geo-distance sorting on a GEO field * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first). */ origin?: AddressLocation; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } /** @enumType */ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC'; interface AddressLocation { /** Address latitude. */ latitude?: number | null; /** Address longitude. */ longitude?: number | null; } interface Paging { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface CursorPaging { /** * Maximum number of items to return in the results. * @max 100 */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. * @maxLength 16000 */ cursor?: string | null; } interface QueryApplicationAutomationsResponse { /** List of automations */ automations?: Automation[]; /** Paging metadata */ paging?: PagingMetadataV2; } interface PagingMetadataV2 { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ offset?: number | null; /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */ cursors?: Cursors; /** * Indicates if there are more results after the current page. * If `true`, another page of results can be retrieved. * If `false`, this is the last page. * @internal */ hasNext?: boolean | null; } interface Cursors { /** * Cursor string pointing to the next page in the list of results. * @maxLength 16000 */ next?: string | null; /** * Cursor pointing to the previous page in the list of results. * @maxLength 16000 */ prev?: string | null; } interface UpdateApplicationAutomationConfigurationIdRequest { /** * Application Automation ID * @format GUID */ automationId?: string; /** * Configuration ID * @format GUID */ esbConfigurationId?: string; } interface UpdateApplicationAutomationConfigurationIdResponse { } interface UpdateApplicationAutomationToMigratedFromV1Request { /** * Application Automation ID * @format GUID */ automationId?: string; /** * Revision * @readonly */ revision?: string | null; /** value to be set */ value?: boolean | null; } interface UpdateApplicationAutomationToMigratedFromV1Response { } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } interface EntityCreatedEvent { entityAsJson?: string; /** * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity * @internal */ triggeredByUndelete?: boolean | null; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; /** * Optional domain-specific metadata defined by the API owner, encoded as JSON. * @internal */ additionalMetadataAsJson?: string | null; } interface RestoreInfo { deletedDate?: Date | null; } interface EntityUpdatedEvent { /** * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff. * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntityAsJson?: string; /** * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard * wont populate it / have any reference to it in the API. * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed, * the developer should send only the new (current) entity. * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message. * @internal * @deprecated */ previousEntityAsJson?: string | null; /** * Map of fully qualified field paths to their previous values for fields that changed. * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format) * @internal */ modifiedFields?: Record; /** * Optional domain-specific metadata defined by the API owner, encoded as JSON. * @internal */ additionalMetadataAsJson?: string | null; } interface EntityDeletedEvent { /** * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled * @internal */ movedToTrash?: boolean | null; /** Entity that was deleted. */ deletedEntityAsJson?: string | null; /** * Optional domain-specific metadata defined by the API owner, encoded as JSON. * @internal */ additionalMetadataAsJson?: string | null; } interface ActionEvent { bodyAsJson?: string; } interface Empty { } interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; /** * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch * the actual URL. * * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459 */ urlChanged?: SiteUrlChanged; /** Site is marked as PurgedExternally */ sitePurgedExternally?: SitePurgedExternally; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; /** * A meta site id. * @format GUID */ metaSiteId?: string; /** A meta site version. Monotonically increasing. */ version?: string; /** A timestamp of the event. */ timestamp?: string; /** * TODO(meta-site): Change validation once validations are disabled for consumers * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659 * @maxSize 4000 */ assets?: Asset[]; } /** @oneof */ interface MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; /** * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch * the actual URL. * * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459 */ urlChanged?: SiteUrlChanged; /** Site is marked as PurgedExternally */ sitePurgedExternally?: SitePurgedExternally; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; } interface Asset { /** * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). * @maxLength 36 */ appDefId?: string; /** * An instance id. For legacy reasons may be UUID or a string. * @maxLength 200 */ instanceId?: string; /** An application state. */ state?: StateWithLiterals; } declare enum State { UNKNOWN = "UNKNOWN", ENABLED = "ENABLED", DISABLED = "DISABLED", PENDING = "PENDING", DEMO = "DEMO" } /** @enumType */ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO'; interface SiteCreated { /** * A template identifier (empty if not created from a template). * @maxLength 36 */ originTemplateId?: string; /** * An account id of the owner. * @format GUID */ ownerId?: string; /** A context in which meta site was created. */ context?: SiteCreatedContextWithLiterals; /** * A meta site id from which this site was created. * * In case of a creation from a template it's a template id. * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site. * @format GUID */ originMetaSiteId?: string | null; /** * A meta site name (URL slug). * @maxLength 20 */ siteName?: string; /** A namespace. */ namespace?: NamespaceWithLiterals; } declare enum SiteCreatedContext { /** A valid option, we don't expose all reasons why site might be created. */ OTHER = "OTHER", /** A meta site was created from template. */ FROM_TEMPLATE = "FROM_TEMPLATE", /** A meta site was created by copying of the transfferred meta site. */ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER", /** A copy of existing meta site. */ DUPLICATE = "DUPLICATE", /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER", /** deprecated A meta site was created for Flash editor. */ FLASH = "FLASH" } /** @enumType */ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH'; declare enum Namespace { UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE", /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */ WIX = "WIX", /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */ SHOUT_OUT = "SHOUT_OUT", /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */ ALBUMS = "ALBUMS", /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE", /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ HOTELS = "HOTELS", /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */ CLUBS = "CLUBS", /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */ ONBOARDING_DRAFT = "ONBOARDING_DRAFT", /** * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG). */ DEV_SITE = "DEV_SITE", /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */ LOGOS = "LOGOS", /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */ VIDEO_MAKER = "VIDEO_MAKER", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ PARTNER_DASHBOARD = "PARTNER_DASHBOARD", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY", /** * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain. * * Meta site with this namespace will *not* be shown in a user's site list by default. */ HTML_DRAFT = "HTML_DRAFT", /** * the user-journey for Fitness users who want to start from managing their business instead of designing their website. * Will be accessible from Site List and will not have a website app. * Once the user attaches a site, the site will become a regular wixsite. */ SITELESS_BUSINESS = "SITELESS_BUSINESS", /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */ CREATOR_ECONOMY = "CREATOR_ECONOMY", /** It is to be used in the Business First efforts. */ DASHBOARD_FIRST = "DASHBOARD_FIRST", /** Bookings business flow with no site. */ ANYWHERE = "ANYWHERE", /** Namespace for Headless Backoffice with no editor */ HEADLESS = "HEADLESS", /** * Namespace for master site that will exist in parent account that will be referenced by subaccounts * The site will be used for account level CSM feature for enterprise */ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS", /** Rise.ai Siteless account management for Gift Cards and Store Credit. */ RISE = "RISE", /** * As part of the branded app new funnel, users now can create a meta site that will be branded app first. * There's a blank site behind the scene but it's blank). * The Mobile company will be the owner of this namespace. */ BRANDED_FIRST = "BRANDED_FIRST", /** Nownia.com Siteless account management for Ai Scheduling Assistant. */ NOWNIA = "NOWNIA", /** * UGC Templates are templates that are created by users for personal use and to sale to other users. * The Partners company owns this namespace. */ UGC_TEMPLATE = "UGC_TEMPLATE", /** Codux Headless Sites */ CODUX = "CODUX", /** Bobb - AI Design Creator. */ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR", /** * Shared Blog Site is a unique single site across Enterprise account, * This site will hold all Blog posts related to the Marketing product. */ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE", /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ STANDALONE_FORMS = "STANDALONE_FORMS", /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ STANDALONE_EVENTS = "STANDALONE_EVENTS", /** MIMIR - Siteless account for MIMIR Ai Job runner. */ MIMIR = "MIMIR", /** Wix Twins platform. */ TWINS = "TWINS", /** Wix Nano. */ NANO = "NANO", /** Base44 headless sites. */ BASE44 = "BASE44", /** Wix Channels Sites */ CHANNELS = "CHANNELS", /** Nautilus platform. */ NAUTILUS = "NAUTILUS", /** * Symphony — a siteless site representing a project within Symphony (the evolution of Orion). * Holds project data, conversations, assets, and manages collaborators / shared team members for the project. */ SYMPHONY = "SYMPHONY", /** Nautilus platform app. */ NAUTILUS_APPS = "NAUTILUS_APPS", /** * Vibu — a siteless site representing a project built with Vibu (the AI app builder). * Holds the project's generated code, conversations, assets, and manages collaborators for the project. */ VIBU = "VIBU", /** * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit * (an Enterprise account may have several), holding that BrandKit's brand definition * (theme, typography, assets) which is rolled out to the BrandKit's connected sites. * MetaSites with this namespace will *not* be shown in a user's site list by default. */ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT", /** * Dev-center development sites (com.wixpress.devcenter.dsm). * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites. */ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE" } /** @enumType */ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE'; /** Site transferred to another user. */ interface SiteTransferred { /** * A previous owner id (user that transfers meta site). * @format GUID */ oldOwnerId?: string; /** * A new owner id (user that accepts meta site). * @format GUID */ newOwnerId?: string; } /** Soft deletion of the meta site. Could be restored. */ interface SiteDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface DeleteContext { /** When the meta site was deleted. */ dateDeleted?: Date | null; /** A status. */ deleteStatus?: DeleteStatusWithLiterals; /** * A reason (flow). * @maxLength 255 */ deleteOrigin?: string; /** * A service that deleted it. * @maxLength 255 */ initiatorId?: string | null; } declare enum DeleteStatus { UNKNOWN = "UNKNOWN", TRASH = "TRASH", DELETED = "DELETED", PENDING_PURGE = "PENDING_PURGE", PURGED_EXTERNALLY = "PURGED_EXTERNALLY" } /** @enumType */ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY'; /** Restoration of the meta site. */ interface SiteUndeleted { } /** First publish of a meta site. Or subsequent publish after unpublish. */ interface SitePublished { } interface SiteUnpublished { /** * A list of URLs previously associated with the meta site. * @maxLength 4000 * @maxSize 10000 */ urls?: string[]; } interface SiteMarkedAsTemplate { } interface SiteMarkedAsWixSite { } /** * Represents a service provisioned a site. * * Note on `origin_instance_id`: * There is no guarantee that you will be able to find a meta site using `origin_instance_id`. * This is because of the following scenario: * * Imagine you have a template where a third-party application (TPA) includes some stub data, * such as a product catalog. When you create a site from this template, you inherit this * default product catalog. However, if the template's product catalog is modified, * your site will retain the catalog as it was at the time of site creation. This ensures that * your site remains consistent with what you initially received and does not include any * changes made to the original template afterward. * To ensure this, the TPA on the template gets a new instance_id. */ interface ServiceProvisioned { /** * Either UUID or EmbeddedServiceType. * @maxLength 36 */ appDefId?: string; /** * Not only UUID. Something here could be something weird. * @maxLength 36 */ instanceId?: string; /** * An instance id from which this instance is originated. * @maxLength 36 */ originInstanceId?: string; /** * A version. * @maxLength 500 */ version?: string | null; /** * The origin meta site id * @format GUID */ originMetaSiteId?: string | null; } interface ServiceRemoved { /** * Either UUID or EmbeddedServiceType. * @maxLength 36 */ appDefId?: string; /** * Not only UUID. Something here could be something weird. * @maxLength 36 */ instanceId?: string; /** * A version. * @maxLength 500 */ version?: string | null; } /** Rename of the site. Meaning, free public url has been changed as well. */ interface SiteRenamed { /** * A new meta site name (URL slug). * @maxLength 20 */ newSiteName?: string; /** * A previous meta site name (URL slug). * @maxLength 255 */ oldSiteName?: string; } /** * Hard deletion of the meta site. * * Could not be restored. Therefore it's desirable to cleanup data. */ interface SiteHardDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface NamespaceChanged { /** A previous namespace. */ oldNamespace?: NamespaceWithLiterals; /** A new namespace. */ newNamespace?: NamespaceWithLiterals; } /** Assigned Studio editor */ interface StudioAssigned { } /** Unassigned Studio editor */ interface StudioUnassigned { } /** * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc. * * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up * with sites and its urls, you need to listen to another topic/event. Read about it: * * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service */ interface SiteUrlChanged { } /** * Used at the end of the deletion flow for both draft sites and when a user deletes a site. * Consumed by other teams to remove relevant data. */ interface SitePurgedExternally { /** * @maxLength 2048 * @maxSize 100 * @deprecated * @targetRemovalDate 2025-04-15 */ appDefId?: string[]; } /** Assigned Odeditor */ interface OdeditorAssigned { } /** Unassigned Odeditor */ interface OdeditorUnassigned { } /** Assigned Picasso editor */ interface PicassoAssigned { } /** Unassigned Picasso */ interface PicassoUnassigned { } /** Assigned Wixel */ interface WixelAssigned { } /** Unassigned Wixel */ interface WixelUnassigned { } /** Assigned StudioTwo */ interface StudioTwoAssigned { } /** Unassigned StudioTwo */ interface StudioTwoUnassigned { } /** Media from user domain is enabled. */ interface UserDomainMediaEnabled { } /** Media from user domain is disabled. */ interface UserDomainMediaDisabled { } /** Assigned Editorless */ interface EditorlessAssigned { } /** Unassigned Editorless */ interface EditorlessUnassigned { } interface SyncApplicationAutomationsRequest { /** * List of app IDs * @format GUID * @maxSize 20 */ appIds?: string[]; } interface SyncApplicationAutomationsResponse { } interface BulkCreateApplicationAutomationRequest { /** * Automations to be created * @minSize 1 */ automations?: Automation[]; } interface BulkCreateApplicationAutomationResponse { /** The created Automations */ results?: Automation[]; /** Bulk create metadata. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkActionMetadata { /** Number of items that were successfully processed. */ totalSuccesses?: number; /** Number of items that couldn't be processed. */ totalFailures?: number; /** Number of failures without details because detailed failure threshold was exceeded. */ undetailedFailures?: number; } interface MessageEnvelope { /** * App instance ID. * @format GUID */ instanceId?: string | null; /** * Event type. * @maxLength 150 */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; /** Details related to the account */ accountInfo?: AccountInfo; } interface IdentificationData extends IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; /** @readonly */ identityType?: WebhookIdentityTypeWithLiterals; } /** @oneof */ interface IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; } declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** @enumType */ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } interface CreateAutomationRequest { /** Automation to be created */ automation: Automation; } interface CreateAutomationResponse { /** The created Automation */ automation?: Automation; } interface MigrationBulkCreateAutomationsRequest { /** Automations to be created */ automations?: Automation[]; /** V1 Activity type (trigger name) */ activityType?: string; /** automation id to counter map */ automationIdToCounter?: Record; /** automation id to last triggered map */ automationIdToLastTriggered?: Record; /** ignore validations */ ignoreValidations?: boolean | null; } interface MigrationBulkCreateAutomationsResponse { /** bulk action metadata */ bulkActionMetadata?: BulkActionMetadata; /** item metadata */ itemMetadata?: ItemMetadata[]; } interface ItemMetadata { /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */ id?: string | null; /** Index of the item within the request array. Allows for correlation between request and response items. */ originalIndex?: number; /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */ success?: boolean; /** Details about the error in case of failure. */ error?: ApplicationError; } interface ApplicationError { /** Error code. */ code?: string; /** Description of the error. */ description?: string; /** Data related to the error. */ data?: Record | null; } interface MigrationBulkCreateAutomations { /** * Automations to be created * @maxSize 100 */ automations?: Automation[]; /** V1 Activity type (trigger name) */ activityType?: string; /** automation id to counter map */ automationIdToCounter?: Record; /** automation id to last triggered map */ automationIdToLastTriggered?: Record; } interface GetAutomationRequest { /** * Automation ID * @format GUID */ automationId: string; /** Automation type */ automationType?: TypeWithLiterals; } interface GetAutomationResponse { /** Automation */ automation?: Automation; } interface UpdateAutomationRequest { /** Automation to be updated, may be partial */ automation: Automation; /** * Explicit list of fields to update * @internal */ mask?: string[]; } interface UpdateAutomationResponse { /** The updated Automation */ automation?: Automation; } interface UpdatedWithPreviousEntity { /** previous automation */ previousAutomation?: Automation; /** updated automation */ currentAutomation?: Automation; } interface MigrationUpdateAutomationRequest { /** Automation to be updated, may be partial */ automation: Automation; } interface MigrationUpdateAutomationResponse { /** The updated Automation */ automation?: Automation; } interface DeleteAutomationRequest { /** * Id of the Automation to delete * @format GUID */ automationId: string; /** The revision of the Automation */ revision?: string; } interface DeleteAutomationResponse { } interface DeletedWithEntity { /** Deleted automation */ automation?: Automation; } interface QueryAutomationsRequest { /** WQL expression */ query: QueryV2; /** Automation type */ automationType?: TypeWithLiterals; } interface QueryAutomationsResponse { /** List of automations */ automations?: Automation[]; /** Paging metadata */ paging?: PagingMetadataV2; } interface OverrideApplicationAutomationRequest { /** Application Automation */ automation: Automation; } interface OverrideApplicationAutomationResponse { /** Custom Automation */ automation?: Automation; } interface GenerateApplicationAutomationFromCustomRequest { /** Custom Automation */ automation?: Automation; } interface GenerateApplicationAutomationFromCustomResponse { /** Application Automation */ automation?: Automation; } interface ValidateAutomationByIdRequest { /** * Automation ID * @format GUID */ automationId: string; /** Automation type */ automationType?: TypeWithLiterals; } interface ValidateAutomationByIdResponse { /** is the Automation valid */ valid?: boolean; /** * list of validation errors for the automation Trigger * @maxSize 100 */ triggerValidationErrors?: TriggerValidationError[]; /** * list of validation information for the automation Actions * @maxSize 100 */ actionValidationInfo?: ActionValidationInfo[]; } interface TriggerValidationError extends TriggerValidationErrorErrorOneOf { /** trigger configuration error */ configurationError?: TriggerConfigurationError; /** provider configuration error */ providerConfigurationError?: ProviderConfigurationError; /** validation error type */ errorType?: TriggerValidationErrorValidationErrorTypeWithLiterals; } /** @oneof */ interface TriggerValidationErrorErrorOneOf { /** trigger configuration error */ configurationError?: TriggerConfigurationError; /** provider configuration error */ providerConfigurationError?: ProviderConfigurationError; } declare enum TriggerValidationErrorValidationErrorType { UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE", CONFIGURATION_ERROR = "CONFIGURATION_ERROR", PROVIDER_ERROR = "PROVIDER_ERROR" } /** @enumType */ type TriggerValidationErrorValidationErrorTypeWithLiterals = TriggerValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR'; interface TriggerConfigurationError { /** trigger error type */ errorType?: TriggerErrorTypeWithLiterals; /** optional - related filter field key */ filterFieldKey?: string | null; } declare enum TriggerErrorType { UNKNOWN_TRIGGER_ERROR_TYPE = "UNKNOWN_TRIGGER_ERROR_TYPE", NOT_FOUND = "NOT_FOUND", APP_NOT_INSTALLED = "APP_NOT_INSTALLED", MODERATION_MISMATCH = "MODERATION_MISMATCH", DEPRECATED = "DEPRECATED", INVALID_TRIGGER_KEY = "INVALID_TRIGGER_KEY", INVALID_FILTER_FIELD_KEY = "INVALID_FILTER_FIELD_KEY", INVALID_FILTER_EXPRESSION = "INVALID_FILTER_EXPRESSION" } /** @enumType */ type TriggerErrorTypeWithLiterals = TriggerErrorType | 'UNKNOWN_TRIGGER_ERROR_TYPE' | 'NOT_FOUND' | 'APP_NOT_INSTALLED' | 'MODERATION_MISMATCH' | 'DEPRECATED' | 'INVALID_TRIGGER_KEY' | 'INVALID_FILTER_FIELD_KEY' | 'INVALID_FILTER_EXPRESSION'; interface ProviderConfigurationError { /** Scheme field key. */ fieldKey?: string | null; /** Error message. */ message?: string; /** Label for the call-to-action button displayed with the error. */ ctaLabel?: string | null; /** When the call-to-action button is clicked, the redirect URL. */ ctaUrl?: string | null; /** Error title. */ title?: string; } interface ActionValidationInfo { /** * the id of the action in the automation * @format GUID */ actionId?: string | null; /** * the id of the app defining the action * @format GUID */ appId?: string; /** human readable identifier of the action per app */ actionKey?: string; /** * list of action validation errors * @maxSize 100 */ validationErrors?: ActionValidationError[]; } interface ActionValidationError extends ActionValidationErrorErrorOneOf { /** action configuration error */ configurationError?: ActionConfigurationError; /** provider configuration error */ providerConfigurationError?: ProviderConfigurationError; /** validation error type */ errorType?: ValidationErrorTypeWithLiterals; } /** @oneof */ interface ActionValidationErrorErrorOneOf { /** action configuration error */ configurationError?: ActionConfigurationError; /** provider configuration error */ providerConfigurationError?: ProviderConfigurationError; } declare enum ValidationErrorType { UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE", CONFIGURATION_ERROR = "CONFIGURATION_ERROR", PROVIDER_ERROR = "PROVIDER_ERROR" } /** @enumType */ type ValidationErrorTypeWithLiterals = ValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR'; interface ActionConfigurationError { /** action error type */ errorType?: ActionErrorTypeWithLiterals; /** optional - related field key */ fieldKey?: string | null; } declare enum ActionErrorType { UNKNOWN_ACTION_ERROR_TYPE = "UNKNOWN_ACTION_ERROR_TYPE", NOT_FOUND = "NOT_FOUND", APP_NOT_INSTALLED = "APP_NOT_INSTALLED", MODERATION_MISMATCH = "MODERATION_MISMATCH", DEPRECATED = "DEPRECATED", INVALID_ACTION_KEY = "INVALID_ACTION_KEY", INVALID_INPUT_MAPPING = "INVALID_INPUT_MAPPING", INVALID_OUTPUT_MAPPING = "INVALID_OUTPUT_MAPPING", INVALID_DELAY = "INVALID_DELAY", INVALID_RATE_LIMIT = "INVALID_RATE_LIMIT", INPUT_MAPPING_TYPE_MISMATCH = "INPUT_MAPPING_TYPE_MISMATCH", INPUT_MAPPING_MISSING_REQUIRED_FIELD = "INPUT_MAPPING_MISSING_REQUIRED_FIELD", INPUT_MAPPING_SCHEMA_MISMATCH = "INPUT_MAPPING_SCHEMA_MISMATCH", INPUT_MAPPING_VARIABLE_MISSING_FROM_SCHEMA = "INPUT_MAPPING_VARIABLE_MISSING_FROM_SCHEMA" } /** @enumType */ type ActionErrorTypeWithLiterals = ActionErrorType | 'UNKNOWN_ACTION_ERROR_TYPE' | 'NOT_FOUND' | 'APP_NOT_INSTALLED' | 'MODERATION_MISMATCH' | 'DEPRECATED' | 'INVALID_ACTION_KEY' | 'INVALID_INPUT_MAPPING' | 'INVALID_OUTPUT_MAPPING' | 'INVALID_DELAY' | 'INVALID_RATE_LIMIT' | 'INPUT_MAPPING_TYPE_MISMATCH' | 'INPUT_MAPPING_MISSING_REQUIRED_FIELD' | 'INPUT_MAPPING_SCHEMA_MISMATCH' | 'INPUT_MAPPING_VARIABLE_MISSING_FROM_SCHEMA'; interface ValidateAutomationRequest { /** Automation to validate */ automation: Automation; } interface ValidateAutomationResponse { /** is the Automation valid */ valid?: boolean; /** * list of validation errors for the automation Trigger * @maxSize 100 */ triggerValidationErrors?: TriggerValidationError[]; /** * list of validation information for the automation Actions * @maxSize 100 */ actionValidationInfo?: ActionValidationInfo[]; } interface UpdatedAutomationsWithEsb { /** * updated automations * @maxSize 100 */ automations?: Automation[]; } interface GetAutomationActivationReportsRequest { /** * Automation ID * @format GUID */ automationId: string; paging?: Paging; /** Fields projection - pass in the field key you want to get back */ fields?: string[]; } interface GetAutomationActivationReportsResponse { /** Automation activation reports */ activationReports?: ActivationReport[]; metadata?: PagingMetadata; /** activationStatus -> count */ stats?: Record; } interface ActivationReport { /** @format GUID */ activationId?: string; requestId?: string; status?: ActivationStatusWithLiterals; creationDate?: Date | null; updateDate?: Date | null; /** will be populated when status = FAILED */ error?: string | null; } declare enum ActivationStatus { UNKNOWN_ACTIVATION_REQUEST = "UNKNOWN_ACTIVATION_REQUEST", IN_PROGRESS = "IN_PROGRESS", SUCCESS = "SUCCESS", FAILED = "FAILED", SCHEDULED = "SCHEDULED", RETRY = "RETRY", RESUMED = "RESUMED", PAUSED = "PAUSED" } /** @enumType */ type ActivationStatusWithLiterals = ActivationStatus | 'UNKNOWN_ACTIVATION_REQUEST' | 'IN_PROGRESS' | 'SUCCESS' | 'FAILED' | 'SCHEDULED' | 'RETRY' | 'RESUMED' | 'PAUSED'; interface PagingMetadata { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ offset?: number | null; /** Total number of items that match the query. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; /** * Indicates if there are more results after the current page. * If `true`, another page of results can be retrieved. * If `false`, this is the last page. * @internal */ hasNext?: boolean | null; } interface GetAutomationActionSchemaRequest { /** * Automation's Configuration ID * @format GUID */ esbConfigurationId?: string; /** * Specific action ID * @format GUID */ actionId?: string; } interface GetAutomationActionSchemaResponse { /** The payload schema of the automation for the specific action */ schema?: Record | null; } interface GetActionsQuotaInfoRequest { } interface GetActionsQuotaInfoResponse { /** list of action quota information */ actionProviderQuotaInfo?: ActionProviderQuotaInfo[]; } interface ActionProviderQuotaInfo { /** * action app id * @format GUID */ appId?: string; /** * the action key * @minLength 1 * @maxLength 80 */ actionKey?: string; /** the action quota information */ actionQuotaInfo?: ActionQuotaInfo; } interface ActionQuotaInfo { /** * Whether the quotas for your action are enforced. If you mark this as `true` in the response body, * Wix displays the information in the quota object on the site dashboard. If you mark this as `false` for * a user, Wix does not display any quota info on the site dashboard for your service. */ enforced?: boolean; /** * The plans your service provides, together with the quotas enforced by each plan. A site may be enrolled * in multiple plans. Plans and quotas can be related as follows: * * + A single plan has a single quota. * + A single plan has multiple quotas. * + Multiple plans are associated with multiple quotas. * * Plans and quotas that are related should be grouped together in a single `quotaInfo` * object. */ quotaInfo?: QuotaInfo[]; } interface QuotaInfo { /** List of plans associated with the site making the request. */ plans?: Plan[]; /** * List of quotas associated with the plans the site is enrolled in. * @minSize 1 */ quotas?: Quota[]; /** * Details for an upgrade call-to-action button. * Displayed in the Wix user’s site dashboard together with the quota details. */ upgradeCta?: UpgradeCTA; } interface Plan { /** Plan ID defined by the action provider. */ id?: string; /** Plan name to display in the Wix user’s site dashboard. */ name?: string; /** * Plan group ID. * @internal */ groupId?: string | null; } interface Quota { /** * Name of the feature the quota is related to. For example, "Messages sent". * @minLength 1 */ featureName?: string; /** * Quota renewal date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. * For example, 10 July 2020 at 15:00 is written as `2020-07-10 15:00:00.000`. */ renewalDate?: Date | null; /** The user's current quota usage. */ currentUsage?: string; /** Quota limit data. */ limit?: string | null; /** Additional information about the quota. Displayed as a tooltip in the Wix user’s dashboard. */ additionalInfo?: AdditionalInfo; } interface CTA { /** * Call-to-action redirect URL. * @minLength 1 */ url?: string; /** * Call-to-action label. * @minLength 1 */ label?: string; } interface AdditionalInfo { /** * Tooltip content. * @minLength 1 */ description?: string; /** Details for an options call-to-action link that appears in the tooltip. */ cta?: CTA; } interface UpgradeCTA { /** * CTA button redirect URL. * @minLength 1 */ url?: string; /** * CTA button label. * @minLength 1 */ label?: string; /** * ID of the related plan. * @internal */ planId?: string | null; } interface BulkDeleteAutomationsRequest { /** * Automation IDs to delete * @format GUID * @maxSize 200 */ automationIds?: string[]; } interface BulkDeleteAutomationsResponse { } interface GenerateActionInputMappingFromTemplateRequest { /** action app id */ appId: string; /** the action key */ actionKey: string; /** action input mapping template the action spi provider will generate input mapping from */ actionInputMappingTemplate: Record | null; } interface GenerateActionInputMappingFromTemplateResponse { /** generated action input mapping */ generatedActionInputMapping?: Record | null; } interface MigrationUpdateMigratedToV3AutomationRequest { /** * Automation id * @format GUID */ automationId?: string; } interface MigrationUpdateMigratedToV3AutomationResponse { } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createAutomation(): __PublicMethodMetaInfo<'POST', {}, CreateAutomationRequest$1, CreateAutomationRequest, CreateAutomationResponse$1, CreateAutomationResponse>; declare function getAutomation(): __PublicMethodMetaInfo<'GET', { automationId: string; }, GetAutomationRequest$1, GetAutomationRequest, GetAutomationResponse$1, GetAutomationResponse>; declare function updateAutomation(): __PublicMethodMetaInfo<'PATCH', { automationId: string; }, UpdateAutomationRequest$1, UpdateAutomationRequest, UpdateAutomationResponse$1, UpdateAutomationResponse>; declare function migrationUpdateAutomation(): __PublicMethodMetaInfo<'PATCH', { automationId: string; }, MigrationUpdateAutomationRequest$1, MigrationUpdateAutomationRequest, MigrationUpdateAutomationResponse$1, MigrationUpdateAutomationResponse>; declare function deleteAutomation(): __PublicMethodMetaInfo<'DELETE', { automationId: string; }, DeleteAutomationRequest$1, DeleteAutomationRequest, DeleteAutomationResponse$1, DeleteAutomationResponse>; declare function queryAutomations(): __PublicMethodMetaInfo<'POST', {}, QueryAutomationsRequest$1, QueryAutomationsRequest, QueryAutomationsResponse$1, QueryAutomationsResponse>; declare function overrideApplicationAutomation(): __PublicMethodMetaInfo<'POST', {}, OverrideApplicationAutomationRequest$1, OverrideApplicationAutomationRequest, OverrideApplicationAutomationResponse$1, OverrideApplicationAutomationResponse>; declare function validateAutomationById(): __PublicMethodMetaInfo<'POST', { automationId: string; }, ValidateAutomationByIdRequest$1, ValidateAutomationByIdRequest, ValidateAutomationByIdResponse$1, ValidateAutomationByIdResponse>; declare function validateAutomation(): __PublicMethodMetaInfo<'POST', {}, ValidateAutomationRequest$1, ValidateAutomationRequest, ValidateAutomationResponse$1, ValidateAutomationResponse>; declare function getAutomationActivationStats(): __PublicMethodMetaInfo<'GET', { automationId: string; }, GetAutomationActivationReportsRequest$1, GetAutomationActivationReportsRequest, GetAutomationActivationReportsResponse$1, GetAutomationActivationReportsResponse>; declare function getActionsQuotaInfo(): __PublicMethodMetaInfo<'GET', {}, GetActionsQuotaInfoRequest$1, GetActionsQuotaInfoRequest, GetActionsQuotaInfoResponse$1, GetActionsQuotaInfoResponse>; declare function generateActionInputMappingFromTemplate(): __PublicMethodMetaInfo<'POST', {}, GenerateActionInputMappingFromTemplateRequest$1, GenerateActionInputMappingFromTemplateRequest, GenerateActionInputMappingFromTemplateResponse$1, GenerateActionInputMappingFromTemplateResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionConfigurationError as ActionConfigurationErrorOriginal, ActionErrorType as ActionErrorTypeOriginal, type ActionErrorTypeWithLiterals as ActionErrorTypeWithLiteralsOriginal, type ActionEvent as ActionEventOriginal, type Action as ActionOriginal, type ActionProviderQuotaInfo as ActionProviderQuotaInfoOriginal, type ActionQuotaInfo as ActionQuotaInfoOriginal, type ActionValidationErrorErrorOneOf as ActionValidationErrorErrorOneOfOriginal, type ActionValidationError as ActionValidationErrorOriginal, type ActionValidationInfo as ActionValidationInfoOriginal, type ActivationReport as ActivationReportOriginal, ActivationStatus as ActivationStatusOriginal, type ActivationStatusWithLiterals as ActivationStatusWithLiteralsOriginal, type AdditionalInfo as AdditionalInfoOriginal, type AddressLocation as AddressLocationOriginal, type ApplicationError as ApplicationErrorOriginal, type Asset as AssetOriginal, type AutomationMetadata as AutomationMetadataOriginal, type Automation as AutomationOriginal, BlockType as BlockTypeOriginal, type BlockTypeWithLiterals as BlockTypeWithLiteralsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateApplicationAutomationRequest as BulkCreateApplicationAutomationRequestOriginal, type BulkCreateApplicationAutomationResponse as BulkCreateApplicationAutomationResponseOriginal, type BulkDeleteAutomationsRequest as BulkDeleteAutomationsRequestOriginal, type BulkDeleteAutomationsResponse as BulkDeleteAutomationsResponseOriginal, type CTA as CTAOriginal, type ConditionBlock as ConditionBlockOriginal, type Condition as ConditionOriginal, type Conditions as ConditionsOriginal, type CreateAutomationRequest as CreateAutomationRequestOriginal, type CreateAutomationResponse as CreateAutomationResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type Debounce as DebounceOriginal, type Delay as DelayOriginal, type DelayTypeOneOf as DelayTypeOneOfOriginal, type DeleteAutomationRequest as DeleteAutomationRequestOriginal, type DeleteAutomationResponse as DeleteAutomationResponseOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeletedWithEntity as DeletedWithEntityOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, Domain as DomainOriginal, type DomainWithLiterals as DomainWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type Filter as FilterOriginal, type GenerateActionInputMappingFromTemplateRequest as GenerateActionInputMappingFromTemplateRequestOriginal, type GenerateActionInputMappingFromTemplateResponse as GenerateActionInputMappingFromTemplateResponseOriginal, type GenerateApplicationAutomationFromCustomRequest as GenerateApplicationAutomationFromCustomRequestOriginal, type GenerateApplicationAutomationFromCustomResponse as GenerateApplicationAutomationFromCustomResponseOriginal, type GetActionsQuotaInfoRequest as GetActionsQuotaInfoRequestOriginal, type GetActionsQuotaInfoResponse as GetActionsQuotaInfoResponseOriginal, type GetApplicationAutomationRequest as GetApplicationAutomationRequestOriginal, type GetApplicationAutomationResponse as GetApplicationAutomationResponseOriginal, type GetAutomationActionSchemaRequest as GetAutomationActionSchemaRequestOriginal, type GetAutomationActionSchemaResponse as GetAutomationActionSchemaResponseOriginal, type GetAutomationActivationReportsRequest as GetAutomationActivationReportsRequestOriginal, type GetAutomationActivationReportsResponse as GetAutomationActivationReportsResponseOriginal, type GetAutomationRequest as GetAutomationRequestOriginal, type GetAutomationResponse as GetAutomationResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type MigrationBulkCreateAutomations as MigrationBulkCreateAutomationsOriginal, type MigrationBulkCreateAutomationsRequest as MigrationBulkCreateAutomationsRequestOriginal, type MigrationBulkCreateAutomationsResponse as MigrationBulkCreateAutomationsResponseOriginal, type MigrationUpdateAutomationRequest as MigrationUpdateAutomationRequestOriginal, type MigrationUpdateAutomationResponse as MigrationUpdateAutomationResponseOriginal, type MigrationUpdateMigratedToV3AutomationRequest as MigrationUpdateMigratedToV3AutomationRequestOriginal, type MigrationUpdateMigratedToV3AutomationResponse as MigrationUpdateMigratedToV3AutomationResponseOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type Offset as OffsetOriginal, type OffsetValueOneOf as OffsetValueOneOfOriginal, type OverrideApplicationAutomationRequest as OverrideApplicationAutomationRequestOriginal, type OverrideApplicationAutomationResponse as OverrideApplicationAutomationResponseOriginal, type PagingMetadata as PagingMetadataOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type Plan as PlanOriginal, type ProviderConfigurationError as ProviderConfigurationErrorOriginal, type QueryApplicationAutomationsRequest as QueryApplicationAutomationsRequestOriginal, type QueryApplicationAutomationsResponse as QueryApplicationAutomationsResponseOriginal, type QueryAutomationsRequest as QueryAutomationsRequestOriginal, type QueryAutomationsResponse as QueryAutomationsResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type QuotaInfo as QuotaInfoOriginal, type Quota as QuotaOriginal, type RateLimit as RateLimitOriginal, type RestoreInfo as RestoreInfoOriginal, type Rule as RuleOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type SyncApplicationAutomationsRequest as SyncApplicationAutomationsRequestOriginal, type SyncApplicationAutomationsResponse as SyncApplicationAutomationsResponseOriginal, type TriggerConfigurationError as TriggerConfigurationErrorOriginal, TriggerErrorType as TriggerErrorTypeOriginal, type TriggerErrorTypeWithLiterals as TriggerErrorTypeWithLiteralsOriginal, type Trigger as TriggerOriginal, type TriggerValidationErrorErrorOneOf as TriggerValidationErrorErrorOneOfOriginal, type TriggerValidationError as TriggerValidationErrorOriginal, TriggerValidationErrorValidationErrorType as TriggerValidationErrorValidationErrorTypeOriginal, type TriggerValidationErrorValidationErrorTypeWithLiterals as TriggerValidationErrorValidationErrorTypeWithLiteralsOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type Until as UntilOriginal, type UpdateApplicationAutomationConfigurationIdRequest as UpdateApplicationAutomationConfigurationIdRequestOriginal, type UpdateApplicationAutomationConfigurationIdResponse as UpdateApplicationAutomationConfigurationIdResponseOriginal, type UpdateApplicationAutomationToMigratedFromV1Request as UpdateApplicationAutomationToMigratedFromV1RequestOriginal, type UpdateApplicationAutomationToMigratedFromV1Response as UpdateApplicationAutomationToMigratedFromV1ResponseOriginal, type UpdateAutomationRequest as UpdateAutomationRequestOriginal, type UpdateAutomationResponse as UpdateAutomationResponseOriginal, type UpdatedAutomationsWithEsb as UpdatedAutomationsWithEsbOriginal, type UpdatedWithPreviousEntity as UpdatedWithPreviousEntityOriginal, type UpgradeCTA as UpgradeCTAOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type ValidateAutomationByIdRequest as ValidateAutomationByIdRequestOriginal, type ValidateAutomationByIdResponse as ValidateAutomationByIdResponseOriginal, type ValidateAutomationRequest as ValidateAutomationRequestOriginal, type ValidateAutomationResponse as ValidateAutomationResponseOriginal, ValidationErrorType as ValidationErrorTypeOriginal, type ValidationErrorTypeWithLiterals as ValidationErrorTypeWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, createAutomation, deleteAutomation, generateActionInputMappingFromTemplate, getActionsQuotaInfo, getAutomation, getAutomationActivationStats, migrationUpdateAutomation, overrideApplicationAutomation, queryAutomations, updateAutomation, validateAutomation, validateAutomationById };