@wix/auto_sdk_automations_activation-log 1.0.32 → 1.0.34

package/build/es/index.typings.d.mts

@@ -36,6 +36,14 @@ interface ActivationLog {
     warnings?: Warning[];
     /** Created date */
     _createdDate?: Date | null;
+    /**
+     * Activation Initiation Source information
+     * Tracks whether activation was triggered by an event (TRIGGER_PROVIDER_EVENT)
+     * or manually activated (MANUAL_ACTIVATION). Test mode activations (test_mode=true)
+     * are excluded from activation summary counts and "last triggered" timestamp updates.
+     * Default: TRIGGER_PROVIDER_EVENT (for backward compatibility with existing activations)
+     */
+    activationInitiationSourceInfo?: ActivationInitiationSourceInfo;
 }
 declare enum Target {
     UNKNOWN_TARGET = "UNKNOWN_TARGET",
@@ -244,6 +252,52 @@ declare enum WarningReason {
 }
 /** @enumType */
 type WarningReasonWithLiterals = WarningReason | 'UNKNOWN_WARNING_REASON' | 'STUDIO_SITE_ENRICHMENT_FAILED' | 'REFRESH_PAYLOAD_FAILED' | 'GET_CONTACT_ENRICHMENT_FAILED' | 'GET_MEMBER_ENRICHMENT_FAILED';
+/** Activation initiation source with additional details based on origin. */
+interface ActivationInitiationSourceInfo extends ActivationInitiationSourceInfoInitiationSourceInfoOneOf {
+    /** Details for MANUAL_ACTIVATION source. */
+    manualActivationInfo?: ManualActivationInfo;
+    /** The source type of this activation. */
+    activationInitiationSource?: ActivationInitiationSourceWithLiterals;
+}
+/** @oneof */
+interface ActivationInitiationSourceInfoInitiationSourceInfoOneOf {
+    /** Details for MANUAL_ACTIVATION source. */
+    manualActivationInfo?: ManualActivationInfo;
+}
+/**
+ * Source types for automation activation.
+ * This enum may be extended in the future to support additional activation origins.
+ */
+declare enum ActivationInitiationSource {
+    /** Unspecified activation initiation source (protobuf default value). */
+    UNKNOWN_ACTIVATION_INITIATION_SOURCE = "UNKNOWN_ACTIVATION_INITIATION_SOURCE",
+    /**
+     * Activation triggered by a provider event (e.g., reportEvent, bulkReportEvent).
+     * The automation runs in response to a business event. Uses published automations only.
+     */
+    TRIGGER_PROVIDER_EVENT = "TRIGGER_PROVIDER_EVENT",
+    /**
+     * Activation triggered by manual execution (e.g., testAutomation, ReRunAutomation).
+     * Explicitly initiated by user or API caller with explicit payload.
+     */
+    MANUAL_ACTIVATION = "MANUAL_ACTIVATION"
+}
+/** @enumType */
+type ActivationInitiationSourceWithLiterals = ActivationInitiationSource | 'UNKNOWN_ACTIVATION_INITIATION_SOURCE' | 'TRIGGER_PROVIDER_EVENT' | 'MANUAL_ACTIVATION';
+/** Additional information for manual automation activations. */
+interface ManualActivationInfo {
+    /**
+     * Whether this activation is running in test mode.
+     *
+     * In test mode:
+     * - Draft automations can be executed
+     * - Certain actions may be skipped (e.g., delays, rate limits)
+     * - Used primarily for testing automations before publication
+     *
+     * Default: false (standard production mode)
+     */
+    testMode?: boolean;
+}
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
@@ -405,17 +459,19 @@ interface AIMetadata {
 }
 interface ActionSettings {
     /**
-     * Permanent actions. PermanentAction's skipActionExpression cannot be modified.
+     * IDs of actions whose `skipActionExpression` can't be modified.
      *
-     * When empty, all actions can be set as skipped
+     * An action's `skipActionExpression` determines whether the action is skipped. Including an action's ID in this array makes its `skipActionExpression` permanent, so it can't be changed.
+     *
+     * When empty, the `skipActionExpression` of all actions can be edited.
      * @maxSize 30
      * @format GUID
      */
     permanentActionIds?: string[];
     /**
-     * Read-only actions. Read-only actions cannot be edited.
+     * IDs of read-only actions. Read-only actions cannot be modified.
      *
-     * When empty, all actions are editable.
+     * When empty and the automation's `settings.readonly` is `false`, all actions are modifiable.
      * @maxSize 30
      * @format GUID
      */
@@ -625,15 +681,29 @@ declare enum Type {
     UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
     /** Defined by a [Wix app](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#app-defined-action). This action type is available in the site dashboard. */
     APP_DEFINED = "APP_DEFINED",
-    /** Condition. This determines which action runs next. */
+    /**
+     * Condition action. Evaluates a condition to determine which action runs next.
+     *
+     * Learn more about [adding and setting up conditions](https://support.wix.com/en/article/the-new-automation-builder-understanding-conditions-operators) in Wix Automations.
+     *
+     * > **Note**: When `skipActionExpression` evaluates to `true`, the actions in `conditionInfo.truePostActionIds` run and those in `conditionInfo.falsePostActionIds` are skipped.
+     */
     CONDITION = "CONDITION",
+    /**
+     * Code condition action. Evaluates custom code to determine which action runs next.
+     *
+     * Learn more about [adding and setting up conditions](https://support.wix.com/en/article/the-new-automation-builder-understanding-conditions-operators) in Wix Automations.
+     *
+     * > **Note**: When `skipActionExpression` evaluates to `true`, the actions in `codeConditionInfo.truePostActionIds` run and those in `codeConditionInfo.falsePostActionIds` are skipped.
+     */
+    CODE_CONDITION = "CODE_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';
+type TypeWithLiterals = Type | 'UNKNOWN_ACTION_TYPE' | 'APP_DEFINED' | 'CONDITION' | 'CODE_CONDITION' | 'DELAY' | 'RATE_LIMIT';
 interface AppDefinedAction {
     /**
      * ID of the app that defines the action.
@@ -851,15 +921,15 @@ interface Trigger {
     overrideSchema?: Record<string, any> | null;
 }
 interface Action extends ActionInfoOneOf {
-    /** Details of the action when its `type` is `APP_DEFINED`. */
+    /** Details of the action whose `type` is `APP_DEFINED`. */
     appDefinedInfo?: AppDefinedAction;
-    /** Details of the action when its `type` is `CONDITION`. */
+    /** Details of the action whose `type` is `CONDITION`. */
     conditionInfo?: ConditionAction;
-    /** Details of the action when its `type` is `CODE_CONDITION`. */
+    /** Details of the action whose `type` is `CODE_CONDITION`. */
     codeConditionInfo?: CodeConditionAction;
-    /** Details of the action when its `type` is `DELAY`. */
+    /** Details of the action whose `type` is `DELAY`. */
     delayInfo?: DelayAction;
-    /** Details of the action when its `type` is `RATE_LIMIT`. */
+    /** Details of the action whose `type` is `RATE_LIMIT`. */
     rateLimitInfo?: RateLimitAction;
     /**
      * Action ID.
@@ -887,24 +957,24 @@ interface Action extends ActionInfoOneOf {
      */
     namespace?: string | null;
     /**
-     * Evaluated to boolean to decide whether the action is skipped.
-     * For ConditionAction: if skipped, true_post_action_ids execute; false_post_action_ids are skipped
-     * SplitAction and OutputAction do not support skip_action_expression
+     * Evaluated to determine whether the action is skipped. When evaluated to `true`, the action is skipped. Otherwise, the action runs.
+     *
+     * When empty, the action runs.
      * @maxLength 1000
      */
     skipActionExpression?: string | null;
 }
 /** @oneof */
 interface ActionInfoOneOf {
-    /** Details of the action when its `type` is `APP_DEFINED`. */
+    /** Details of the action whose `type` is `APP_DEFINED`. */
     appDefinedInfo?: AppDefinedAction;
-    /** Details of the action when its `type` is `CONDITION`. */
+    /** Details of the action whose `type` is `CONDITION`. */
     conditionInfo?: ConditionAction;
-    /** Details of the action when its `type` is `CODE_CONDITION`. */
+    /** Details of the action whose `type` is `CODE_CONDITION`. */
     codeConditionInfo?: CodeConditionAction;
-    /** Details of the action when its `type` is `DELAY`. */
+    /** Details of the action whose `type` is `DELAY`. */
     delayInfo?: DelayAction;
-    /** Details of the action when its `type` is `RATE_LIMIT`. */
+    /** Details of the action whose `type` is `RATE_LIMIT`. */
     rateLimitInfo?: RateLimitAction;
 }
 interface FilterableAppDefinedActions {
@@ -968,11 +1038,12 @@ interface AutomationSettings {
     hidden?: boolean;
     /**
      * Whether the automation is read-only.
-     * If true - modifications to the automation trigger or action/s are disabled.
-     * **Note**: this setting takes precedent over triggerSettings/actionSettings.
-     * If false - allows selective read-only settings via those fields.
      *
-     * Default: `false`
+     * When `true`, site owners can't modify the automation or any of its actions. When `false`, users can configure specific actions as skippable or read-only using `settings.actionSettings`.
+     *
+     * Default: `false`.
+     *
+     * > **Note**: Setting `readOnly` to `true` overrides `settings.actionSettings`.
      */
     readonly?: boolean;
     /**
@@ -982,7 +1053,7 @@ interface AutomationSettings {
      */
     disableDelete?: boolean;
     /**
-     * Whether to disable the option to change the automation's `configuration.status`, for example from `ACTIVE` to `INACTIVE`.
+     * Whether to disable the option to change the automation's `configuration.status`.
      *
      * Default: `false`.
      */
@@ -1280,7 +1351,7 @@ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYM
  * @returns Activation log
  * @fqn wix.automations.activation_logs.v1.ActivationLogsService.GetActivationLog
  */
-declare function getActivationLog(activationId: string): Promise<NonNullablePaths<ActivationLog, `_id` | `automationId` | `automationRevision` | `status` | `initiatedInfo.target` | `scheduledInfo.scheduleId` | `cancelledInfo.reason` | `failedInfo.errorDescription` | `failedInfo.errorReason` | `skippedInfo.reason` | `warnings` | `warnings.${number}.errorDescription` | `warnings.${number}.reason`, 4>>;
+declare function getActivationLog(activationId: string): Promise<NonNullablePaths<ActivationLog, `_id` | `automationId` | `automationRevision` | `status` | `initiatedInfo.target` | `scheduledInfo.scheduleId` | `cancelledInfo.reason` | `failedInfo.errorDescription` | `failedInfo.errorReason` | `skippedInfo.reason` | `warnings` | `warnings.${number}.errorDescription` | `warnings.${number}.reason` | `activationInitiationSourceInfo.manualActivationInfo.testMode` | `activationInitiationSourceInfo.activationInitiationSource`, 4>>;
 /**
  * List activation logs
  * @public
@@ -1290,7 +1361,7 @@ declare function getActivationLog(activationId: string): Promise<NonNullablePath
  * @applicableIdentity APP
  * @fqn wix.automations.activation_logs.v1.ActivationLogsService.ListActivationLogs
  */
-declare function listActivationLogs(options?: NonNullablePaths<ListActivationLogsOptions, `identifierType`, 2>): Promise<NonNullablePaths<ListActivationLogsResponse, `activationLogs` | `activationLogs.${number}._id` | `activationLogs.${number}.automationId` | `activationLogs.${number}.automationRevision` | `activationLogs.${number}.status` | `activationLogs.${number}.initiatedInfo.target` | `activationLogs.${number}.scheduledInfo.scheduleId` | `activationLogs.${number}.cancelledInfo.reason` | `activationLogs.${number}.failedInfo.errorDescription` | `activationLogs.${number}.failedInfo.errorReason` | `activationLogs.${number}.skippedInfo.reason`, 5>>;
+declare function listActivationLogs(options?: NonNullablePaths<ListActivationLogsOptions, `identifierType`, 2>): Promise<NonNullablePaths<ListActivationLogsResponse, `activationLogs` | `activationLogs.${number}._id` | `activationLogs.${number}.automationId` | `activationLogs.${number}.automationRevision` | `activationLogs.${number}.status` | `activationLogs.${number}.initiatedInfo.target` | `activationLogs.${number}.scheduledInfo.scheduleId` | `activationLogs.${number}.cancelledInfo.reason` | `activationLogs.${number}.failedInfo.errorDescription` | `activationLogs.${number}.failedInfo.errorReason` | `activationLogs.${number}.skippedInfo.reason` | `activationLogs.${number}.activationInitiationSourceInfo.manualActivationInfo.testMode` | `activationLogs.${number}.activationInitiationSourceInfo.activationInitiationSource`, 6>>;
 interface ListActivationLogsOptions extends ListActivationLogsOptionsIdentifierOneOf {
     /** From created date, If not specified, defaults to 30 days before the current time. */
     fromCreatedDate?: Date | null;
@@ -1326,7 +1397,7 @@ interface ListActivationLogsOptionsIdentifierOneOf {
  * @applicableIdentity APP
  * @fqn wix.automations.activation_logs.v1.ActivationLogsService.SearchActivationLogsByPayloadPiiValue
  */
-declare function searchActivationLogsByPayloadPiiValue(value: string, options?: SearchActivationLogsByPayloadPiiValueOptions): Promise<NonNullablePaths<SearchActivationLogsByPayloadPiiValueResponse, `activationLogs` | `activationLogs.${number}._id` | `activationLogs.${number}.automationId` | `activationLogs.${number}.automationRevision` | `activationLogs.${number}.status` | `activationLogs.${number}.initiatedInfo.target` | `activationLogs.${number}.scheduledInfo.scheduleId` | `activationLogs.${number}.cancelledInfo.reason` | `activationLogs.${number}.failedInfo.errorDescription` | `activationLogs.${number}.failedInfo.errorReason` | `activationLogs.${number}.skippedInfo.reason`, 5>>;
+declare function searchActivationLogsByPayloadPiiValue(value: string, options?: SearchActivationLogsByPayloadPiiValueOptions): Promise<NonNullablePaths<SearchActivationLogsByPayloadPiiValueResponse, `activationLogs` | `activationLogs.${number}._id` | `activationLogs.${number}.automationId` | `activationLogs.${number}.automationRevision` | `activationLogs.${number}.status` | `activationLogs.${number}.initiatedInfo.target` | `activationLogs.${number}.scheduledInfo.scheduleId` | `activationLogs.${number}.cancelledInfo.reason` | `activationLogs.${number}.failedInfo.errorDescription` | `activationLogs.${number}.failedInfo.errorReason` | `activationLogs.${number}.skippedInfo.reason` | `activationLogs.${number}.activationInitiationSourceInfo.manualActivationInfo.testMode` | `activationLogs.${number}.activationInitiationSourceInfo.activationInitiationSource`, 6>>;
 interface SearchActivationLogsByPayloadPiiValueOptions extends SearchActivationLogsByPayloadPiiValueOptionsFilterOptionOneOf {
     /** Paging */
     cursorPaging?: CursorPaging;
@@ -1351,4 +1422,4 @@ interface SearchActivationLogsByPayloadPiiValueOptionsFilterOptionOneOf {
     preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
 }
 
-export { type AIMetadata, type Action, type ActionEvent, type ActionInfoOneOf, type ActionSettings, type ActivationContinuedAfterSchedule, type ActivationLog, type AppDefinedAction, type ApplicationOrigin, type AuditInfo, type AuditInfoIdOneOf, type AutoArchivePolicy, type Automation, type AutomationConfiguration, AutomationConfigurationStatus, type AutomationConfigurationStatusWithLiterals, type AutomationIdInfo, type AutomationOriginInfoOneOf, type AutomationSettings, CancellationReason, type CancellationReasonWithLiterals, type CancelledStatusInfo, type ClientEntityIdsByNamespace, type CodeConditionAction, type CodeSnippet, type ConditionAction, type ConditionExpressionGroup, type CursorPaging, type CursorPagingMetadata, type Cursors, type DelayAction, type Dimensions, Domain, type DomainEvent, type DomainEventBodyOneOf, type DomainWithLiterals, type DraftInfo, type Empty, type EndedStatusInfo, type Enrichment, type Enrichments, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ErrorReason, type ErrorReasonWithLiterals, type ExtendedFields, type FailedStatusInfo, type Filter, FilterBy, type FilterByWithLiterals, type FilterValueSelection, type FilterableAppDefinedActions, type FutureDateActivationOffset, type GetActivationLogRequest, type GetActivationLogResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentifierType, type IdentifierTypeWithLiterals, type Identity, type InitiatedStatusInfo, Language, type LanguageWithLiterals, type ListActivationLogsOptions, type ListActivationLogsOptionsIdentifierOneOf, type ListActivationLogsRequest, type ListActivationLogsRequestIdentifierOneOf, type ListActivationLogsResponse, type MessageEnvelope, type Note, type Notes, type Offset, Operator, type OperatorWithLiterals, Origin, type OriginWithLiterals, type OutputAction, type Path, type Position, type PreinstalledIdentifierInfo, type PreinstalledOrigin, type RateLimit, type RateLimitAction, type RestoreInfo, type ScheduledStatusInfo, type SearchActivationLogsByPayloadPiiValueOptions, type SearchActivationLogsByPayloadPiiValueOptionsFilterOptionOneOf, type SearchActivationLogsByPayloadPiiValueRequest, type SearchActivationLogsByPayloadPiiValueRequestFilterOptionOneOf, type SearchActivationLogsByPayloadPiiValueResponse, type SetVariablesAction, SkipReason, type SkipReasonWithLiterals, type SkippedStatusInfo, type SplitAction, type StartedStatusInfo, Status, type StatusWithLiterals, Target, type TargetWithLiterals, TimeUnit, type TimeUnitWithLiterals, type Trigger, type TriggerSettings, Type, type TypeWithLiterals, type UouDeleteRequest, type Warning, WarningReason, type WarningReasonWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, getActivationLog, listActivationLogs, searchActivationLogsByPayloadPiiValue };
+export { type AIMetadata, type Action, type ActionEvent, type ActionInfoOneOf, type ActionSettings, type ActivationContinuedAfterSchedule, ActivationInitiationSource, type ActivationInitiationSourceInfo, type ActivationInitiationSourceInfoInitiationSourceInfoOneOf, type ActivationInitiationSourceWithLiterals, type ActivationLog, type AppDefinedAction, type ApplicationOrigin, type AuditInfo, type AuditInfoIdOneOf, type AutoArchivePolicy, type Automation, type AutomationConfiguration, AutomationConfigurationStatus, type AutomationConfigurationStatusWithLiterals, type AutomationIdInfo, type AutomationOriginInfoOneOf, type AutomationSettings, CancellationReason, type CancellationReasonWithLiterals, type CancelledStatusInfo, type ClientEntityIdsByNamespace, type CodeConditionAction, type CodeSnippet, type ConditionAction, type ConditionExpressionGroup, type CursorPaging, type CursorPagingMetadata, type Cursors, type DelayAction, type Dimensions, Domain, type DomainEvent, type DomainEventBodyOneOf, type DomainWithLiterals, type DraftInfo, type Empty, type EndedStatusInfo, type Enrichment, type Enrichments, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ErrorReason, type ErrorReasonWithLiterals, type ExtendedFields, type FailedStatusInfo, type Filter, FilterBy, type FilterByWithLiterals, type FilterValueSelection, type FilterableAppDefinedActions, type FutureDateActivationOffset, type GetActivationLogRequest, type GetActivationLogResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentifierType, type IdentifierTypeWithLiterals, type Identity, type InitiatedStatusInfo, Language, type LanguageWithLiterals, type ListActivationLogsOptions, type ListActivationLogsOptionsIdentifierOneOf, type ListActivationLogsRequest, type ListActivationLogsRequestIdentifierOneOf, type ListActivationLogsResponse, type ManualActivationInfo, type MessageEnvelope, type Note, type Notes, type Offset, Operator, type OperatorWithLiterals, Origin, type OriginWithLiterals, type OutputAction, type Path, type Position, type PreinstalledIdentifierInfo, type PreinstalledOrigin, type RateLimit, type RateLimitAction, type RestoreInfo, type ScheduledStatusInfo, type SearchActivationLogsByPayloadPiiValueOptions, type SearchActivationLogsByPayloadPiiValueOptionsFilterOptionOneOf, type SearchActivationLogsByPayloadPiiValueRequest, type SearchActivationLogsByPayloadPiiValueRequestFilterOptionOneOf, type SearchActivationLogsByPayloadPiiValueResponse, type SetVariablesAction, SkipReason, type SkipReasonWithLiterals, type SkippedStatusInfo, type SplitAction, type StartedStatusInfo, Status, type StatusWithLiterals, Target, type TargetWithLiterals, TimeUnit, type TimeUnitWithLiterals, type Trigger, type TriggerSettings, Type, type TypeWithLiterals, type UouDeleteRequest, type Warning, WarningReason, type WarningReasonWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, getActivationLog, listActivationLogs, searchActivationLogsByPayloadPiiValue };

package/build/es/index.typings.mjs

@@ -226,6 +226,12 @@ var WarningReason = /* @__PURE__ */ ((WarningReason2) => {
   WarningReason2["GET_MEMBER_ENRICHMENT_FAILED"] = "GET_MEMBER_ENRICHMENT_FAILED";
   return WarningReason2;
 })(WarningReason || {});
+var ActivationInitiationSource = /* @__PURE__ */ ((ActivationInitiationSource2) => {
+  ActivationInitiationSource2["UNKNOWN_ACTIVATION_INITIATION_SOURCE"] = "UNKNOWN_ACTIVATION_INITIATION_SOURCE";
+  ActivationInitiationSource2["TRIGGER_PROVIDER_EVENT"] = "TRIGGER_PROVIDER_EVENT";
+  ActivationInitiationSource2["MANUAL_ACTIVATION"] = "MANUAL_ACTIVATION";
+  return ActivationInitiationSource2;
+})(ActivationInitiationSource || {});
 var Domain = /* @__PURE__ */ ((Domain2) => {
   Domain2["USER"] = "USER";
   Domain2["WIX"] = "WIX";
@@ -256,6 +262,7 @@ var Type = /* @__PURE__ */ ((Type2) => {
   Type2["UNKNOWN_ACTION_TYPE"] = "UNKNOWN_ACTION_TYPE";
   Type2["APP_DEFINED"] = "APP_DEFINED";
   Type2["CONDITION"] = "CONDITION";
+  Type2["CODE_CONDITION"] = "CODE_CONDITION";
   Type2["DELAY"] = "DELAY";
   Type2["RATE_LIMIT"] = "RATE_LIMIT";
   return Type2;
@@ -401,6 +408,7 @@ async function searchActivationLogsByPayloadPiiValue2(value, options) {
   }
 }
 export {
+  ActivationInitiationSource,
   AutomationConfigurationStatus,
   CancellationReason,
   Domain,