@wix/auto_sdk_automations_activations 1.0.54 → 1.0.56

package/build/internal/cjs/index.typings.d.ts

@@ -87,6 +87,8 @@ interface AutomationOriginInfoOneOf {
     /** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
     preinstalledInfo?: PreinstalledOrigin;
 }
+interface AIMetadata {
+}
 interface ActionSettings {
     /**
      * Permanent actions. PermanentAction's skipActionExpression cannot be modified.
@@ -176,7 +178,7 @@ interface AutomationConfiguration {
      * @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 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, AutomationConfigurationAction>;
 }
 declare enum TimeUnit {
@@ -290,7 +292,7 @@ interface ActionCodeSnippet {
 declare enum CodeSnippetLanguage {
     /** Unknown. */
     UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
-    /** `JAVASCRIPT` language. */
+    /** JavaScript. */
     JAVASCRIPT = "JAVASCRIPT"
 }
 /** @enumType */
@@ -340,7 +342,11 @@ interface AppDefinedAction {
      * @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). */
+    /**
+     * 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).
+     *
+     * The input mapping must include all parameters specified in the action's input schema's `required` array, and can include any other parameters from the schema.
+     */
     inputMapping?: Record<string, any> | null;
     /**
      * Action skip conditions. An action is skipped if any of the specified conditions evaluates to `true`.
@@ -403,7 +409,7 @@ 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` or `dueDateExpression`.
+     * > **Note**: To define the wait time from a specific moment in time, use `dueDateExpression`.
      * @maxLength 1000
      */
     offsetExpression?: string | null;
