@wix/automations 1.0.18 → 1.0.19

package/type-bundles/context.bundle.d.ts

@@ -1772,7 +1772,6 @@ interface Activation {
     /** Activation automation */
     automation?: Automation$1;
 }
-/** Automation */
 interface Automation$1 extends AutomationOriginInfoOneOf$1 {
     /** Application info */
     applicationInfo?: ApplicationOrigin$1;
@@ -1786,43 +1785,43 @@ interface Automation$1 extends AutomationOriginInfoOneOf$1 {
      */
     _id?: string | null;
     /**
-     * Revision number, which increments by 1 each time the Automation is updated.
+     * Revision number, which increments by 1 each time the automation is updated.
      * To prevent conflicting changes,
-     * the current revision must be passed when updating the Automation.
+     * the current revision must be passed when updating the automation.
      *
-     * Ignored when creating an Automation.
+     * Ignored when creating an automation.
      * @readonly
      */
     revision?: string | null;
     /**
-     * information about the creator of the automation
+     * Information about the creator of the automation.
      * @readonly
      */
     createdBy?: AuditInfo$1;
     /**
-     * Date and time the Automation was created.
+     * Date and time the automation was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * information about who updated of the automation
+     * The entity that last updated the automation.
      * @readonly
      */
     updatedBy?: AuditInfo$1;
     /**
-     * Date and time the Automation was last updated.
+     * Date and time the automation was last updated.
      * @readonly
      */
     _updatedDate?: Date;
-    /** Automation name */
+    /** Automation name that is displayed on the user's site. */
     name?: string;
-    /** Automation description */
+    /** Automation description. */
     description?: string | null;
-    /** Automation runtime configuration */
+    /** Object that defines the automation's trigger, actions, and activation status. */
     configuration?: AutomationConfiguration$1;
-    /** Origin type */
+    /** Defines how the automation was added to the site. */
     origin?: Origin$1;
-    /** Automation settings */
+    /** Automation settings. */
     settings?: AutomationSettings$1;
 }
 /** @oneof */
@@ -1835,39 +1834,45 @@ interface AutomationOriginInfoOneOf$1 {
     draftInfo?: DraftOrigin$1;
 }
 interface ActionSettings$1 {
-    /** list of permanent action ids of actions that cannot be deleted (default - empty, all actions are deletable by default) */
+    /**
+     * List of actions that cannot be deleted.
+     * Default: Empty. All actions are deletable by default.
+     */
     permanentActionIds?: string[];
-    /** list of readonly action ids, (default - empty, all actions are editable by default) */
+    /**
+     * List of actions that cannot be edited.
+     * Default: Empty. All actions are editable by default.
+     */
     readonlyActionIds?: string[];
-    /** sets if adding a delay action is disabled for this automation */
+    /** Whether the option to add a delay is disabled for the automation. */
     disableDelayAddition?: boolean;
-    /** sets if adding a condition action is disabled for this automation */
+    /** Whether the option to add a condition is disabled for the automation. */
     disableConditionAddition?: boolean;
 }
 interface AuditInfo$1 extends AuditInfoIdOneOf$1 {
-    /** user identifier */
+    /** User ID. */
     userId?: string;
-    /** application identifier */
+    /** Application ID. */
     appId?: string;
 }
 /** @oneof */
 interface AuditInfoIdOneOf$1 {
-    /** user identifier */
+    /** User ID. */
     userId?: string;
-    /** application identifier */
+    /** Application ID. */
     appId?: string;
 }
 /** Automation runtime configuration */
 interface AutomationConfiguration$1 {
-    /** Automation's Status */
+    /** Status of the automation on the site. */
     status?: AutomationConfigurationStatus;
-    /** Trigger configuration */
+    /** Automation trigger configuration. */
     trigger?: Trigger$1;
-    /** actions that run in parallel after the trigger */
+    /** List of IDs of root actions. Root actions are the first actions to run after the trigger. The actions in the list run in parallel. */
     rootActionIds?: string[];
     /**
-     * map of all actions by actionId
-     * The key is the actionId of the action, and the value is the action configuration
+     * Map of all actions that the automation may execute.
+     * The key is the action ID, and the value is the action configuration.
      */
     actions?: Record<string, AutomationConfigurationAction>;
 }
@@ -1880,51 +1885,36 @@ declare enum TimeUnit$1 {
     MONTHS = "MONTHS"
 }
 interface Filter$1 {
-    /** the filter identifier */
+    /** Filter ID. */
     _id?: string;
-    /** the field key from the schema, for example "formId" */
+    /** Field key from the payload schema, for example "formId". */
     fieldKey?: string;
-    /** filter expression that evaluates to a boolean, for example - {{ contains(["guid1","guid2"];formId) }} */
+    /** Filter expression that evaluates to a boolean. */
     filterExpression?: string;
 }
 interface FutureDateActivationOffset$1 {
     /**
-     * expression of offset before the trigger's time (in selected time unit), when the Automation should run
-     * only allows negative offset from the trigger's date (before the trigger), positive offset should be achieved via offset delay action
-     * preScheduledEventOffsetExpression: "{{5}}" + timeUnit: Days -  to run the Automation 5 days before the trigger's date
-     * or, preScheduledEventOffsetExpression: "{{ someNumberField }}" + timeUnit: Minutes, to run the Automation someNumberField's value in minutes before the trigger's date
+     * The offset value. The value is always taken as negative, so that the automation runs before the trigger date.
+     * To create an offset that causes the automation to run after the trigger date, use a delay action.
      */
     preScheduledEventOffsetExpression?: string;
-    /** Time unit for the scheduled event offset */
+    /** Time unit for the scheduled event offset. */
     scheduledEventOffsetTimeUnit?: TimeUnit$1;
 }
 interface RateLimit$1 {
-    /**
-     * Maximum number of activations expression. the expression will need to be parsed to Int on runtime
-     * for example - "{{ 1 }}" to set max activations to 1, or "{{ var(someNumberField) }}" to set max activations as the value of "someNumberField" from the payload
-     */
+    /** Value expressing the maximum number of times the trigger can be activated. */
     maxActivationsExpression?: string;
-    /**
-     * Duration of the rate limiting window (in selected time unit) expression for rate limiter, if empty then no time limit. the expression will need to be parsed to Int on runtime
-     * for example - "{{ 10 }}" to set timeframe to be 10 minutes, or {{ var(someNumberField) }} to set timeframe in minutes as the value of "someNumberField" from the payload
-     */
+    /** Duration of the rate limiting window in the selected time unit. If no value is set, the rate limit is permanent. */
     durationExpression?: string | null;
-    /** Time unit for the rate limit duration */
+    /** Time unit for the rate limit duration. */
     durationTimeUnit?: TimeUnit$1;
-    /**
-     * Unique identifier of each activation by which rate limiter will count activations, expected return type is string
-     * for example - {{ var(contact.id) }} to set the unique identifier as the value of "contact.id" from the payload
-     * evaluated expression must be under 46 characters
-     */
+    /** Unique identifier of each activation, by which rate limiter will count activations. */
     uniqueIdentifierExpression?: string | null;
 }
 interface ConditionExpressionGroup$1 {
-    /** expression group operator */
+    /** Expression group operator. */
     operator?: Operator$1;
-    /**
-     * list of boolean expressions to be evaluated with the given operator
-     * examples - {{ true }}, {{ someBooleanField }}, {{ contains(["guid1...","guid2..."];formId) }}
-     */
+    /** List of boolean expressions to be evaluated with the given operator. */
     booleanExpressions?: string[];
 }
 declare enum Operator$1 {
@@ -1947,86 +1937,60 @@ declare enum Type$1 {
     OUTPUT = "OUTPUT"
 }
 interface AppDefinedAction$1 {
-    /** Action app id */
+    /** ID of the app that defines the action. */
     appId?: string;
-    /** Action key */
+    /** Action key. */
     actionKey?: string;
-    /**
-     * Action input mapping, example:
-     * {
-     * "to": "{{ var(contact.email) }}",
-     * "subject": "Your registration to {{ var(eventName) }} is Confirmed",
-     * "body": "Hi {{ var(contact.name) }}, you are confirmed for the event"
-     * }
-     */
+    /** Action input mapping. */
     inputMapping?: Record<string, any> | null;
     /**
-     * optional skip condition configuration - if this action should be skipped when the automation runs (following actions of a skipped action will still run)
-     * the action will be skipped if either of the expression groups evaluate to `true`
-     * the relation between the expression groups is an OR relation.
+     * Array of conditions determining whether to skip the action in the automation flow.
+     * The action will be skipped if any of the expression groups evaluate to `true`.
+     * Actions following a skipped action will still run.
      */
     skipConditionOrExpressionGroups?: ConditionExpressionGroup$1[];
-    /** actions to run in parallel after this action finishes */
+    /** List of IDs of actions to run in parallel once the action completes. */
     postActionIds?: string[];
 }
 interface ConditionAction$1 {
-    /**
-     * the condition evaluates to `true` if either of the expression groups evaluate to `true`
-     * the relation between the expression groups is an OR relation.
-     */
+    /** The condition evaluates to `true` if either of the expression groups evaluate to `true`. */
     orExpressionGroups?: ConditionExpressionGroup$1[];
-    /** actions to run when the entire condition is evaluated to `true` */
+    /** List of IDs of actions to run when the entire condition is evaluated to `true`. */
     truePostActionIds?: string[];
-    /** actions to run when the entire condition is evaluated to `false` */
+    /** List of IDs of actions to run when the entire condition is evaluated to `false`. */
     falsePostActionIds?: string[];
 }
 interface DelayAction$1 {
-    /**
-     * optional - expression for amount of time to wait (in selected time unit) - from a specific date or from the time the action is executed
-     * offsetExpression: "{{5}}" + timeUnit: Days -  to wait for 5 days from the time the delay was invoked
-     * or, offsetExpression: "{{5}}" + timeUnit: Days + dueDateEpochExpression: "{{someDateField}}" -  to wait for 5 days from the time date in "someDateField" field in the payload
-     * or, offsetExpression: "{{ someNumberField }}" + timeUnit: Minutes,  to wait for someNumberField's value in minutes
-     */
+    /** Value expressing the amount of time to wait from a specific date or from the time the action is executed. */
     offsetExpression?: string | null;
-    /** Time unit for delay offset */
+    /** Time unit for delay offset. */
     offsetTimeUnit?: TimeUnit$1;
     /**
-     * optional - expression of the due date to wait until, if an offset was defined, it will be calculated from this date
-     * number of milliseconds since the Unix Epoch (1 January, 1970 UTC)
-     * for example - "{{ 18238348023423 }}", or "{{ someEpochFromPayloadField }}" / "{{ contact.birthdate }}"
+     * The action due date. If defined without an offset, the automation will wait until this date to execute the next step.
+     * If an offset is defined, it's calculated from this date.
+     * The date is expressed in the number of milliseconds since the Unix Epoch (1 January, 1970 UTC).
      */
     dueDateEpochExpression?: string | null;
-    /** actions to run in parallel after this action finishes */
+    /** List of IDs of actions to run in parallel after the delay. */
     postActionIds?: string[];
 }
 interface RateLimitAction$1 {
-    /**
-     * Maximum number of activations expression. the expression will need to be parsed to Int on runtime
-     * for example - "{{ 1 }}" to set max activations to 1, or "{{ var(someNumberField) }}" to set max activations as the value of "someNumberField" from the payload
-     */
+    /** The maximum number of activations allowed for the action. */
     maxActivationsExpression?: string;
     /**
-     * Duration of the rate limiting window (in selected time unit) expression for rate limiter, if empty then no time limit. the expression will need to be parsed to Int on runtime
-     * for example - "{{ 10 }}" to set timeframe to be 10 minutes, or {{ var(someNumberField) }} to set timeframe in minutes as the value of "someNumberField" from the payload
+     * Duration of the rate limiting window, expressed in selected time unit.
+     * If no value is set, then there is no time limit on the rate limiter.
      */
     rateLimitDurationExpression?: string | null;
-    /** Time unit for the rate limit duration */
+    /** Time unit for the rate limit duration. */
     rateLimitDurationTimeUnit?: TimeUnit$1;
-    /**
-     * Unique identifier of each activation by which rate limiter will count activations, expected return type is string
-     * for example - {{ var(contact.id) }} to set the unique identifier as the value of "contact.id" from the payload
-     */
+    /** Unique identifier of each activation by which rate limiter counts activations. */
     uniqueIdentifierExpression?: string | null;
-    /** actions to run in parallel after this action finishes */
+    /** List of IDs of actions to run in parallel once the action completes. */
     postActionIds?: string[];
 }
 interface OutputAction$1 {
-    /**
-     * Output action output mapping
-     * {
-     * "to": "{{ var(contact.email) }}"
-     * }
-     */
+    /** Output action output mapping. */
     outputMapping?: Record<string, any> | null;
 }
 declare enum AutomationConfigurationStatus {
@@ -2038,89 +2002,52 @@ declare enum AutomationConfigurationStatus {
     INACTIVE = "INACTIVE"
 }
 interface Trigger$1 {
-    /** Trigger Application id */
+    /** ID of the app that defines the trigger. */
     appId?: string;
-    /** Trigger key */
+    /** Trigger key. */
     triggerKey?: string;
     /**
-     * optional - list of filters on schema fields
-     * the relation between the filter expressions is an AND relation.
-     * all filter expressions must be evaluated to `true` for a given payload in order for the automation to be executed
+     * List of filters on schema fields.
+     * In order for the automation to run, all filter expressions must evaluate to `true` for a given payload.
      */
     filters?: Filter$1[];
-    /** optional - future date trigger activation offset */
+    /** Defines the time offset between the trigger date and when the automation runs. */
     scheduledEventOffset?: FutureDateActivationOffset$1;
-    /** optional - rate limiting configuration */
+    /** Limits the number of times an automation can be triggered. */
     rateLimit?: RateLimit$1;
     automationConfigMapping?: Record<string, any> | null;
 }
 interface AutomationConfigurationAction extends AutomationConfigurationActionInfoOneOf {
-    /** App defined Action (via RPC, HTTP or Velo) */
+    /** Action defined by an app (via RPC, HTTP or Velo). */
     appDefinedInfo?: AppDefinedAction$1;
-    /** Condition action */
+    /** Condition action. */
     conditionInfo?: ConditionAction$1;
-    /** Delay action */
+    /** Delay action. */
     delayInfo?: DelayAction$1;
-    /** Rate limiting action */
+    /** Rate-limiting action. */
     rateLimitInfo?: RateLimitAction$1;
-    /** Action id, if not specified, will be generated */
+    /** Action ID. If not specified, a new ID is generated. */
     _id?: string | null;
-    /** Type of the action */
+    /** Action type. */
     type?: Type$1;
     /**
-     * Human readable name for the action (may only contain alphanumeric characters and underscores) to differentiate from other actions of the same kind.
-     * if the action has output, the output will be available in the payload under this name, otherwise it will be concatenated to the payload as is
-     * without namespaces (or in case of exact same namespaces), if the user has multiple actions of the same kind (appId+actionKey), the output will be overwritten.
-     *
-     * for example, given:
-     * - if the action output looks like this - { "message": "hello" }
-     * - the namespace is "action_1"
-     * - the trigger payload looks like this - { "someField": "50", "someBoolean": true }
-     *
-     * the payload will look like this:
-     * {
-     * "someField": "50",
-     * "someBoolean": true,
-     * "action_1": {
-     * "message": "hello"
-     * }
-     * }
-     *
-     * given the following Automation configuration:
-     *
-     * (Trigger A)
-     * |
-     * (Action B) // namespace = "action_b_1"
-     * |
-     * (Action B) // namespace = "action_b_2"
-     * |
-     * (Action C)
-     *
-     *
-     * the available fields that Action C will be able to use to map to it's input fields will be:
-     * {
-     * "someField": "50",
-     * "someBoolean": true,
-     * "action_b_1": {
-     * "message": "hello"
-     * },
-     * "action_b_2": {
-     * "message": "hello"
-     * }
-     * }
-     * so the user can select which specific action output to use (action_b_1.message or action_b_2.message, in the case above)
+     * Human-readable name to differentiate the action from other actions of the same type.
+     * The name can contain only alphanumeric characters and underscores. If not provided, a namespace in the form `actionkey-indexOfAction` is
+     * generated automatically.
+     * If the action has output, the output will be available in the payload under this name.
+     * If the user has multiple actions with the same appId and actionKey, previous action output will be overwritten.
      */
     namespace?: string | null;
 }
 /** @oneof */
 interface AutomationConfigurationActionInfoOneOf {
-    /** App defined Action (via RPC, HTTP or Velo) */
+    /** Action defined by an app (via RPC, HTTP or Velo). */
     appDefinedInfo?: AppDefinedAction$1;
-    /** Condition action */
+    /** Condition action. */
     conditionInfo?: ConditionAction$1;
-    /** Delay action */
+    /** Delay action. */
     delayInfo?: DelayAction$1;
-    /** Rate limiting action */
+    /** Rate-limiting action. */
     rateLimitInfo?: RateLimitAction$1;
 }
 declare enum Origin$1 {
@@ -2136,18 +2063,22 @@ declare enum Origin$1 {
     DRAFT = "DRAFT"
 }
 interface ApplicationOrigin$1 {
-    /** identifier for the application */
+    /** Application ID. */
     appId?: string;
 }
 interface PreinstalledOrigin$1 {
-    /** identifier for the application */
+    /** ID of the app that defines the preinstalled automation. */
     appId?: string;
-    /** application component ID */
+    /** Application component ID. */
     componentId?: string;
-    /** application component Version */
+    /** Application component version. */
     componentVersion?: number;
     /**
-     * is this a user modified preinstalled automation (on a specific site) or the original one
+     * Whether the automation is an override automation. If the user modifies the preinstalled automation installed on their site, a site-specific
+     * automation is created that overrides the original one. If the user makes no modifications this boolean is set to `false` and the original
+     * preinstalled automation is used.
+     *
+     * Default: `false`
      * @readonly
      */
     override?: boolean | null;
@@ -2157,15 +2088,27 @@ interface DraftOrigin$1 {
     parentId?: string | null;
 }
 interface AutomationSettings$1 {
-    /** sets if the automation is hidden from users */
+    /**
+     * Whether the automation is hidden from users.
+     * Default: `false`
+     */
     hidden?: boolean;
-    /** sets if the automation is readonly */
+    /**
+     * Whether the automation is read-only.
+     * Default: `false`
+     */
     readonly?: boolean;
-    /** sets if deleting the automation is disabled */
+    /**
+     * Whether the option to delete the automation from the site is disabled.
+     * Default: `false`
+     */
     disableDelete?: boolean;
-    /** sets if changing the automation status is disabled (from active to inactive and vice versa) */
+    /**
+     * Whether the option to change the automation status (from active to inactive and vice versa) is disabled.
+     * Default: `false`
+     */
     disableStatusChange?: boolean;
-    /** Automation's action settings */
+    /** Automation action settings. */
     actionSettings?: ActionSettings$1;
 }
 interface ActivationStatus {
@@ -3514,7 +3457,6 @@ declare namespace context$1 {
   export { type Action$1 as Action, type context$1_ActionActionOneOf as ActionActionOneOf, type context$1_ActionCompletedRequest as ActionCompletedRequest, type context$1_ActionData as ActionData, type ActionEvent$1 as ActionEvent, type ActionSettings$1 as ActionSettings, type context$1_ActionStatus as ActionStatus, type context$1_ActionsData as ActionsData, type context$1_Activation as Activation, type context$1_ActivationActionStatusChanged as ActivationActionStatusChanged, context$1_ActivationActionStatusChangedStatus as ActivationActionStatusChangedStatus, type context$1_ActivationActionStatusChangedStatusInfoOneOf as ActivationActionStatusChangedStatusInfoOneOf, type context$1_ActivationContinuedAfterSchedule as ActivationContinuedAfterSchedule, type context$1_ActivationRequest as ActivationRequest, type context$1_ActivationResumeAfterDelay as ActivationResumeAfterDelay, type context$1_ActivationScheduleCompleted as ActivationScheduleCompleted, type context$1_ActivationScheduleRequested as ActivationScheduleRequested, type context$1_ActivationSource as ActivationSource, type context$1_ActivationSourceOfOneOf as ActivationSourceOfOneOf, type context$1_ActivationStatus as ActivationStatus, type context$1_ActivationStatusChanged as ActivationStatusChanged, type context$1_ActivationStatusChangedEnvelope as ActivationStatusChangedEnvelope, type context$1_ActivationStatusChangedFailedStatusInfo as ActivationStatusChangedFailedStatusInfo, context$1_ActivationStatusChangedStatus as ActivationStatusChangedStatus, type context$1_ActivationStatusChangedStatusInfoOneOf as ActivationStatusChangedStatusInfoOneOf, type AppDefinedAction$1 as AppDefinedAction, type context$1_AppDefinedActionInfo as AppDefinedActionInfo, type ApplicationError$1 as ApplicationError, type ApplicationOrigin$1 as ApplicationOrigin, type context$1_AsyncAction as AsyncAction, type AuditInfo$1 as AuditInfo, type AuditInfoIdOneOf$1 as AuditInfoIdOneOf, type Automation$1 as Automation, type AutomationConfiguration$1 as AutomationConfiguration, type context$1_AutomationConfigurationAction as AutomationConfigurationAction, type context$1_AutomationConfigurationActionInfoOneOf as AutomationConfigurationActionInfoOneOf, context$1_AutomationConfigurationStatus as AutomationConfigurationStatus, type context$1_AutomationIdentifier as AutomationIdentifier, type context$1_AutomationInfo as AutomationInfo, type context$1_AutomationInfoOriginInfoOneOf as AutomationInfoOriginInfoOneOf, type AutomationOriginInfoOneOf$1 as AutomationOriginInfoOneOf, type AutomationSettings$1 as AutomationSettings, type BaseEventMetadata$1 as BaseEventMetadata, type context$1_BatchActivationRequest as BatchActivationRequest, context$1_BlockType as BlockType, type BulkActionMetadata$1 as BulkActionMetadata, type context$1_BulkCancelEventRequest as BulkCancelEventRequest, type context$1_BulkCancelEventResponse as BulkCancelEventResponse, type context$1_BulkCancelEventResponseNonNullableFields as BulkCancelEventResponseNonNullableFields, type context$1_BulkCancelEventResult as BulkCancelEventResult, type context$1_BulkReportEventRequest as BulkReportEventRequest, type context$1_BulkReportEventResponse as BulkReportEventResponse, type context$1_BulkReportEventResponseNonNullableFields as BulkReportEventResponseNonNullableFields, type context$1_BulkReportEventResult as BulkReportEventResult, type context$1_CancelEventRequest as CancelEventRequest, type context$1_CancelEventResponse as CancelEventResponse, type context$1_CancelPendingScheduleRequest as CancelPendingScheduleRequest, type context$1_CancelPendingScheduleRequestByOneOf as CancelPendingScheduleRequestByOneOf, type context$1_CancelPendingScheduleResponse as CancelPendingScheduleResponse, context$1_CancellationReason as CancellationReason, type context$1_CancelledStatusInfo as CancelledStatusInfo, type context$1_Case as Case, type ConditionAction$1 as ConditionAction, type context$1_ConditionActionInfo as ConditionActionInfo, type context$1_ConditionBlock as ConditionBlock, type ConditionExpressionGroup$1 as ConditionExpressionGroup, type context$1_ConditionFilter as ConditionFilter, type context$1_Delay as Delay, type DelayAction$1 as DelayAction, type context$1_DelayActionInfo as DelayActionInfo, type context$1_DelayHelper as DelayHelper, type context$1_DelayOfOneOf as DelayOfOneOf, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type DraftOrigin$1 as DraftOrigin, type Empty$1 as Empty, type context$1_EndedStatusInfo as EndedStatusInfo, type context$1_EndedStatusInfoTypeInfoOneOf as EndedStatusInfoTypeInfoOneOf, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type context$1_EventInfo as EventInfo, type EventMetadata$1 as EventMetadata, type context$1_ExecuteFromActionRequest as ExecuteFromActionRequest, type context$1_ExecuteFromActionResponse as ExecuteFromActionResponse, type context$1_ExpressionEvaluationResult as ExpressionEvaluationResult, type context$1_FailedStatusInfo as FailedStatusInfo, type context$1_File as File, type Filter$1 as Filter, type FutureDateActivationOffset$1 as FutureDateActivationOffset, type context$1_Idempotency as Idempotency, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, context$1_IdentifierType as IdentifierType, type context$1_Identity as Identity, type context$1_IfFilter as IfFilter, type context$1_InitiatedStatusInfo as InitiatedStatusInfo, type context$1_InternalTarget as InternalTarget, type ItemMetadata$1 as ItemMetadata, type MessageEnvelope$1 as MessageEnvelope, Operator$1 as Operator, Origin$1 as Origin, type context$1_Output as Output, type OutputAction$1 as OutputAction, type context$1_PreinstalledIdentifier as PreinstalledIdentifier, type PreinstalledOrigin$1 as PreinstalledOrigin, type RateLimit$1 as RateLimit, type RateLimitAction$1 as RateLimitAction, type context$1_RateLimitActionInfo as RateLimitActionInfo, type context$1_RateLimiting as RateLimiting, type context$1_RefreshPayloadRequest as RefreshPayloadRequest, type context$1_RefreshPayloadResponse as RefreshPayloadResponse, type context$1_ReportDomainEventRequest as ReportDomainEventRequest, type context$1_ReportDomainEventResponse as ReportDomainEventResponse, type context$1_ReportEventOptions as ReportEventOptions, type context$1_ReportEventRequest as ReportEventRequest, type context$1_ReportEventResponse as ReportEventResponse, type context$1_ReportEventResponseNonNullableFields as ReportEventResponseNonNullableFields, type RestoreInfo$1 as RestoreInfo, type context$1_RunAutomationRequest as RunAutomationRequest, type context$1_RunAutomationResponse as RunAutomationResponse, type context$1_Runtime as Runtime, type context$1_Schedule as Schedule, type context$1_ScheduleRequest as ScheduleRequest, type context$1_ScheduleResponse as ScheduleResponse, context$1_ScheduleStatus as ScheduleStatus, type context$1_ScheduledAction as ScheduledAction, type context$1_ScheduledStatusInfo as ScheduledStatusInfo, type context$1_Scheduler as Scheduler, type context$1_Service as Service, type context$1_ServiceMapping as ServiceMapping, type context$1_SimpleDelay as SimpleDelay, type context$1_SpiAction as SpiAction, type context$1_StartedStatusInfo as StartedStatusInfo, type context$1_StartedStatusInfoAppDefinedActionInfo as StartedStatusInfoAppDefinedActionInfo, type context$1_StartedStatusInfoTypeInfoOneOf as StartedStatusInfoTypeInfoOneOf, Status$1 as Status, type context$1_SwitchFilter as SwitchFilter, type context$1_SystemHelper as SystemHelper, type context$1_SystemHelperHelperOneOf as SystemHelperHelperOneOf, context$1_Target as Target, context$1_TargetType as TargetType, TimeUnit$1 as TimeUnit, type Trigger$1 as Trigger, type context$1_TriggerInfo as TriggerInfo, Type$1 as Type, context$1_Units as Units, type context$1_UnprocessedTargetEvent as UnprocessedTargetEvent, type context$1_UpdatePendingSchedulesPayloadRequest as UpdatePendingSchedulesPayloadRequest, type context$1_UpdatePendingSchedulesPayloadResponse as UpdatePendingSchedulesPayloadResponse, type context$1_V1RunAutomationRequest as V1RunAutomationRequest, type context$1_V1RunAutomationRequestIdentifierOneOf as V1RunAutomationRequestIdentifierOneOf, type context$1_V1RunAutomationResponse as V1RunAutomationResponse, WebhookIdentityType$1 as WebhookIdentityType, type context$1__publicBulkCancelEventType as _publicBulkCancelEventType, type context$1__publicBulkReportEventType as _publicBulkReportEventType, type context$1__publicCancelEventType as _publicCancelEventType, type context$1__publicOnActivationStatusChangedType as _publicOnActivationStatusChangedType, type context$1__publicReportEventType as _publicReportEventType, context$1_bulkCancelEvent as bulkCancelEvent, context$1_bulkReportEvent as bulkReportEvent, context$1_cancelEvent as cancelEvent, context$1_onActivationStatusChanged as onActivationStatusChanged, onActivationStatusChanged$1 as publicOnActivationStatusChanged, context$1_reportEvent as reportEvent };
 }
 
-/** Automation */
 interface Automation extends AutomationOriginInfoOneOf {
     /** Application info */
     applicationInfo?: ApplicationOrigin;
@@ -3528,43 +3470,43 @@ interface Automation extends AutomationOriginInfoOneOf {
      */
     _id?: string | null;
     /**
-     * Revision number, which increments by 1 each time the Automation is updated.
+     * Revision number, which increments by 1 each time the automation is updated.
      * To prevent conflicting changes,
-     * the current revision must be passed when updating the Automation.
+     * the current revision must be passed when updating the automation.
      *
-     * Ignored when creating an Automation.
+     * Ignored when creating an automation.
      * @readonly
      */
     revision?: string | null;
     /**
-     * information about the creator of the automation
+     * Information about the creator of the automation.
      * @readonly
      */
     createdBy?: AuditInfo;
     /**
-     * Date and time the Automation was created.
+     * Date and time the automation was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * information about who updated of the automation
+     * The entity that last updated the automation.
      * @readonly
      */
     updatedBy?: AuditInfo;
     /**
-     * Date and time the Automation was last updated.
+     * Date and time the automation was last updated.
      * @readonly
      */
     _updatedDate?: Date;
-    /** Automation name */
+    /** Automation name that is displayed on the user's site. */
     name?: string;
-    /** Automation description */
+    /** Automation description. */
     description?: string | null;
-    /** Automation runtime configuration */
+    /** Object that defines the automation's trigger, actions, and activation status. */
     configuration?: AutomationConfiguration;
-    /** Origin type */
+    /** Defines how the automation was added to the site. */
     origin?: Origin;
-    /** Automation settings */
+    /** Automation settings. */
     settings?: AutomationSettings;
 }
 /** @oneof */
@@ -3577,39 +3519,45 @@ interface AutomationOriginInfoOneOf {
     draftInfo?: DraftOrigin;
 }
 interface ActionSettings {
-    /** list of permanent action ids of actions that cannot be deleted (default - empty, all actions are deletable by default) */
+    /**
+     * List of actions that cannot be deleted.
+     * Default: Empty. All actions are deletable by default.
+     */
     permanentActionIds?: string[];
-    /** list of readonly action ids, (default - empty, all actions are editable by default) */
+    /**
+     * List of actions that cannot be edited.
+     * Default: Empty. All actions are editable by default.
+     */
     readonlyActionIds?: string[];
-    /** sets if adding a delay action is disabled for this automation */
+    /** Whether the option to add a delay is disabled for the automation. */
     disableDelayAddition?: boolean;
-    /** sets if adding a condition action is disabled for this automation */
+    /** Whether the option to add a condition is disabled for the automation. */
     disableConditionAddition?: boolean;
 }
 interface AuditInfo extends AuditInfoIdOneOf {
-    /** user identifier */
+    /** User ID. */
     userId?: string;
-    /** application identifier */
+    /** Application ID. */
     appId?: string;
 }
 /** @oneof */
 interface AuditInfoIdOneOf {
-    /** user identifier */
+    /** User ID. */
     userId?: string;
-    /** application identifier */
+    /** Application ID. */
     appId?: string;
 }
 /** Automation runtime configuration */
 interface AutomationConfiguration {
-    /** Automation's Status */
+    /** Status of the automation on the site. */
     status?: Status;
-    /** Trigger configuration */
+    /** Automation trigger configuration. */
     trigger?: Trigger;
-    /** actions that run in parallel after the trigger */
+    /** List of IDs of root actions. Root actions are the first actions to run after the trigger. The actions in the list run in parallel. */
     rootActionIds?: string[];
     /**
-     * map of all actions by actionId
-     * The key is the actionId of the action, and the value is the action configuration
+     * Map of all actions that the automation may execute.
+     * The key is the action ID, and the value is the action configuration.
      */
     actions?: Record<string, Action>;
 }
@@ -3622,51 +3570,36 @@ declare enum TimeUnit {
     MONTHS = "MONTHS"
 }
 interface Filter {
-    /** the filter identifier */
+    /** Filter ID. */
     _id?: string;
-    /** the field key from the schema, for example "formId" */
+    /** Field key from the payload schema, for example "formId". */
     fieldKey?: string;
-    /** filter expression that evaluates to a boolean, for example - {{ contains(["guid1","guid2"];formId) }} */
+    /** Filter expression that evaluates to a boolean. */
     filterExpression?: string;
 }
 interface FutureDateActivationOffset {
     /**
-     * expression of offset before the trigger's time (in selected time unit), when the Automation should run
-     * only allows negative offset from the trigger's date (before the trigger), positive offset should be achieved via offset delay action
-     * preScheduledEventOffsetExpression: "{{5}}" + timeUnit: Days -  to run the Automation 5 days before the trigger's date
-     * or, preScheduledEventOffsetExpression: "{{ someNumberField }}" + timeUnit: Minutes, to run the Automation someNumberField's value in minutes before the trigger's date
+     * The offset value. The value is always taken as negative, so that the automation runs before the trigger date.
+     * To create an offset that causes the automation to run after the trigger date, use a delay action.
      */
     preScheduledEventOffsetExpression?: string;
-    /** Time unit for the scheduled event offset */
+    /** Time unit for the scheduled event offset. */
     scheduledEventOffsetTimeUnit?: TimeUnit;
 }
 interface RateLimit {
-    /**
-     * Maximum number of activations expression. the expression will need to be parsed to Int on runtime
-     * for example - "{{ 1 }}" to set max activations to 1, or "{{ var(someNumberField) }}" to set max activations as the value of "someNumberField" from the payload
-     */
+    /** Value expressing the maximum number of times the trigger can be activated. */
     maxActivationsExpression?: string;
-    /**
-     * Duration of the rate limiting window (in selected time unit) expression for rate limiter, if empty then no time limit. the expression will need to be parsed to Int on runtime
-     * for example - "{{ 10 }}" to set timeframe to be 10 minutes, or {{ var(someNumberField) }} to set timeframe in minutes as the value of "someNumberField" from the payload
-     */
+    /** Duration of the rate limiting window in the selected time unit. If no value is set, the rate limit is permanent. */
     durationExpression?: string | null;
-    /** Time unit for the rate limit duration */
+    /** Time unit for the rate limit duration. */
     durationTimeUnit?: TimeUnit;
-    /**
-     * Unique identifier of each activation by which rate limiter will count activations, expected return type is string
-     * for example - {{ var(contact.id) }} to set the unique identifier as the value of "contact.id" from the payload
-     * evaluated expression must be under 46 characters
-     */
+    /** Unique identifier of each activation, by which rate limiter will count activations. */
     uniqueIdentifierExpression?: string | null;
 }
 interface ConditionExpressionGroup {
-    /** expression group operator */
+    /** Expression group operator. */
     operator?: Operator;
-    /**
-     * list of boolean expressions to be evaluated with the given operator
-     * examples - {{ true }}, {{ someBooleanField }}, {{ contains(["guid1...","guid2..."];formId) }}
-     */
+    /** List of boolean expressions to be evaluated with the given operator. */
     booleanExpressions?: string[];
 }
 declare enum Operator {
@@ -3689,86 +3622,60 @@ declare enum Type {
     OUTPUT = "OUTPUT"
 }
 interface AppDefinedAction {
-    /** Action app id */
+    /** ID of the app that defines the action. */
     appId?: string;
-    /** Action key */
+    /** Action key. */
     actionKey?: string;
-    /**
-     * Action input mapping, example:
-     * {
-     * "to": "{{ var(contact.email) }}",
-     * "subject": "Your registration to {{ var(eventName) }} is Confirmed",
-     * "body": "Hi {{ var(contact.name) }}, you are confirmed for the event"
-     * }
-     */
+    /** Action input mapping. */
     inputMapping?: Record<string, any> | null;
     /**
-     * optional skip condition configuration - if this action should be skipped when the automation runs (following actions of a skipped action will still run)
-     * the action will be skipped if either of the expression groups evaluate to `true`
-     * the relation between the expression groups is an OR relation.
+     * Array of conditions determining whether to skip the action in the automation flow.
+     * The action will be skipped if any of the expression groups evaluate to `true`.
+     * Actions following a skipped action will still run.
      */
     skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
-    /** actions to run in parallel after this action finishes */
+    /** List of IDs of actions to run in parallel once the action completes. */
     postActionIds?: string[];
 }
 interface ConditionAction {
-    /**
-     * the condition evaluates to `true` if either of the expression groups evaluate to `true`
-     * the relation between the expression groups is an OR relation.
-     */
+    /** The condition evaluates to `true` if either of the expression groups evaluate to `true`. */
     orExpressionGroups?: ConditionExpressionGroup[];
-    /** actions to run when the entire condition is evaluated to `true` */
+    /** List of IDs of actions to run when the entire condition is evaluated to `true`. */
     truePostActionIds?: string[];
-    /** actions to run when the entire condition is evaluated to `false` */
+    /** List of IDs of actions to run when the entire condition is evaluated to `false`. */
     falsePostActionIds?: string[];
 }
 interface DelayAction {
-    /**
-     * optional - expression for amount of time to wait (in selected time unit) - from a specific date or from the time the action is executed
-     * offsetExpression: "{{5}}" + timeUnit: Days -  to wait for 5 days from the time the delay was invoked
-     * or, offsetExpression: "{{5}}" + timeUnit: Days + dueDateEpochExpression: "{{someDateField}}" -  to wait for 5 days from the time date in "someDateField" field in the payload
-     * or, offsetExpression: "{{ someNumberField }}" + timeUnit: Minutes,  to wait for someNumberField's value in minutes
-     */
+    /** Value expressing the amount of time to wait from a specific date or from the time the action is executed. */
     offsetExpression?: string | null;
-    /** Time unit for delay offset */
+    /** Time unit for delay offset. */
     offsetTimeUnit?: TimeUnit;
     /**
-     * optional - expression of the due date to wait until, if an offset was defined, it will be calculated from this date
-     * number of milliseconds since the Unix Epoch (1 January, 1970 UTC)
-     * for example - "{{ 18238348023423 }}", or "{{ someEpochFromPayloadField }}" / "{{ contact.birthdate }}"
+     * The action due date. If defined without an offset, the automation will wait until this date to execute the next step.
+     * If an offset is defined, it's calculated from this date.
+     * The date is expressed in the number of milliseconds since the Unix Epoch (1 January, 1970 UTC).
      */
     dueDateEpochExpression?: string | null;
-    /** actions to run in parallel after this action finishes */
+    /** List of IDs of actions to run in parallel after the delay. */
     postActionIds?: string[];
 }
 interface RateLimitAction {
-    /**
-     * Maximum number of activations expression. the expression will need to be parsed to Int on runtime
-     * for example - "{{ 1 }}" to set max activations to 1, or "{{ var(someNumberField) }}" to set max activations as the value of "someNumberField" from the payload
-     */
+    /** The maximum number of activations allowed for the action. */
     maxActivationsExpression?: string;
     /**
-     * Duration of the rate limiting window (in selected time unit) expression for rate limiter, if empty then no time limit. the expression will need to be parsed to Int on runtime
-     * for example - "{{ 10 }}" to set timeframe to be 10 minutes, or {{ var(someNumberField) }} to set timeframe in minutes as the value of "someNumberField" from the payload
+     * Duration of the rate limiting window, expressed in selected time unit.
+     * If no value is set, then there is no time limit on the rate limiter.
      */
     rateLimitDurationExpression?: string | null;
-    /** Time unit for the rate limit duration */
+    /** Time unit for the rate limit duration. */
     rateLimitDurationTimeUnit?: TimeUnit;
-    /**
-     * Unique identifier of each activation by which rate limiter will count activations, expected return type is string
-     * for example - {{ var(contact.id) }} to set the unique identifier as the value of "contact.id" from the payload
-     */
+    /** Unique identifier of each activation by which rate limiter counts activations. */
     uniqueIdentifierExpression?: string | null;
-    /** actions to run in parallel after this action finishes */
+    /** List of IDs of actions to run in parallel once the action completes. */
     postActionIds?: string[];
 }
 interface OutputAction {
-    /**
-     * Output action output mapping
-     * {
-     * "to": "{{ var(contact.email) }}"
-     * }
-     */
+    /** Output action output mapping. */
     outputMapping?: Record<string, any> | null;
 }
 declare enum Status {
@@ -3780,89 +3687,52 @@ declare enum Status {
     INACTIVE = "INACTIVE"
 }
 interface Trigger {
-    /** Trigger Application id */
+    /** ID of the app that defines the trigger. */
     appId?: string;
-    /** Trigger key */
+    /** Trigger key. */
     triggerKey?: string;
     /**
-     * optional - list of filters on schema fields
-     * the relation between the filter expressions is an AND relation.
-     * all filter expressions must be evaluated to `true` for a given payload in order for the automation to be executed
+     * List of filters on schema fields.
+     * In order for the automation to run, all filter expressions must evaluate to `true` for a given payload.
      */
     filters?: Filter[];
-    /** optional - future date trigger activation offset */
+    /** Defines the time offset between the trigger date and when the automation runs. */
     scheduledEventOffset?: FutureDateActivationOffset;
-    /** optional - rate limiting configuration */
+    /** Limits the number of times an automation can be triggered. */
     rateLimit?: RateLimit;
     automationConfigMapping?: Record<string, any> | null;
 }
 interface Action extends ActionInfoOneOf {
-    /** App defined Action (via RPC, HTTP or Velo) */
+    /** Action defined by an app (via RPC, HTTP or Velo). */
     appDefinedInfo?: AppDefinedAction;
-    /** Condition action */
+    /** Condition action. */
     conditionInfo?: ConditionAction;
-    /** Delay action */
+    /** Delay action. */
     delayInfo?: DelayAction;
-    /** Rate limiting action */
+    /** Rate-limiting action. */
     rateLimitInfo?: RateLimitAction;
-    /** Action id, if not specified, will be generated */
+    /** Action ID. If not specified, a new ID is generated. */
     _id?: string | null;
-    /** Type of the action */
+    /** Action type. */
     type?: Type;
     /**
-     * Human readable name for the action (may only contain alphanumeric characters and underscores) to differentiate from other actions of the same kind.
-     * if the action has output, the output will be available in the payload under this name, otherwise it will be concatenated to the payload as is
-     * without namespaces (or in case of exact same namespaces), if the user has multiple actions of the same kind (appId+actionKey), the output will be overwritten.
-     *
-     * for example, given:
-     * - if the action output looks like this - { "message": "hello" }
-     * - the namespace is "action_1"
-     * - the trigger payload looks like this - { "someField": "50", "someBoolean": true }
-     *
-     * the payload will look like this:
-     * {
-     * "someField": "50",
-     * "someBoolean": true,
-     * "action_1": {
-     * "message": "hello"
-     * }
-     * }
-     *
-     * given the following Automation configuration:
-     *
-     * (Trigger A)
-     * |
-     * (Action B) // namespace = "action_b_1"
-     * |
-     * (Action B) // namespace = "action_b_2"
-     * |
-     * (Action C)
-     *
-     *
-     * the available fields that Action C will be able to use to map to it's input fields will be:
-     * {
-     * "someField": "50",
-     * "someBoolean": true,
-     * "action_b_1": {
-     * "message": "hello"
-     * },
-     * "action_b_2": {
-     * "message": "hello"
-     * }
-     * }
-     * so the user can select which specific action output to use (action_b_1.message or action_b_2.message, in the case above)
+     * Human-readable name to differentiate the action from other actions of the same type.
+     * The name can contain only alphanumeric characters and underscores. If not provided, a namespace in the form `actionkey-indexOfAction` is
+     * generated automatically.
+     * If the action has output, the output will be available in the payload under this name.
+     * If the user has multiple actions with the same appId and actionKey, previous action output will be overwritten.
      */
     namespace?: string | null;
 }
 /** @oneof */
 interface ActionInfoOneOf {
-    /** App defined Action (via RPC, HTTP or Velo) */
+    /** Action defined by an app (via RPC, HTTP or Velo). */
     appDefinedInfo?: AppDefinedAction;
-    /** Condition action */
+    /** Condition action. */
     conditionInfo?: ConditionAction;
-    /** Delay action */
+    /** Delay action. */
     delayInfo?: DelayAction;
-    /** Rate limiting action */
+    /** Rate-limiting action. */
     rateLimitInfo?: RateLimitAction;
 }
 declare enum Origin {
@@ -3878,18 +3748,22 @@ declare enum Origin {
     DRAFT = "DRAFT"
 }
 interface ApplicationOrigin {
-    /** identifier for the application */
+    /** Application ID. */
     appId?: string;
 }
 interface PreinstalledOrigin {
-    /** identifier for the application */
+    /** ID of the app that defines the preinstalled automation. */
     appId?: string;
-    /** application component ID */
+    /** Application component ID. */
     componentId?: string;
-    /** application component Version */
+    /** Application component version. */
     componentVersion?: number;
     /**
-     * is this a user modified preinstalled automation (on a specific site) or the original one
+     * Whether the automation is an override automation. If the user modifies the preinstalled automation installed on their site, a site-specific
+     * automation is created that overrides the original one. If the user makes no modifications this boolean is set to `false` and the original
+     * preinstalled automation is used.
+     *
+     * Default: `false`
      * @readonly
      */
     override?: boolean | null;
@@ -3899,25 +3773,37 @@ interface DraftOrigin {
     parentId?: string | null;
 }
 interface AutomationSettings {
-    /** sets if the automation is hidden from users */
+    /**
+     * Whether the automation is hidden from users.
+     * Default: `false`
+     */
     hidden?: boolean;
-    /** sets if the automation is readonly */
+    /**
+     * Whether the automation is read-only.
+     * Default: `false`
+     */
     readonly?: boolean;
-    /** sets if deleting the automation is disabled */
+    /**
+     * Whether the option to delete the automation from the site is disabled.
+     * Default: `false`
+     */
     disableDelete?: boolean;
-    /** sets if changing the automation status is disabled (from active to inactive and vice versa) */
+    /**
+     * Whether the option to change the automation status (from active to inactive and vice versa) is disabled.
+     * Default: `false`
+     */
     disableStatusChange?: boolean;
-    /** Automation's action settings */
+    /** Automation action settings. */
     actionSettings?: ActionSettings;
 }
 interface GetAutomationRevisionRequest {
-    /** Automation ID */
+    /** Automation ID. */
     automationId?: string;
-    /** Automation revision */
+    /** Automation revision. */
     revision?: string | null;
 }
 interface GetAutomationRevisionResponse {
-    /** Automation with the relevant revision */
+    /** Automation with the relevant revision. */
     automation?: Automation;
 }
 interface CreateAutomationRequest {
@@ -3925,25 +3811,25 @@ interface CreateAutomationRequest {
     automation: Automation;
 }
 interface CreateAutomationResponse {
-    /** The created Automation. */
+    /** The created automation. */
     automation?: Automation;
 }
 interface GetAutomationRequest {
-    /** ID of the Automation to retrieve. */
+    /** Automation ID. */
     automationId: string;
-    /** Automation Origin */
+    /** Automation origin. */
     origin?: Origin;
 }
 interface GetAutomationResponse {
-    /** The requested Automation. */
+    /** The requested automation. */
     automation?: Automation;
 }
 interface UpdateAutomationRequest {
-    /** Automation to be updated, may be partial. */
+    /** Automation to update. */
     automation: Automation;
 }
 interface UpdateAutomationResponse {
-    /** Updated Automation. */
+    /** Updated automation. */
     automation?: Automation;
 }
 interface UpdatedWithPreviousEntity {
@@ -3953,7 +3839,7 @@ interface UpdatedWithPreviousEntity {
     currentAutomation?: Automation;
 }
 interface DeleteAutomationRequest {
-    /** Id of the Automation to delete. */
+    /** Automation ID. */
     automationId: string;
 }
 interface DeleteAutomationResponse {
@@ -3963,17 +3849,17 @@ interface DeletedWithEntity {
     automation?: Automation;
 }
 interface BulkDeleteAutomationsRequest {
-    /** Automation IDs to delete */
+    /** Automation IDs to delete. */
     automationIds: string[];
 }
 interface BulkDeleteAutomationsResponse {
-    /** bulk delete results */
+    /** Deleted automations results. */
     results?: BulkDeleteResult[];
-    /** bulk delete metadata */
+    /** Metadata for the API call. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkDeleteResult {
-    /** bulk delete item metadata */
+    /** Metadata for the item deletion. */
     itemMetadata?: ItemMetadata;
 }
 interface ItemMetadata {
@@ -4003,17 +3889,20 @@ interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 interface CreatePreinstalledAutomationRequest {
-    /** Automation to be created. */
+    /** Preinstalled automation to be created. */
     automation?: Automation;
 }
 interface CreatePreinstalledAutomationResponse {
-    /** The created Automation. */
+    /** The created preinstalled automation. */
     automation?: Automation;
 }
 interface DeletePreinstalledAutomationRequest {
-    /** Id of the Automation to delete. */
+    /** Automation ID. */
     automationId?: string;
-    /** Should ignore override check (default: false) */
+    /**
+     * Whether to ignore the override check.
+     * Default: `false`
+     */
     ignoreOverrideCheck?: boolean;
 }
 interface DeletePreinstalledAutomationResponse {
@@ -4067,9 +3956,9 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface QueryAutomationsResponse {
-    /** List of Automations. */
+    /** List of automations. */
     automations?: Automation[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -4164,13 +4053,13 @@ interface ActionEvent {
 interface Empty {
 }
 interface CopyAutomationRequest {
-    /** ID of the Automation to copy */
+    /** Automation ID. */
     automationId?: string;
-    /** Automation Origin */
+    /** Automation origin. */
     origin?: Origin;
 }
 interface CopyAutomationResponse {
-    /** New automation */
+    /** Automation copy. */
     automation?: Automation;
 }
 interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
@@ -4445,42 +4334,47 @@ interface StudioAssigned {
 interface StudioUnassigned {
 }
 interface ValidateAutomationRequest {
-    /** Automation to validate */
+    /** Automation to validate. */
     automation: Automation;
-    /** optional validation settings */
+    /** Settings to customize the validation. */
     validationSettings?: ValidationSettings;
 }
 interface ValidationSettings {
     /**
-     * specific actions to include in the validation
-     * if non empty - only the specific actions would be validated (trigger excluded)
-     * if empty, the entire automation will be validated (trigger included)
+     * List of specific actions to validate. Only the actions in the list are validated. In this case, triggers are not validated.
+     *
+     * If the list is empty, the entire automation is validated, including triggers.
+     *
+     * Default: Empty.
      */
     actionIds?: string[];
-    /** whether or not to skip provider validations (default: false) */
+    /**
+     * Whether to skip provider validations.
+     * Default: `false`
+     */
     skipProviderValidations?: boolean;
 }
 interface ValidateAutomationResponse {
-    /** is the Automation valid */
+    /** Whether the automation is valid. */
     valid?: boolean;
-    /** list of validation errors for the automation Trigger */
+    /** List of validation errors for the automation trigger. */
     triggerValidationErrors?: TriggerValidationError[];
-    /** list of validation information for the automation Actions */
+    /** List of validation information for the automation actions. */
     actionValidationInfo?: ActionValidationInfo[];
 }
 interface TriggerValidationError extends TriggerValidationErrorErrorOneOf {
-    /** trigger configuration error */
+    /** Trigger configuration error. */
     configurationError?: TriggerConfigurationError;
-    /** provider configuration error */
+    /** Provider configuration error. */
     providerConfigurationError?: ProviderConfigurationError;
-    /** validation error type */
+    /** Validation error type. */
     errorType?: TriggerValidationErrorValidationErrorType;
 }
 /** @oneof */
 interface TriggerValidationErrorErrorOneOf {
-    /** trigger configuration error */
+    /** Trigger configuration error. */
     configurationError?: TriggerConfigurationError;
-    /** provider configuration error */
+    /** Provider configuration error. */
     providerConfigurationError?: ProviderConfigurationError;
 }
 declare enum TriggerValidationErrorValidationErrorType {
@@ -4489,9 +4383,9 @@ declare enum TriggerValidationErrorValidationErrorType {
     PROVIDER_ERROR = "PROVIDER_ERROR"
 }
 interface TriggerConfigurationError {
-    /** trigger error type */
+    /** Trigger error type. */
     errorType?: TriggerErrorType;
-    /** optional - related filter field key */
+    /** Related filter field key. */
     filterFieldKey?: string | null;
 }
 declare enum TriggerErrorType {
@@ -4517,28 +4411,28 @@ interface ProviderConfigurationError {
     title?: string;
 }
 interface ActionValidationInfo {
-    /** the id of the action in the automation */
+    /** Action ID. */
     actionId?: string | null;
-    /** the id of the app defining the action */
+    /** ID of the app that defines the action. */
     appId?: string;
-    /** human readable identifier of the action per app */
+    /** Human-readable action identifier. */
     actionKey?: string;
-    /** list of action validation errors */
+    /** List of action validation errors. */
     validationErrors?: ActionValidationError[];
 }
 interface ActionValidationError extends ActionValidationErrorErrorOneOf {
-    /** action configuration error */
+    /** Action configuration error. */
     configurationError?: ActionConfigurationError;
-    /** provider configuration error */
+    /** Provider configuration error. */
     providerConfigurationError?: ProviderConfigurationError;
-    /** validation error type */
+    /** Validation error type. */
     errorType?: ValidationErrorType;
 }
 /** @oneof */
 interface ActionValidationErrorErrorOneOf {
-    /** action configuration error */
+    /** Action configuration error. */
     configurationError?: ActionConfigurationError;
-    /** provider configuration error */
+    /** Provider configuration error. */
     providerConfigurationError?: ProviderConfigurationError;
 }
 declare enum ValidationErrorType {
@@ -4547,9 +4441,9 @@ declare enum ValidationErrorType {
     PROVIDER_ERROR = "PROVIDER_ERROR"
 }
 interface ActionConfigurationError {
-    /** action error type */
+    /** Action error type. */
     errorType?: ActionErrorType;
-    /** optional - related field key */
+    /** Related field key. */
     fieldKey?: string | null;
 }
 declare enum ActionErrorType {
@@ -4572,21 +4466,21 @@ interface GetAutomationActionSchemaRequest {
     actionId?: string;
 }
 interface GetAutomationActionSchemaResponse {
-    /** The accumulated payload schema for action */
+    /** The accumulated payload schema for an action. */
     schema?: Record<string, any> | null;
 }
 interface GetActionsQuotaInfoRequest {
 }
 interface GetActionsQuotaInfoResponse {
-    /** list of action quota information */
+    /** List of action quotas. */
     actionProviderQuotaInfo?: ActionProviderQuotaInfo[];
 }
 interface ActionProviderQuotaInfo {
-    /** action app id */
+    /** ID of the app that defines the action. */
     appId?: string;
-    /** the action key */
+    /** Action key. */
     actionKey?: string;
-    /** the action quota information */
+    /** Action quota information. */
     actionQuotaInfo?: ActionQuotaInfo;
 }
 interface ActionQuotaInfo {
@@ -4888,7 +4782,7 @@ interface AutomationDeletedWithEntityEnvelope {
     metadata: EventMetadata;
 }
 interface GetAutomationOptions {
-    /** Automation Origin */
+    /** Automation origin. */
     origin?: Origin;
 }
 interface UpdateAutomation {
@@ -4904,43 +4798,43 @@ interface UpdateAutomation {
      */
     _id?: string | null;
     /**
-     * Revision number, which increments by 1 each time the Automation is updated.
+     * Revision number, which increments by 1 each time the automation is updated.
      * To prevent conflicting changes,
-     * the current revision must be passed when updating the Automation.
+     * the current revision must be passed when updating the automation.
      *
-     * Ignored when creating an Automation.
+     * Ignored when creating an automation.
      * @readonly
      */
     revision?: string | null;
     /**
-     * information about the creator of the automation
+     * Information about the creator of the automation.
      * @readonly
      */
     createdBy?: AuditInfo;
     /**
-     * Date and time the Automation was created.
+     * Date and time the automation was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * information about who updated of the automation
+     * The entity that last updated the automation.
      * @readonly
      */
     updatedBy?: AuditInfo;
     /**
-     * Date and time the Automation was last updated.
+     * Date and time the automation was last updated.
      * @readonly
      */
     _updatedDate?: Date;
-    /** Automation name */
+    /** Automation name that is displayed on the user's site. */
     name?: string;
-    /** Automation description */
+    /** Automation description. */
     description?: string | null;
-    /** Automation runtime configuration */
+    /** Object that defines the automation's trigger, actions, and activation status. */
     configuration?: AutomationConfiguration;
-    /** Origin type */
+    /** Defines how the automation was added to the site. */
     origin?: Origin;
-    /** Automation settings */
+    /** Automation settings. */
     settings?: AutomationSettings;
 }
 interface QueryCursorResult {
@@ -5006,7 +4900,7 @@ interface AutomationsQueryBuilder {
     find: () => Promise<AutomationsQueryResult>;
 }
 interface ValidateAutomationOptions {
-    /** optional validation settings */
+    /** Settings to customize the validation. */
     validationSettings?: ValidationSettings;
 }