@wix/auto_sdk_automations_automations-v-2 1.0.3 → 1.0.5

package/build/internal/meta.d.mts

@@ -0,0 +1,1167 @@
+import { aH as CreateAutomationRequest$1, aI as CreateAutomationResponse$1, aJ as GetAutomationRequest$1, aK as GetAutomationResponse$1, aL as UpdateAutomationRequest$1, aM as UpdateAutomationResponse$1, aN as DeleteAutomationRequest$1, aO as DeleteAutomationResponse$1, aP as BulkDeleteAutomationsRequest$1, B as BulkDeleteAutomationsResponse$1, b0 as GeneratePreinstalledAutomationRequest$1, a as GeneratePreinstalledAutomationResponse$1, b9 as QueryAutomationsRequest$1, ba as QueryAutomationsResponse$1, bf as CopyAutomationRequest$1, c as CopyAutomationResponse$1, bF as CreateDraftAutomationRequest$1, e as CreateDraftAutomationResponse$1, bG as GetOrCreateDraftAutomationRequest$1, f as GetOrCreateDraftAutomationResponse$1, bH as UpdateDraftAutomationRequest$1, h as UpdateDraftAutomationResponse$1, bI as QueryAutomationsWithDraftsRequest$1, j as QueryAutomationsWithDraftsResponse$1, bK as DeleteDraftAutomationRequest$1, bL as DeleteDraftAutomationResponse$1, bM as PublishDraftAutomationRequest$1, P as PublishDraftAutomationResponse$1, bN as ValidateAutomationRequest$1, k as ValidateAutomationResponse$1, b_ as ValidateAutomationByIdRequest$1, m as ValidateAutomationByIdResponse$1, cd as GetAutomationRevisionRequest$1, o as GetAutomationRevisionResponse$1 } from './automations-v2-automation-automations-v-2.universal-BVuQcd6J.mjs';
+
+interface Automation extends AutomationOriginInfoOneOf {
+    /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
+    applicationInfo?: ApplicationOrigin;
+    /** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
+    preinstalledInfo?: PreinstalledOrigin;
+    /**
+     * Automation ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number. This increments by 1 whenever the automation is updated. Specify the current revision number whenever updating an existing automation.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Who created the automation.
+     * @immutable
+     * @readonly
+     */
+    createdBy?: AuditInfo;
+    /**
+     * When the automation was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Who last updated the automation.
+     * @readonly
+     */
+    updatedBy?: AuditInfo;
+    /**
+     * When the automation was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Automation name as displayed on the user's site.
+     * @minLength 1
+     * @maxLength 500
+     */
+    name?: string;
+    /**
+     * Automation description.
+     * @maxLength 2000
+     */
+    description?: string | null;
+    /** Automation configuration. */
+    configuration?: AutomationConfiguration;
+    /**
+     * How the automation was added to the user's site.
+     * @immutable
+     */
+    origin?: OriginWithLiterals;
+    /** Automation settings. */
+    settings?: AutomationSettings;
+    /**
+     * When the automation is a draft, the draft details.
+     * @readonly
+     */
+    draftInfo?: DraftInfo;
+    /**
+     * Whether the automation is archived.
+     *
+     * To archive an automation, set this to `true`. To restore an archived automation, set this to `false`.
+     */
+    archived?: boolean;
+}
+/** @oneof */
+interface AutomationOriginInfoOneOf {
+    /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
+    applicationInfo?: ApplicationOrigin;
+    /** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
+    preinstalledInfo?: PreinstalledOrigin;
+}
+interface ActionSettings {
+    /**
+     * Permanent actions. Permanent actions cannot be deleted.
+     *
+     * When empty, all actions can be deleted by the user.
+     * @maxSize 30
+     * @format GUID
+     */
+    permanentActionIds?: string[];
+    /**
+     * Read-only actions. Read-only actions cannot be edited.
+     *
+     * When empty, all actions are editable.
+     * @maxSize 30
+     * @format GUID
+     */
+    readonlyActionIds?: string[];
+    /**
+     * Whether to disable the ability to add a delay to the automation.
+     *
+     * Default: `false`.
+     */
+    disableDelayAddition?: boolean;
+    /**
+     * Whether to disable the ability to add a condition to the automation.
+     *
+     * Default: `false`.
+     */
+    disableConditionAddition?: boolean;
+}
+interface AuditInfo extends AuditInfoIdOneOf {
+    /**
+     * [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
+     * @format GUID
+     */
+    userId?: string;
+    /**
+     * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
+     *
+     * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
+     * @format GUID
+     */
+    appId?: string;
+}
+/** @oneof */
+interface AuditInfoIdOneOf {
+    /**
+     * [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
+     * @format GUID
+     */
+    userId?: string;
+    /**
+     * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
+     *
+     * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
+     * @format GUID
+     */
+    appId?: string;
+}
+interface AutomationConfiguration {
+    /** Status of the automation on the site. */
+    status?: StatusWithLiterals;
+    /** Trigger configuration. */
+    trigger?: Trigger;
+    /**
+     * Root action IDs. A root action is the first action that runs after the trigger occurs. Root actions run in parallel.
+     *
+     * > **Note**: You can currently only specify 1 root action.
+     * @maxSize 20
+     * @format GUID
+     */
+    rootActionIds?: string[];
+    /** Actions the automation can execute, as key:value pairs. For the key, specify the action ID. The value must be an object structured as described below. */
+    actions?: Record<string, Action>;
+}
+declare enum TimeUnit {
+    UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
+    /** Minutes. */
+    MINUTES = "MINUTES",
+    /** Hours. */
+    HOURS = "HOURS",
+    /** Days. */
+    DAYS = "DAYS",
+    /** Weeks. */
+    WEEKS = "WEEKS",
+    /** Months. */
+    MONTHS = "MONTHS"
+}
+/** @enumType */
+type TimeUnitWithLiterals = TimeUnit | 'UNKNOWN_TIME_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS';
+interface Filter {
+    /**
+     * Filter ID.
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * Field key.
+     *
+     * You can find the field key in [the trigger payload schema](https://dev.wix.com/docs/rest/business-management/automations/triggers/the-trigger-payload-schema).
+     * @minLength 1
+     * @maxLength 110
+     */
+    fieldKey?: string;
+    /**
+     * Filter expression.
+     *
+     * For the automation to run, the expression must evaluate to `true`.
+     * @maxLength 2500
+     */
+    filterExpression?: string;
+}
+interface FutureDateActivationOffset {
+    /**
+     * Amount of time before the trigger to run the automation.
+     *
+     * > **Note**: To delay an automation after the trigger event occurs, use a [delay action](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#delay-action).
+     * @maxLength 1000
+     */
+    preScheduledEventOffsetExpression?: string;
+    /** Unit in which to set the action offset. */
+    scheduledEventOffsetTimeUnit?: TimeUnitWithLiterals;
+}
+interface RateLimit {
+    /**
+     * Maximum number of times the trigger can be activated.
+     * @maxLength 1000
+     */
+    maxActivationsExpression?: string;
+    /**
+     * Duration of the rate limit. The rate limit applies for the specified duration and then expires.
+     *
+     * When empty, the rate limit does not expire.
+     * @maxLength 1000
+     */
+    durationExpression?: string | null;
+    /** Unit in which to set the duration of the rate limit. */
+    durationTimeUnit?: TimeUnitWithLiterals;
+    /**
+     * Activation identifier used to count the number of activations.
+     * @minLength 1
+     * @maxLength 400
+     */
+    uniqueIdentifierExpression?: string | null;
+}
+interface ConditionExpressionGroup {
+    /** Logical operator used to evaluate the condition expressions. */
+    operator?: OperatorWithLiterals;
+    /**
+     * Expressions evaluated using the selected operator.
+     * @minSize 1
+     * @maxSize 20
+     * @maxLength 2500
+     */
+    booleanExpressions?: string[];
+}
+declare enum Operator {
+    /** Unknown. */
+    UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
+    /** `OR` operator. */
+    OR = "OR",
+    /** `AND` operator. */
+    AND = "AND"
+}
+/** @enumType */
+type OperatorWithLiterals = Operator | 'UNKNOWN_OPERATOR' | 'OR' | 'AND';
+declare enum Type {
+    /** Based on the trigger. */
+    UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
+    /** Defined by a [Wix app](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#app-defined-actions). This action type is available in the site dashboard. */
+    APP_DEFINED = "APP_DEFINED",
+    /** Condition. This determines which action runs next. */
+    CONDITION = "CONDITION",
+    /** Delay. The automation must wait before executing the next step. */
+    DELAY = "DELAY",
+    /** Rate-limiter. This stops the automation flow if the subsequent action has reached its maximum allowed executions. */
+    RATE_LIMIT = "RATE_LIMIT"
+}
+/** @enumType */
+type TypeWithLiterals = Type | 'UNKNOWN_ACTION_TYPE' | 'APP_DEFINED' | 'CONDITION' | 'DELAY' | 'RATE_LIMIT';
+interface AppDefinedAction {
+    /**
+     * ID of the app that defines the action.
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * Action key.
+     * @minLength 1
+     * @maxLength 100
+     */
+    actionKey?: string;
+    /** Action input mapping as defined in the action's [input schema](https://dev.wix.com/docs/rest/business-management/automations/actions/the-action-input-schema). */
+    inputMapping?: Record<string, any> | null;
+    /**
+     * Action skip conditions. An action is skipped if any of the specified conditions evaluates to `true`.
+     *
+     * > **Note**: Actions that follow a skipped action still run.
+     * @maxSize 10
+     */
+    skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
+    /**
+     * IDs of actions that run in parallel after the action completes.
+     * @maxSize 20
+     * @format GUID
+     */
+    postActionIds?: string[];
+    /** Action output schema. When specified, this replaces the action schema. */
+    overrideOutputSchema?: Record<string, any> | null;
+}
+interface ConditionAction {
+    /**
+     * Condition is `true` if one or more of the expression groups evaluates to `true`.
+     * @minSize 1
+     * @maxSize 10
+     */
+    orExpressionGroups?: ConditionExpressionGroup[];
+    /**
+     * IDs of actions to run when the condition evaluates to `true`.
+     * @maxSize 20
+     * @format GUID
+     */
+    truePostActionIds?: string[];
+    /**
+     * IDs of actions to run when the condition evaluates to `false`.
+     * @maxSize 20
+     * @format GUID
+     */
+    falsePostActionIds?: string[];
+}
+interface DelayAction {
+    /**
+     * Time to wait before running the action. The wait time starts from when the current action completes.
+     *
+     * > **Note**: To define the wait time from a specific moment in time, use `dueDateEpochExpression`.
+     * @maxLength 1000
+     */
+    offsetExpression?: string | null;
+    /** Unit in which to set the wait time to wait before the action runs. */
+    offsetTimeUnit?: TimeUnitWithLiterals;
+    /**
+     * Action run date in milliseconds elapsed since January 1, 1970 UTC.
+     *
+     * > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
+     * @maxLength 1000
+     */
+    dueDateEpochExpression?: string | null;
+    /**
+     * IDs of actions to run in parallel after the time delay.
+     * @maxSize 20
+     * @format GUID
+     */
+    postActionIds?: string[];
+}
+interface RateLimitAction {
+    /**
+     * Maximum number of times the action can run.
+     * @maxLength 1000
+     */
+    maxActivationsExpression?: string;
+    /**
+     * Rate limit duration.
+     *
+     * When empty, the rate limit does not expire.
+     * @maxLength 1000
+     */
+    rateLimitDurationExpression?: string | null;
+    /** Unit in which to set the duration of the rate limit. */
+    rateLimitDurationTimeUnit?: TimeUnitWithLiterals;
+    /**
+     * Unique identifier of each activation by which rate limiter counts activations.
+     * @minLength 1
+     * @maxLength 400
+     */
+    uniqueIdentifierExpression?: string | null;
+    /**
+     * IDs of actions to run in parallel after the action completes.
+     * @maxSize 20
+     * @format GUID
+     */
+    postActionIds?: string[];
+}
+declare enum Status {
+    /** Unknown. */
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** Active. Active automations can be triggered. */
+    ACTIVE = "ACTIVE",
+    /** Inactive. Inactive automations cannot be triggered. */
+    INACTIVE = "INACTIVE"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'ACTIVE' | 'INACTIVE';
+interface Trigger {
+    /**
+     * ID of the app that defines the trigger.
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * Trigger key.
+     *
+     * Learn about [setting up a trigger](https://dev.wix.com/docs/rest/business-management/automations/triggers/add-a-trigger-to-your-app#step-1--set-up-the-trigger).
+     * @minLength 1
+     * @maxLength 100
+     */
+    triggerKey?: string;
+    /**
+     * Schema field filters. All filter conditions must be met for the automation to run.
+     *
+     * Learn more about setting up [automation filters](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#filters).
+     * @maxSize 5
+     */
+    filters?: Filter[];
+    /**
+     * Automation offset. You can schedule automations to run before the trigger occurs.
+     *
+     * Learn more about [scheduled events](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#scheduled-events).
+     */
+    scheduledEventOffset?: FutureDateActivationOffset;
+    /** Limit on the number of times an automation can be triggered. */
+    rateLimit?: RateLimit;
+    /** Trigger schema override. When specified, this replaces the trigger schema. */
+    overrideSchema?: Record<string, any> | null;
+}
+interface Action extends ActionInfoOneOf {
+    /** Details of the action when its `type` is `APP_DEFINED`. */
+    appDefinedInfo?: AppDefinedAction;
+    /** Details of the action when its `type` is `CONDITION`. */
+    conditionInfo?: ConditionAction;
+    /** Details of the action when its `type` is `CODE_CONDITION`. */
+    codeConditionInfo?: CodeConditionAction;
+    /** Details of the action when its `type` is `DELAY`. */
+    delayInfo?: DelayAction;
+    /** Details of the action when its `type` is `RATE_LIMIT`. */
+    rateLimitInfo?: RateLimitAction;
+    /**
+     * Action ID.
+     *
+     * If not specified, automatically generated by Wix.
+     * @format GUID
+     */
+    id?: string | null;
+    /** [Action type](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#action-type). */
+    type?: TypeWithLiterals;
+    /**
+     * [Action namespace](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#namespace). This differentiates it from other actions of the same type.
+     *
+     * If the action outputs any data, the data appears under the namespace in the payload sent to the subsequent steps in the automation. If the user has multiple actions with the same `appId` and `actionKey`, the output of the previous action is overwritten.
+     * @minLength 1
+     * @maxLength 100
+     */
+    namespace?: string | null;
+}
+/** @oneof */
+interface ActionInfoOneOf {
+    /** Details of the action when its `type` is `APP_DEFINED`. */
+    appDefinedInfo?: AppDefinedAction;
+    /** Details of the action when its `type` is `CONDITION`. */
+    conditionInfo?: ConditionAction;
+    /** Details of the action when its `type` is `CODE_CONDITION`. */
+    codeConditionInfo?: CodeConditionAction;
+    /** Details of the action when its `type` is `DELAY`. */
+    delayInfo?: DelayAction;
+    /** Details of the action when its `type` is `RATE_LIMIT`. */
+    rateLimitInfo?: RateLimitAction;
+}
+declare enum Origin {
+    /** Default value. */
+    UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
+    /** Created by a [Wix user](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-user). */
+    USER = "USER",
+    /** Created by a [Wix app](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-app) for a particular site. */
+    APPLICATION = "APPLICATION",
+    /** [Preinstalled automation](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/pre-installed-automations/about-pre-installed-automations). */
+    PREINSTALLED = "PREINSTALLED"
+}
+/** @enumType */
+type OriginWithLiterals = Origin | 'UNKNOWN_ORIGIN' | 'USER' | 'APPLICATION' | 'PREINSTALLED';
+interface ApplicationOrigin {
+    /**
+     * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
+     *
+     * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
+     * @format GUID
+     */
+    appId?: string;
+}
+interface PreinstalledOrigin {
+    /**
+     * ID of the app that added the [preinstalled automation](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/pre-installed-automations/about-pre-installed-automations).
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * Whether the automation is an override.
+     *
+     * When a user modifies the preinstalled automation installed on their site, a site-specific version of the automation is created that overrides the automation that was originally installed. This override automation has the same automation ID as the original preinstalled automation.
+     *
+     * > **Note**: An override automation can no longer be updated by the app that originally installed it.
+     * >
+     * > To revert to the original preinstalled version, the user must delete the override by calling the Delete Automation method. Calling Delete Automation on an override automation removes the override method and restores the preinstalled automation that was previously installed.
+     *
+     * Default: `false`.
+     * @immutable
+     * @readonly
+     */
+    override?: boolean | null;
+}
+interface AutomationSettings {
+    /**
+     * Whether the automation is hidden from users.
+     *
+     * Default: `false`
+     */
+    hidden?: boolean;
+    /**
+     * Whether the automation is read-only.
+     *
+     * Default: `false`
+     */
+    readonly?: boolean;
+    /**
+     * Whether to disable the option to delete the automation from the site.
+     *
+     * Default: `false`.
+     */
+    disableDelete?: boolean;
+    /**
+     * Whether to disable the option to change the automation's `configuration.status`, for example from `ACTIVE` to `INACTIVE`.
+     *
+     * Default: `false`.
+     */
+    disableStatusChange?: boolean;
+    /** Automation action settings. */
+    actionSettings?: ActionSettings;
+}
+interface DraftInfo {
+    /**
+     * ID of the original automation.
+     * @format GUID
+     * @readonly
+     */
+    originalAutomationId?: string | null;
+}
+interface CodeSnippet {
+    /** Logical operator used to evaluate the condition expressions. */
+    language?: LanguageWithLiterals;
+    /**
+     * Expressions evaluated using the selected operator. this code should comply the language syntax. and format
+     * @maxLength 1000
+     */
+    code?: string;
+}
+declare enum Language {
+    /** Unknown. */
+    UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
+    /** `JAVASCRIPT` language. */
+    JAVASCRIPT = "JAVASCRIPT"
+}
+/** @enumType */
+type LanguageWithLiterals = Language | 'UNKNOWN_LANGUAGE' | 'JAVASCRIPT';
+interface CodeConditionAction {
+    /** condition code. This is a code that can be used to identify the condition in the automation. code should return a boolean value. otherwise the value will be tried to be casted to boolean. */
+    snippet?: CodeSnippet;
+    /**
+     * IDs of actions to run when the condition evaluates to `true`.
+     * @maxSize 20
+     * @format GUID
+     */
+    truePostActionIds?: string[];
+    /**
+     * IDs of actions to run when the condition evaluates to `false`.
+     * @maxSize 20
+     * @format GUID
+     */
+    falsePostActionIds?: string[];
+}
+interface CreateAutomationRequest {
+    /** Automation to create. */
+    automation: Automation;
+}
+declare enum RequestedFields {
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    /** whether to return in response `configuration.trigger.override_output_schema` field and in `configuration.actions` the `override_output_schema` field */
+    OVERRIDE_SCHEMA = "OVERRIDE_SCHEMA"
+}
+/** @enumType */
+type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'OVERRIDE_SCHEMA';
+interface CreateAutomationResponse {
+    /** Details of the created automation. */
+    automation?: Automation;
+}
+interface GetAutomationRequest {
+    /**
+     * Automation ID.
+     * @format GUID
+     */
+    automationId: string;
+}
+interface GetAutomationResponse {
+    /** Retrieved automation. */
+    automation?: Automation;
+}
+interface UpdateAutomationRequest {
+    /** Automation to update. */
+    automation: Automation;
+}
+interface UpdateAutomationResponse {
+    /** Updated automation. */
+    automation?: Automation;
+}
+interface DeleteAutomationRequest {
+    /**
+     * Automation ID.
+     * @format GUID
+     */
+    automationId: string;
+}
+interface DeleteAutomationResponse {
+}
+interface BulkDeleteAutomationsRequest {
+    /**
+     * IDs of the automations to delete.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 200
+     */
+    automationIds: string[];
+}
+interface BulkDeleteAutomationsResponse {
+    /**
+     * Results of the bulk deletion.
+     * @minSize 1
+     * @maxSize 200
+     */
+    results?: BulkDeleteResult[];
+    /** Metadata for the API call. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkDeleteResult {
+    /** Deleted item metadata. */
+    itemMetadata?: ItemMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    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<string, any> | null;
+}
+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 GeneratePreinstalledAutomationRequest {
+    /** Automation. */
+    automation: Automation;
+    /**
+     * ID of the app to which the automation belongs.
+     * @format GUID
+     */
+    appId?: string;
+}
+interface GeneratePreinstalledAutomationResponse {
+    /** Automation. */
+    automation?: Automation;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** 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 in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2": { "$operator": "value2" }
+     * }`
+     *
+     * Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort configuration in the following format:
+     * `[{ "fieldName": "sortField1", "order": "ASC" }, { "fieldName":" sortField2", "order": "DESC" }]`
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** 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;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 500
+     */
+    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 64000
+     */
+    cursor?: string | null;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 64000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 64000
+     */
+    prev?: string | null;
+}
+interface QueryAutomationsRequest {
+    /**
+     * Query.
+     *
+     * Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
+     *
+     * > **Note**: To query archived automations, specify `{ "archived": true }` in the [query filter object](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
+     */
+    query?: CursorQuery;
+}
+interface QueryAutomationsResponse {
+    /** Automations. */
+    automations?: Automation[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CopyAutomationRequest {
+    /**
+     * ID of the automation to copy.
+     * @format GUID
+     */
+    automationId: string;
+    /** Origin of the automation to copy. */
+    origin?: OriginWithLiterals;
+    /** Automation to copy. Skips fetching by ID. */
+    automation?: Automation;
+}
+interface CopyAutomationResponse {
+    /** Copy of the automation. */
+    automation?: Automation;
+}
+interface CreateDraftAutomationRequest {
+    /** Draft automation to create. */
+    automation?: Automation;
+}
+interface CreateDraftAutomationResponse {
+    /** Draft automation that was created. */
+    automation?: Automation;
+}
+interface GetOrCreateDraftAutomationRequest {
+    /**
+     * ID of the original automation on which the draft is based.
+     * @format GUID
+     */
+    originalAutomationId: string;
+}
+interface GetOrCreateDraftAutomationResponse {
+    /** Draft automation. */
+    automation?: Automation;
+}
+interface UpdateDraftAutomationRequest {
+    /** Automation to update. Updates can be partial. */
+    automation: Automation;
+}
+interface UpdateDraftAutomationResponse {
+    /** Updated draft automation. */
+    automation?: Automation;
+}
+interface QueryAutomationsWithDraftsRequest {
+    /**
+     * Query.
+     *
+     * Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
+     */
+    query?: CursorQuery;
+}
+interface QueryAutomationsWithDraftsResponse {
+    /** Retrieved automations. */
+    automations?: Automation[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+    /**
+     * Map of existing automation IDs and their drafts' automation IDs.
+     * When include_draft_data is set to `false`, the map is empty. The key is the automationId of the original automation, and the value a list of related draft automationIds.
+     */
+    originalAutomationIdToDrafts?: Record<string, DraftsInfo>;
+}
+interface DraftsInfo {
+    /**
+     * IDs of the draft automations.
+     * @maxSize 1
+     * @format GUID
+     */
+    draftAutomationIds?: string[];
+}
+interface DeleteDraftAutomationRequest {
+    /**
+     * ID of the draft automation to delete.
+     * @format GUID
+     */
+    automationId: string;
+}
+interface DeleteDraftAutomationResponse {
+}
+interface PublishDraftAutomationRequest {
+    /**
+     * ID of the draft automation to publish.
+     * @format GUID
+     */
+    automationId: string;
+}
+interface PublishDraftAutomationResponse {
+    /** Updated published automation. */
+    automation?: Automation;
+}
+interface ValidateAutomationRequest {
+    /** Automation to validate. */
+    automation: Automation;
+    /** Automation validation settings. */
+    validationSettings?: ValidationSettings;
+}
+interface ValidationSettings {
+    /**
+     * IDs of actions to validate. Only actions whose IDs are specified are validated.
+     *
+     * When action IDs are specified, triggers are not validated. When empty, the full automation is validated, including triggers.
+     * @maxSize 30
+     * @format GUID
+     */
+    actionIds?: string[];
+    /**
+     * Whether to skip provider validations.
+     *
+     * Default: `false`.
+     */
+    skipProviderValidations?: boolean;
+}
+interface ValidateAutomationResponse {
+    /** Whether the automation is valid. */
+    valid?: boolean;
+    /**
+     * Validation errors generated by the automation trigger.
+     * @maxSize 100
+     */
+    triggerValidationErrors?: TriggerValidationError[];
+    /**
+     * Validation information generated by the automation actions.
+     * @maxSize 100
+     */
+    actionValidationInfo?: ActionValidationInfo[];
+    /**
+     * Additional validation errors generated by the automation.
+     * @maxSize 100
+     */
+    automationValidationErrors?: AutomationValidationError[];
+}
+interface TriggerValidationError extends TriggerValidationErrorErrorOneOf {
+    /** Trigger configuration error. */
+    configurationError?: TriggerConfigurationError;
+    /** Provider configuration error. */
+    providerConfigurationError?: ProviderConfigurationError;
+    /** Validation error type. */
+    errorType?: TriggerValidationErrorValidationErrorTypeWithLiterals;
+    /** Validation error severity */
+    severity?: ValidationErrorSeverityWithLiterals;
+}
+/** @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 = "CONFIGURATION_ERROR",
+    /** Provider error. */
+    PROVIDER_ERROR = "PROVIDER_ERROR"
+}
+/** @enumType */
+type TriggerValidationErrorValidationErrorTypeWithLiterals = TriggerValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
+interface TriggerConfigurationError {
+    /** Trigger error type. */
+    errorType?: TriggerErrorTypeWithLiterals;
+    /**
+     * Related filter field key.
+     * @maxLength 110
+     */
+    filterFieldKey?: string | null;
+}
+declare enum TriggerErrorType {
+    UNKNOWN_TRIGGER_ERROR_TYPE = "UNKNOWN_TRIGGER_ERROR_TYPE",
+    /** Trigger not found. */
+    NOT_FOUND = "NOT_FOUND",
+    /** App not installed. */
+    APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
+    /** Moderation mismatch. */
+    MODERATION_MISMATCH = "MODERATION_MISMATCH",
+    /** Deprecated. */
+    DEPRECATED = "DEPRECATED",
+    /** Invalid trigger key. */
+    INVALID_TRIGGER_KEY = "INVALID_TRIGGER_KEY",
+    /** Invalid filter field key. */
+    INVALID_FILTER_FIELD_KEY = "INVALID_FILTER_FIELD_KEY",
+    /** Invalid filter expression. */
+    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 {
+    /** Key corresponding to the field in the schema. */
+    fieldKey?: string | null;
+    /** Error message. */
+    message?: string;
+    /** Label for a call-to-action button that's displayed with the error. Translated according to the SPI language context. */
+    ctaLabel?: string | null;
+    /** URL to redirect to when the call-to-action button is clicked. */
+    ctaUrl?: string | null;
+    /** Title for the error. */
+    title?: string;
+}
+declare enum ValidationErrorSeverity {
+    UNKNOWN_VALIDATION_ERROR_SEVERITY = "UNKNOWN_VALIDATION_ERROR_SEVERITY",
+    /** Warning. */
+    WARNING = "WARNING",
+    /** Error. */
+    ERROR = "ERROR"
+}
+/** @enumType */
+type ValidationErrorSeverityWithLiterals = ValidationErrorSeverity | 'UNKNOWN_VALIDATION_ERROR_SEVERITY' | 'WARNING' | 'ERROR';
+interface ActionValidationInfo {
+    /**
+     * Action ID.
+     * @format GUID
+     */
+    actionId?: string | null;
+    /**
+     * ID of the app that defined the action.
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * Human-readable action identifier.
+     * @minLength 1
+     * @maxLength 100
+     */
+    actionKey?: string;
+    /**
+     * 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;
+    /** Validation error severity */
+    severity?: ValidationErrorSeverityWithLiterals;
+}
+/** @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 = "CONFIGURATION_ERROR",
+    /** Provider error. */
+    PROVIDER_ERROR = "PROVIDER_ERROR"
+}
+/** @enumType */
+type ValidationErrorTypeWithLiterals = ValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
+interface ActionConfigurationError {
+    /** Action error type. */
+    errorType?: ActionErrorTypeWithLiterals;
+    /**
+     * Related field key.
+     * @maxLength 110
+     */
+    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_MAPPING = "INVALID_MAPPING",
+    MAPPING_TYPE_MISMATCH = "MAPPING_TYPE_MISMATCH",
+    MAPPING_MISSING_REQUIRED_FIELD = "MAPPING_MISSING_REQUIRED_FIELD",
+    MAPPING_SCHEMA_MISMATCH = "MAPPING_SCHEMA_MISMATCH",
+    MAPPING_VARIABLE_MISSING_FROM_SCHEMA = "MAPPING_VARIABLE_MISSING_FROM_SCHEMA",
+    SAMPLE_CODE_RUN_FAILED = "SAMPLE_CODE_RUN_FAILED"
+}
+/** @enumType */
+type ActionErrorTypeWithLiterals = ActionErrorType | 'UNKNOWN_ACTION_ERROR_TYPE' | 'NOT_FOUND' | 'APP_NOT_INSTALLED' | 'MODERATION_MISMATCH' | 'DEPRECATED' | 'INVALID_ACTION_KEY' | 'INVALID_MAPPING' | 'MAPPING_TYPE_MISMATCH' | 'MAPPING_MISSING_REQUIRED_FIELD' | 'MAPPING_SCHEMA_MISMATCH' | 'MAPPING_VARIABLE_MISSING_FROM_SCHEMA' | 'SAMPLE_CODE_RUN_FAILED';
+interface AutomationValidationError extends AutomationValidationErrorErrorOneOf {
+    /** Automation configuration error. */
+    configurationError?: AutomationConfigurationError;
+    /** Provider configuration error. */
+    providerConfigurationError?: ProviderConfigurationError;
+    /** Validation error type. */
+    errorType?: AutomationValidationErrorValidationErrorTypeWithLiterals;
+    /** Validation error severity. */
+    severity?: ValidationErrorSeverityWithLiterals;
+}
+/** @oneof */
+interface AutomationValidationErrorErrorOneOf {
+    /** Automation configuration error. */
+    configurationError?: AutomationConfigurationError;
+    /** Provider configuration error. */
+    providerConfigurationError?: ProviderConfigurationError;
+}
+declare enum AutomationValidationErrorValidationErrorType {
+    UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
+    CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
+    PROVIDER_ERROR = "PROVIDER_ERROR"
+}
+/** @enumType */
+type AutomationValidationErrorValidationErrorTypeWithLiterals = AutomationValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
+interface AutomationConfigurationError {
+    /** Automation error type. */
+    errorType?: AutomationErrorTypeWithLiterals;
+}
+declare enum AutomationErrorType {
+    UNKNOWN_AUTOMATION_ERROR_TYPE = "UNKNOWN_AUTOMATION_ERROR_TYPE"
+}
+/** @enumType */
+type AutomationErrorTypeWithLiterals = AutomationErrorType | 'UNKNOWN_AUTOMATION_ERROR_TYPE';
+interface ValidateAutomationByIdRequest {
+    /**
+     * Automation ID.
+     * @format GUID
+     */
+    automationId: string;
+    /** Validation settings. */
+    validationSettings?: ValidationSettings;
+}
+interface ValidateAutomationByIdResponse {
+    /** Whether the automation is valid. */
+    valid?: boolean;
+    /**
+     * Validation errors generated by the automation trigger.
+     * @maxSize 100
+     */
+    triggerValidationErrors?: TriggerValidationError[];
+    /**
+     * Validation information generated by the automation actions.
+     * @maxSize 100
+     */
+    actionValidationInfo?: ActionValidationInfo[];
+    /**
+     * Additional validation errors generated by the automation.
+     * @maxSize 100
+     */
+    automationValidationErrors?: AutomationValidationError[];
+}
+interface GetAutomationRevisionRequest {
+    /**
+     * Automation ID.
+     * @format GUID
+     */
+    automationId: string;
+    /** Revision number. */
+    revision?: string | null;
+    /**
+     * Requested fields.
+     * @maxSize 20
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface GetAutomationRevisionResponse {
+    /** Automation revision. */
+    automation?: Automation;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    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 deleteAutomation(): __PublicMethodMetaInfo<'DELETE', {
+    automationId: string;
+}, DeleteAutomationRequest$1, DeleteAutomationRequest, DeleteAutomationResponse$1, DeleteAutomationResponse>;
+declare function bulkDeleteAutomations(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteAutomationsRequest$1, BulkDeleteAutomationsRequest, BulkDeleteAutomationsResponse$1, BulkDeleteAutomationsResponse>;
+declare function generatePreinstalledAutomation(): __PublicMethodMetaInfo<'POST', {}, GeneratePreinstalledAutomationRequest$1, GeneratePreinstalledAutomationRequest, GeneratePreinstalledAutomationResponse$1, GeneratePreinstalledAutomationResponse>;
+declare function queryAutomations(): __PublicMethodMetaInfo<'POST', {}, QueryAutomationsRequest$1, QueryAutomationsRequest, QueryAutomationsResponse$1, QueryAutomationsResponse>;
+declare function copyAutomation(): __PublicMethodMetaInfo<'POST', {
+    automationId: string;
+}, CopyAutomationRequest$1, CopyAutomationRequest, CopyAutomationResponse$1, CopyAutomationResponse>;
+declare function createDraftAutomation(): __PublicMethodMetaInfo<'POST', {}, CreateDraftAutomationRequest$1, CreateDraftAutomationRequest, CreateDraftAutomationResponse$1, CreateDraftAutomationResponse>;
+declare function getOrCreateDraftAutomation(): __PublicMethodMetaInfo<'POST', {
+    originalAutomationId: string;
+}, GetOrCreateDraftAutomationRequest$1, GetOrCreateDraftAutomationRequest, GetOrCreateDraftAutomationResponse$1, GetOrCreateDraftAutomationResponse>;
+declare function updateDraftAutomation(): __PublicMethodMetaInfo<'PATCH', {
+    automationId: string;
+}, UpdateDraftAutomationRequest$1, UpdateDraftAutomationRequest, UpdateDraftAutomationResponse$1, UpdateDraftAutomationResponse>;
+declare function queryAutomationsWithDrafts(): __PublicMethodMetaInfo<'POST', {}, QueryAutomationsWithDraftsRequest$1, QueryAutomationsWithDraftsRequest, QueryAutomationsWithDraftsResponse$1, QueryAutomationsWithDraftsResponse>;
+declare function deleteDraftAutomation(): __PublicMethodMetaInfo<'DELETE', {
+    automationId: string;
+}, DeleteDraftAutomationRequest$1, DeleteDraftAutomationRequest, DeleteDraftAutomationResponse$1, DeleteDraftAutomationResponse>;
+declare function publishDraftAutomation(): __PublicMethodMetaInfo<'POST', {
+    automationId: string;
+}, PublishDraftAutomationRequest$1, PublishDraftAutomationRequest, PublishDraftAutomationResponse$1, PublishDraftAutomationResponse>;
+declare function validateAutomation(): __PublicMethodMetaInfo<'POST', {}, ValidateAutomationRequest$1, ValidateAutomationRequest, ValidateAutomationResponse$1, ValidateAutomationResponse>;
+declare function validateAutomationById(): __PublicMethodMetaInfo<'POST', {
+    automationId: string;
+}, ValidateAutomationByIdRequest$1, ValidateAutomationByIdRequest, ValidateAutomationByIdResponse$1, ValidateAutomationByIdResponse>;
+declare function getAutomationRevision(): __PublicMethodMetaInfo<'GET', {
+    automationId: string;
+}, GetAutomationRevisionRequest$1, GetAutomationRevisionRequest, GetAutomationRevisionResponse$1, GetAutomationRevisionResponse>;
+
+export { type __PublicMethodMetaInfo, bulkDeleteAutomations, copyAutomation, createAutomation, createDraftAutomation, deleteAutomation, deleteDraftAutomation, generatePreinstalledAutomation, getAutomation, getAutomationRevision, getOrCreateDraftAutomation, publishDraftAutomation, queryAutomations, queryAutomationsWithDrafts, updateAutomation, updateDraftAutomation, validateAutomation, validateAutomationById };