@@ -422,8 +428,7 @@ interface DelayAction {
      */
     dueDateEpochExpression?: string | null;
     /**
-     * Action run date as a timestamp/datetime string expression using bracket language.
-     * The expression will be converted to JSONata and should evaluate to a timestamp/datetime format.
+     * Action run date as a timestamp or DateTime expression using bracket notation.
      *
      * > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
      * @maxLength 1000
@@ -548,6 +553,8 @@ interface AutomationConfigurationAction extends AutomationConfigurationActionInf
     /**
      * Action ID.
      *
+     * Unique identifier for the action instance in the current automation. Use this to refer to this action in the automation flow.
+     *
      * If not specified, automatically generated by Wix.
      * @format GUID
      */
@@ -563,7 +570,7 @@ interface AutomationConfigurationAction extends AutomationConfigurationActionInf
      */
     namespace?: string | null;
     /**
-     * skip_action_expression: evaluates to a boolean to decide if the action should be skipped
+     * 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
      * @maxLength 1000
@@ -928,7 +935,6 @@ interface Schedule {
     scheduledAction?: ScheduledAction;
     /** Raw domain event, not enriched */
     eventPayload?: string;
-    /** @readonly */
     scheduleStatus?: ScheduleStatusWithLiterals;
     /** @readonly */
     scheduleDate?: Date | null;
@@ -989,10 +995,16 @@ declare enum ScheduleStatus {
     UNKNOWN_SCHEDULE_STATUS = "UNKNOWN_SCHEDULE_STATUS",
     PENDING = "PENDING",
     CANCELLED = "CANCELLED",
-    DONE = "DONE"
+    DONE = "DONE",
+    MIGRATED = "MIGRATED",
+    /** esb configuration was deleted after the schedule was created */
+    ESB_CONFIGURATION_NOT_FOUND = "ESB_CONFIGURATION_NOT_FOUND",
+    /** automation v3 was deleted after the schedule was created */
+    AUTOMATION_NOT_FOUND = "AUTOMATION_NOT_FOUND",
+    METASITE_DELETED = "METASITE_DELETED"
 }
 /** @enumType */
-type ScheduleStatusWithLiterals = ScheduleStatus | 'UNKNOWN_SCHEDULE_STATUS' | 'PENDING' | 'CANCELLED' | 'DONE';
+type ScheduleStatusWithLiterals = ScheduleStatus | 'UNKNOWN_SCHEDULE_STATUS' | 'PENDING' | 'CANCELLED' | 'DONE' | 'MIGRATED' | 'ESB_CONFIGURATION_NOT_FOUND' | 'AUTOMATION_NOT_FOUND' | 'METASITE_DELETED';
 interface TriggerInfo {
     /**
      * App id of the initial trigger.
@@ -1043,6 +1055,20 @@ interface UpdatePendingSchedulesPayloadRequest {
 }
 interface UpdatePendingSchedulesPayloadResponse {
 }
+interface GetScheduleRequest {
+    /** @format GUID */
+    _id?: string;
+}
+interface GetScheduleResponse {
+    schedule?: Schedule;
+}
+interface UpdateScheduleStatusRequest {
+    /** @format GUID */
+    _id?: string;
+    status?: ScheduleStatusWithLiterals;
+}
+interface UpdateScheduleStatusResponse {
+}
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
@@ -1890,6 +1916,11 @@ interface V1RunAutomationRequest extends V1RunAutomationRequestIdentifierOneOf {
      * strings, numbers, integers, or booleans only.
      */
     payload?: Record<string, any> | null;
+    /**
+     * When true, indicates this is a migration flow and should bypass
+     * the check for future dates that have already passed.
+     */
+    migrationFlow?: boolean;
 }
 /** @oneof */
 interface V1RunAutomationRequestIdentifierOneOf {
@@ -2595,4 +2626,4 @@ declare function bulkCancelEvent(triggerKey: string, externalEntityIds: string[]
  */
 declare function cancelEvent(triggerKey: string, externalEntityId: string): Promise<void>;
 
-export { type Action, type ActionActionOneOf, type ActionAttributes, type ActionCodeSnippet, type ActionCompletedRequest, type ActionData, type ActionEvent, type ActionRetryRequest, type ActionSettings, type ActionSplitAction, type ActionsData, type Activation, type ActivationActionStatusChanged, type ActivationActionStatusChangedInfoOneOf, ActivationActionStatusChangedStatus, type ActivationActionStatusChangedStatusInfoOneOf, type ActivationActionStatusChangedStatusWithLiterals, type ActivationContext, type ActivationContinuedAfterSchedule, type ActivationRequest, type ActivationResumeAfterDelay, type ActivationScheduleCompleted, type ActivationSource, type ActivationSourceOfOneOf, type ActivationStatusChanged, type ActivationStatusChangedFailedStatusInfo, type ActivationStatusChangedStartedStatusInfo, ActivationStatusChangedStatus, type ActivationStatusChangedStatusInfoOneOf, type ActivationStatusChangedStatusWithLiterals, type AppDefinedAction, type AppDefinedActionInfo, type ApplicationError, type ApplicationOrigin, type AsyncAction, type AuditInfo, type AuditInfoIdOneOf, type AutoArchivePolicy, type Automation, type AutomationConfiguration, type AutomationConfigurationAction, type AutomationConfigurationActionInfoOneOf, AutomationConfigurationStatus, type AutomationConfigurationStatusWithLiterals, type AutomationIdentifier, type AutomationInfo, type AutomationInfoOriginInfoOneOf, type AutomationInfoTriggerInfo, type AutomationOriginInfoOneOf, type AutomationSettings, type BatchActivationRequest, BlockType, type BlockTypeWithLiterals, type BulkActionMetadata, type BulkCancelEventRequest, type BulkCancelEventResponse, type BulkCancelEventResult, type BulkReportEventRequest, type BulkReportEventResponse, type BulkReportEventResult, type CancelEventRequest, type CancelEventResponse, type CancelPendingScheduleRequest, type CancelPendingScheduleRequestByOneOf, type CancelPendingScheduleResponse, CancellationReason, type CancellationReasonWithLiterals, type CancelledStatusInfo, type Case, type CodeConditionAction, type CodeConditionActionInfo, type CodeConditionFilter, type CodeSnippet, CodeSnippetLanguage, type CodeSnippetLanguageWithLiterals, type ConditionAction, type ConditionActionInfo, type ConditionBlock, type ConditionExpressionGroup, type ConditionFilter, type ConsumeReportEventRequest, type Delay, type DelayAction, type DelayActionInfo, type DelayHelper, type DelayOfOneOf, type Dimensions, Domain, type DomainEvent, type DomainEventBodyOneOf, type DomainWithLiterals, type DraftInfo, type Empty, type EndedStatusInfo, type EndedStatusInfoAppDefinedActionInfo, type EndedStatusInfoTypeInfoOneOf, type Enrichment, type Enrichments, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ErrorReason, type ErrorReasonWithLiterals, type EventInfo, type ExecuteFromActionRequest, type ExecuteFromActionResponse, type ExpressionEvaluationResult, type ExtendedFields, type FailedStatusInfo, type FailureInfo, type Filter, type FilterValueSelection, type FilterableAppDefinedActions, type FutureDateActivationOffset, type Idempotency, type IdentificationData, type IdentificationDataIdOneOf, IdentifierType, type IdentifierTypeWithLiterals, type Identity, type IfFilter, type InitiatedStatusInfo, type InvokedAsyncStatusInfo, type InvokedAsyncStatusInfoAppDefinedActionInfo, type InvokedAsyncStatusInfoTypeInfoOneOf, type ItemMetadata, Language, type LanguageWithLiterals, type MessageEnvelope, type Metadata, type Note, type Notes, type Offset, Operator, type OperatorWithLiterals, Origin, type OriginWithLiterals, type Output, type OutputAction, type Path, type Position, type PreinstalledIdentifier, type PreinstalledOrigin, type RateLimit, type RateLimitAction, type RateLimitActionInfo, type RateLimiting, type RefreshPayloadRequest, type RefreshPayloadResponse, type ReportActionInvocationCompletedRequest, type ReportActionInvocationCompletedRequestStatusInfoOneOf, type ReportActionInvocationCompletedResponse, type ReportDomainEventRequest, type ReportDomainEventResponse, type ReportEventApplicationErrors, type ReportEventOptions, type ReportEventRequest, type ReportEventResponse, type RestoreInfo, type ResumeAfterAsyncActionCompleted, type ResumeAfterAsyncActionCompletedStatusInfoOneOf, type RetryInfo, type RunAutomationRequest, type RunAutomationResponse, type Runtime, RuntimeStatus, type RuntimeStatusWithLiterals, type Schedule, type ScheduleActivationRequested, type ScheduleRequest, type ScheduleResponse, ScheduleStatus, type ScheduleStatusWithLiterals, type ScheduledAction, type ScheduledStatusInfo, type Scheduler, type Service, type ServiceMapping, type SetVariables, type SetVariablesAction, type SetVariablesActionInfo, type SimpleDelay, SkipReason, type SkipReasonWithLiterals, type SkippedStatusInfo, type SpiAction, type SplitAction, type SplitActionPath, type StartedStatusInfo, type StartedStatusInfoAppDefinedActionInfo, type StartedStatusInfoDelayActionInfo, type StartedStatusInfoTypeInfoOneOf, Status, type StatusWithLiterals, type SuccessInfo, type SwitchFilter, type SystemHelper, type SystemHelperHelperOneOf, Target, type TargetWithLiterals, TimeUnit, type TimeUnitWithLiterals, type Trigger, type TriggerInfo, Type, type TypeWithLiterals, Units, type UnitsWithLiterals, type UpdatePendingSchedulesPayloadRequest, type UpdatePendingSchedulesPayloadResponse, type V1RunAutomationRequest, type V1RunAutomationRequestIdentifierOneOf, type V1RunAutomationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCancelEvent, bulkReportEvent, cancelEvent, reportEvent };
+export { type AIMetadata, type Action, type ActionActionOneOf, type ActionAttributes, type ActionCodeSnippet, type ActionCompletedRequest, type ActionData, type ActionEvent, type ActionRetryRequest, type ActionSettings, type ActionSplitAction, type ActionsData, type Activation, type ActivationActionStatusChanged, type ActivationActionStatusChangedInfoOneOf, ActivationActionStatusChangedStatus, type ActivationActionStatusChangedStatusInfoOneOf, type ActivationActionStatusChangedStatusWithLiterals, type ActivationContext, type ActivationContinuedAfterSchedule, type ActivationRequest, type ActivationResumeAfterDelay, type ActivationScheduleCompleted, type ActivationSource, type ActivationSourceOfOneOf, type ActivationStatusChanged, type ActivationStatusChangedFailedStatusInfo, type ActivationStatusChangedStartedStatusInfo, ActivationStatusChangedStatus, type ActivationStatusChangedStatusInfoOneOf, type ActivationStatusChangedStatusWithLiterals, type AppDefinedAction, type AppDefinedActionInfo, type ApplicationError, type ApplicationOrigin, type AsyncAction, type AuditInfo, type AuditInfoIdOneOf, type AutoArchivePolicy, type Automation, type AutomationConfiguration, type AutomationConfigurationAction, type AutomationConfigurationActionInfoOneOf, AutomationConfigurationStatus, type AutomationConfigurationStatusWithLiterals, type AutomationIdentifier, type AutomationInfo, type AutomationInfoOriginInfoOneOf, type AutomationInfoTriggerInfo, type AutomationOriginInfoOneOf, type AutomationSettings, type BatchActivationRequest, BlockType, type BlockTypeWithLiterals, type BulkActionMetadata, type BulkCancelEventRequest, type BulkCancelEventResponse, type BulkCancelEventResult, type BulkReportEventRequest, type BulkReportEventResponse, type BulkReportEventResult, type CancelEventRequest, type CancelEventResponse, type CancelPendingScheduleRequest, type CancelPendingScheduleRequestByOneOf, type CancelPendingScheduleResponse, CancellationReason, type CancellationReasonWithLiterals, type CancelledStatusInfo, type Case, type CodeConditionAction, type CodeConditionActionInfo, type CodeConditionFilter, type CodeSnippet, CodeSnippetLanguage, type CodeSnippetLanguageWithLiterals, type ConditionAction, type ConditionActionInfo, type ConditionBlock, type ConditionExpressionGroup, type ConditionFilter, type ConsumeReportEventRequest, type Delay, type DelayAction, type DelayActionInfo, type DelayHelper, type DelayOfOneOf, type Dimensions, Domain, type DomainEvent, type DomainEventBodyOneOf, type DomainWithLiterals, type DraftInfo, type Empty, type EndedStatusInfo, type EndedStatusInfoAppDefinedActionInfo, type EndedStatusInfoTypeInfoOneOf, type Enrichment, type Enrichments, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ErrorReason, type ErrorReasonWithLiterals, type EventInfo, type ExecuteFromActionRequest, type ExecuteFromActionResponse, type ExpressionEvaluationResult, type ExtendedFields, type FailedStatusInfo, type FailureInfo, type Filter, type FilterValueSelection, type FilterableAppDefinedActions, type FutureDateActivationOffset, type GetScheduleRequest, type GetScheduleResponse, type Idempotency, type IdentificationData, type IdentificationDataIdOneOf, IdentifierType, type IdentifierTypeWithLiterals, type Identity, type IfFilter, type InitiatedStatusInfo, type InvokedAsyncStatusInfo, type InvokedAsyncStatusInfoAppDefinedActionInfo, type InvokedAsyncStatusInfoTypeInfoOneOf, type ItemMetadata, Language, type LanguageWithLiterals, type MessageEnvelope, type Metadata, type Note, type Notes, type Offset, Operator, type OperatorWithLiterals, Origin, type OriginWithLiterals, type Output, type OutputAction, type Path, type Position, type PreinstalledIdentifier, type PreinstalledOrigin, type RateLimit, type RateLimitAction, type RateLimitActionInfo, type RateLimiting, type RefreshPayloadRequest, type RefreshPayloadResponse, type ReportActionInvocationCompletedRequest, type ReportActionInvocationCompletedRequestStatusInfoOneOf, type ReportActionInvocationCompletedResponse, type ReportDomainEventRequest, type ReportDomainEventResponse, type ReportEventApplicationErrors, type ReportEventOptions, type ReportEventRequest, type ReportEventResponse, type RestoreInfo, type ResumeAfterAsyncActionCompleted, type ResumeAfterAsyncActionCompletedStatusInfoOneOf, type RetryInfo, type RunAutomationRequest, type RunAutomationResponse, type Runtime, RuntimeStatus, type RuntimeStatusWithLiterals, type Schedule, type ScheduleActivationRequested, type ScheduleRequest, type ScheduleResponse, ScheduleStatus, type ScheduleStatusWithLiterals, type ScheduledAction, type ScheduledStatusInfo, type Scheduler, type Service, type ServiceMapping, type SetVariables, type SetVariablesAction, type SetVariablesActionInfo, type SimpleDelay, SkipReason, type SkipReasonWithLiterals, type SkippedStatusInfo, type SpiAction, type SplitAction, type SplitActionPath, type StartedStatusInfo, type StartedStatusInfoAppDefinedActionInfo, type StartedStatusInfoDelayActionInfo, type StartedStatusInfoTypeInfoOneOf, Status, type StatusWithLiterals, type SuccessInfo, type SwitchFilter, type SystemHelper, type SystemHelperHelperOneOf, Target, type TargetWithLiterals, TimeUnit, type TimeUnitWithLiterals, type Trigger, type TriggerInfo, Type, type TypeWithLiterals, Units, type UnitsWithLiterals, type UpdatePendingSchedulesPayloadRequest, type UpdatePendingSchedulesPayloadResponse, type UpdateScheduleStatusRequest, type UpdateScheduleStatusResponse, type V1RunAutomationRequest, type V1RunAutomationRequestIdentifierOneOf, type V1RunAutomationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCancelEvent, bulkReportEvent, cancelEvent, reportEvent };

package/build/internal/cjs/index.typings.js

@@ -310,6 +310,10 @@ var ScheduleStatus = /* @__PURE__ */ ((ScheduleStatus2) => {
   ScheduleStatus2["PENDING"] = "PENDING";
   ScheduleStatus2["CANCELLED"] = "CANCELLED";
   ScheduleStatus2["DONE"] = "DONE";
+  ScheduleStatus2["MIGRATED"] = "MIGRATED";
+  ScheduleStatus2["ESB_CONFIGURATION_NOT_FOUND"] = "ESB_CONFIGURATION_NOT_FOUND";
+  ScheduleStatus2["AUTOMATION_NOT_FOUND"] = "AUTOMATION_NOT_FOUND";
+  ScheduleStatus2["METASITE_DELETED"] = "METASITE_DELETED";
   return ScheduleStatus2;
 })(ScheduleStatus || {});
 var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {