@wix/auto_sdk_automations_automations-v-2 1.0.17 → 1.0.18

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

@@ -356,7 +356,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`.
+     * > **Note**: To define the wait time from a specific moment in time, use `dueDateEpochExpression` or `dueDateExpression`.
      * @maxLength 1000
      */
     offsetExpression?: string | null;
@@ -367,8 +367,21 @@ interface DelayAction {
      *
      * > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
      * @maxLength 1000
+     * @deprecated Action run date in milliseconds elapsed since January 1, 1970 UTC.
+     *
+     * > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
+     * @replacedBy due_date_expression
+     * @targetRemovalDate 2026-02-01
      */
     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.
+     *
+     * > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
+     * @maxLength 1000
+     */
+    dueDateExpression?: string | null;
     /**
      * IDs of actions to run in parallel after the time delay.
      * @maxSize 20
@@ -2374,7 +2387,6 @@ interface AutomationUpdatedEnvelope {
  * @documentationMaturity preview
  */
 declare function onAutomationUpdated(handler: (event: AutomationUpdatedEnvelope) => void | Promise<void>): void;
-type AutomationNonNullablePaths = `applicationInfo.appId` | `preinstalledInfo.appId` | `createdBy.userId` | `createdBy.appId` | `updatedBy.userId` | `updatedBy.appId` | `name` | `configuration.status` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `configuration.trigger.filters` | `configuration.trigger.filters.${number}._id` | `configuration.trigger.filters.${number}.fieldKey` | `configuration.trigger.filters.${number}.filterExpression` | `configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `configuration.trigger.rateLimit.maxActivationsExpression` | `configuration.trigger.rateLimit.durationTimeUnit` | `configuration.rootActionIds` | `origin` | `settings.hidden` | `settings.readonly` | `settings.disableDelete` | `settings.disableStatusChange` | `settings.actionSettings.permanentActionIds` | `settings.actionSettings.readonlyActionIds` | `settings.actionSettings.disableDelayAddition` | `settings.actionSettings.disableConditionAddition` | `archived`;
 /**
  * Creates an automation.
  * @param automation - Automation to create.
@@ -2395,7 +2407,7 @@ type AutomationNonNullablePaths = `applicationInfo.appId` | `preinstalledInfo.ap
  * @returns Details of the created automation.
  * @fqn wix.automations.v2.AutomationsService.CreateAutomation
  */
-declare function createAutomation(automation: NonNullablePaths<Automation, `configuration` | `configuration.actions` | `configuration.rootActionIds` | `configuration.status` | `configuration.trigger` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `name` | `origin`>): Promise<NonNullablePaths<Automation, AutomationNonNullablePaths>>;
+declare function createAutomation(automation: NonNullablePaths<Automation, `configuration` | `configuration.actions` | `configuration.rootActionIds` | `configuration.status` | `configuration.trigger` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `name` | `origin`>): Promise<NonNullablePaths<Automation, `applicationInfo.appId` | `preinstalledInfo.appId` | `createdBy.userId` | `createdBy.appId` | `name` | `configuration.status` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `configuration.trigger.filters` | `configuration.trigger.filters.${number}._id` | `configuration.trigger.filters.${number}.fieldKey` | `configuration.trigger.filters.${number}.filterExpression` | `configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `configuration.trigger.rateLimit.maxActivationsExpression` | `configuration.trigger.rateLimit.durationTimeUnit` | `configuration.rootActionIds` | `origin` | `settings.hidden` | `settings.readonly` | `settings.disableDelete` | `settings.disableStatusChange` | `settings.actionSettings.permanentActionIds` | `settings.actionSettings.readonlyActionIds` | `settings.actionSettings.disableDelayAddition` | `settings.actionSettings.disableConditionAddition` | `archived`>>;
 /**
  * Retrieves an automation by ID.
  * @param automationId - Automation ID.
@@ -2407,7 +2419,7 @@ declare function createAutomation(automation: NonNullablePaths<Automation, `conf
  * @returns Retrieved automation.
  * @fqn wix.automations.v2.AutomationsService.GetAutomation
  */
-declare function getAutomation(automationId: string): Promise<NonNullablePaths<Automation, AutomationNonNullablePaths>>;
+declare function getAutomation(automationId: string): Promise<NonNullablePaths<Automation, `applicationInfo.appId` | `preinstalledInfo.appId` | `createdBy.userId` | `createdBy.appId` | `name` | `configuration.status` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `configuration.trigger.filters` | `configuration.trigger.filters.${number}._id` | `configuration.trigger.filters.${number}.fieldKey` | `configuration.trigger.filters.${number}.filterExpression` | `configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `configuration.trigger.rateLimit.maxActivationsExpression` | `configuration.trigger.rateLimit.durationTimeUnit` | `configuration.rootActionIds` | `origin` | `settings.hidden` | `settings.readonly` | `settings.disableDelete` | `settings.disableStatusChange` | `settings.actionSettings.permanentActionIds` | `settings.actionSettings.readonlyActionIds` | `settings.actionSettings.disableDelayAddition` | `settings.actionSettings.disableConditionAddition` | `archived`>>;
 /**
  * Updates the specified automation.
  *
@@ -2423,7 +2435,7 @@ declare function getAutomation(automationId: string): Promise<NonNullablePaths<A
  * @returns Updated automation.
  * @fqn wix.automations.v2.AutomationsService.UpdateAutomation
  */
-declare function updateAutomation(_id: string, automation: NonNullablePaths<UpdateAutomation, `revision`>): Promise<NonNullablePaths<Automation, AutomationNonNullablePaths>>;
+declare function updateAutomation(_id: string, automation: NonNullablePaths<UpdateAutomation, `revision`>): Promise<NonNullablePaths<Automation, `applicationInfo.appId` | `preinstalledInfo.appId` | `createdBy.userId` | `createdBy.appId` | `name` | `configuration.status` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `configuration.trigger.filters` | `configuration.trigger.filters.${number}._id` | `configuration.trigger.filters.${number}.fieldKey` | `configuration.trigger.filters.${number}.filterExpression` | `configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `configuration.trigger.rateLimit.maxActivationsExpression` | `configuration.trigger.rateLimit.durationTimeUnit` | `configuration.rootActionIds` | `origin` | `settings.hidden` | `settings.readonly` | `settings.disableDelete` | `settings.disableStatusChange` | `settings.actionSettings.permanentActionIds` | `settings.actionSettings.readonlyActionIds` | `settings.actionSettings.disableDelayAddition` | `settings.actionSettings.disableConditionAddition` | `archived`>>;
 interface UpdateAutomation {
     /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
     applicationInfo?: ApplicationOrigin;
@@ -2529,9 +2541,7 @@ declare function bulkDeleteAutomations(automationIds: string[]): Promise<NonNull
  * @requiredField automation
  * @fqn wix.automations.v2.AutomationsService.GeneratePreinstalledAutomation
  */
-declare function generatePreinstalledAutomation(automation: Automation, options?: GeneratePreinstalledAutomationOptions): Promise<NonNullablePaths<GeneratePreinstalledAutomationResponse, {
-    [P in AutomationNonNullablePaths]: `automation.${P}`;
-}[AutomationNonNullablePaths]>>;
+declare function generatePreinstalledAutomation(automation: Automation, options?: GeneratePreinstalledAutomationOptions): Promise<NonNullablePaths<GeneratePreinstalledAutomationResponse, `automation.applicationInfo.appId` | `automation.preinstalledInfo.appId` | `automation.createdBy.userId` | `automation.createdBy.appId` | `automation.name` | `automation.configuration.status` | `automation.configuration.trigger.appId` | `automation.configuration.trigger.triggerKey` | `automation.configuration.trigger.filters` | `automation.configuration.trigger.filters.${number}._id` | `automation.configuration.trigger.filters.${number}.fieldKey` | `automation.configuration.trigger.filters.${number}.filterExpression` | `automation.configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `automation.configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `automation.configuration.trigger.rateLimit.maxActivationsExpression` | `automation.configuration.trigger.rateLimit.durationTimeUnit` | `automation.configuration.rootActionIds` | `automation.origin` | `automation.settings.hidden` | `automation.settings.readonly` | `automation.settings.disableDelete` | `automation.settings.disableStatusChange` | `automation.settings.actionSettings.permanentActionIds` | `automation.settings.actionSettings.readonlyActionIds` | `automation.settings.actionSettings.disableDelayAddition` | `automation.settings.actionSettings.disableConditionAddition` | `automation.archived`>>;
 interface GeneratePreinstalledAutomationOptions {
     /**
      * ID of the app to which the automation belongs.
@@ -2670,9 +2680,7 @@ interface GetAggregatedUsageInfoOptions {
  * @applicableIdentity APP
  * @fqn wix.automations.v2.AutomationsService.CopyAutomation
  */
-declare function copyAutomation(automationId: string, options?: CopyAutomationOptions): Promise<NonNullablePaths<CopyAutomationResponse, {
-    [P in AutomationNonNullablePaths]: `automation.${P}`;
-}[AutomationNonNullablePaths]>>;
+declare function copyAutomation(automationId: string, options?: CopyAutomationOptions): Promise<NonNullablePaths<CopyAutomationResponse, `automation.applicationInfo.appId` | `automation.preinstalledInfo.appId` | `automation.createdBy.userId` | `automation.createdBy.appId` | `automation.name` | `automation.configuration.status` | `automation.configuration.trigger.appId` | `automation.configuration.trigger.triggerKey` | `automation.configuration.trigger.filters` | `automation.configuration.trigger.filters.${number}._id` | `automation.configuration.trigger.filters.${number}.fieldKey` | `automation.configuration.trigger.filters.${number}.filterExpression` | `automation.configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `automation.configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `automation.configuration.trigger.rateLimit.maxActivationsExpression` | `automation.configuration.trigger.rateLimit.durationTimeUnit` | `automation.configuration.rootActionIds` | `automation.origin` | `automation.settings.hidden` | `automation.settings.readonly` | `automation.settings.disableDelete` | `automation.settings.disableStatusChange` | `automation.settings.actionSettings.permanentActionIds` | `automation.settings.actionSettings.readonlyActionIds` | `automation.settings.actionSettings.disableDelayAddition` | `automation.settings.actionSettings.disableConditionAddition` | `automation.archived`>>;
 interface CopyAutomationOptions {
     /** Origin of the automation to copy. */
     origin?: OriginWithLiterals;
@@ -2687,9 +2695,7 @@ interface CopyAutomationOptions {
  * @applicableIdentity APP
  * @fqn wix.automations.v2.AutomationsService.CreateDraftAutomation
  */
-declare function createDraftAutomation(options?: CreateDraftAutomationOptions): Promise<NonNullablePaths<CreateDraftAutomationResponse, {
-    [P in AutomationNonNullablePaths]: `automation.${P}`;
-}[AutomationNonNullablePaths]>>;
+declare function createDraftAutomation(options?: CreateDraftAutomationOptions): Promise<NonNullablePaths<CreateDraftAutomationResponse, `automation.applicationInfo.appId` | `automation.preinstalledInfo.appId` | `automation.createdBy.userId` | `automation.createdBy.appId` | `automation.name` | `automation.configuration.status` | `automation.configuration.trigger.appId` | `automation.configuration.trigger.triggerKey` | `automation.configuration.trigger.filters` | `automation.configuration.trigger.filters.${number}._id` | `automation.configuration.trigger.filters.${number}.fieldKey` | `automation.configuration.trigger.filters.${number}.filterExpression` | `automation.configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `automation.configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `automation.configuration.trigger.rateLimit.maxActivationsExpression` | `automation.configuration.trigger.rateLimit.durationTimeUnit` | `automation.configuration.rootActionIds` | `automation.origin` | `automation.settings.hidden` | `automation.settings.readonly` | `automation.settings.disableDelete` | `automation.settings.disableStatusChange` | `automation.settings.actionSettings.permanentActionIds` | `automation.settings.actionSettings.readonlyActionIds` | `automation.settings.actionSettings.disableDelayAddition` | `automation.settings.actionSettings.disableConditionAddition` | `automation.archived`>>;
 interface CreateDraftAutomationOptions {
     /** Draft automation to create. */
     automation?: Automation;
@@ -2706,9 +2712,7 @@ interface CreateDraftAutomationOptions {
  * @applicableIdentity APP
  * @fqn wix.automations.v2.AutomationsService.GetOrCreateDraftAutomation
  */
-declare function getOrCreateDraftAutomation(originalAutomationId: string): Promise<NonNullablePaths<GetOrCreateDraftAutomationResponse, {
-    [P in AutomationNonNullablePaths]: `automation.${P}`;
-}[AutomationNonNullablePaths]>>;
+declare function getOrCreateDraftAutomation(originalAutomationId: string): Promise<NonNullablePaths<GetOrCreateDraftAutomationResponse, `automation.applicationInfo.appId` | `automation.preinstalledInfo.appId` | `automation.createdBy.userId` | `automation.createdBy.appId` | `automation.name` | `automation.configuration.status` | `automation.configuration.trigger.appId` | `automation.configuration.trigger.triggerKey` | `automation.configuration.trigger.filters` | `automation.configuration.trigger.filters.${number}._id` | `automation.configuration.trigger.filters.${number}.fieldKey` | `automation.configuration.trigger.filters.${number}.filterExpression` | `automation.configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `automation.configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `automation.configuration.trigger.rateLimit.maxActivationsExpression` | `automation.configuration.trigger.rateLimit.durationTimeUnit` | `automation.configuration.rootActionIds` | `automation.origin` | `automation.settings.hidden` | `automation.settings.readonly` | `automation.settings.disableDelete` | `automation.settings.disableStatusChange` | `automation.settings.actionSettings.permanentActionIds` | `automation.settings.actionSettings.readonlyActionIds` | `automation.settings.actionSettings.disableDelayAddition` | `automation.settings.actionSettings.disableConditionAddition` | `automation.archived`>>;
 /**
  * Updates a draft automation.
  * @param _id - Automation ID.
@@ -2720,9 +2724,7 @@ declare function getOrCreateDraftAutomation(originalAutomationId: string): Promi
  * @applicableIdentity APP
  * @fqn wix.automations.v2.AutomationsService.UpdateDraftAutomation
  */
-declare function updateDraftAutomation(_id: string, automation: UpdateDraftAutomation): Promise<NonNullablePaths<UpdateDraftAutomationResponse, {
-    [P in AutomationNonNullablePaths]: `automation.${P}`;
-}[AutomationNonNullablePaths]>>;
+declare function updateDraftAutomation(_id: string, automation: UpdateDraftAutomation): Promise<NonNullablePaths<UpdateDraftAutomationResponse, `automation.applicationInfo.appId` | `automation.preinstalledInfo.appId` | `automation.createdBy.userId` | `automation.createdBy.appId` | `automation.name` | `automation.configuration.status` | `automation.configuration.trigger.appId` | `automation.configuration.trigger.triggerKey` | `automation.configuration.trigger.filters` | `automation.configuration.trigger.filters.${number}._id` | `automation.configuration.trigger.filters.${number}.fieldKey` | `automation.configuration.trigger.filters.${number}.filterExpression` | `automation.configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `automation.configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `automation.configuration.trigger.rateLimit.maxActivationsExpression` | `automation.configuration.trigger.rateLimit.durationTimeUnit` | `automation.configuration.rootActionIds` | `automation.origin` | `automation.settings.hidden` | `automation.settings.readonly` | `automation.settings.disableDelete` | `automation.settings.disableStatusChange` | `automation.settings.actionSettings.permanentActionIds` | `automation.settings.actionSettings.readonlyActionIds` | `automation.settings.actionSettings.disableDelayAddition` | `automation.settings.actionSettings.disableConditionAddition` | `automation.archived`>>;
 interface UpdateDraftAutomation {
     /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
     applicationInfo?: ApplicationOrigin;
@@ -2814,9 +2816,7 @@ interface UpdateDraftAutomation {
  * @applicableIdentity APP
  * @fqn wix.automations.v2.AutomationsService.QueryAutomationsWithDrafts
  */
-declare function queryAutomationsWithDrafts(options?: QueryAutomationsWithDraftsOptions): Promise<NonNullablePaths<QueryAutomationsWithDraftsResponse, {
-    [P in AutomationNonNullablePaths]: `automations.${number}.${P}`;
-}[AutomationNonNullablePaths]>>;
+declare function queryAutomationsWithDrafts(options?: QueryAutomationsWithDraftsOptions): Promise<NonNullablePaths<QueryAutomationsWithDraftsResponse, `automations` | `automations.${number}.applicationInfo.appId` | `automations.${number}.preinstalledInfo.appId` | `automations.${number}.createdBy.userId` | `automations.${number}.createdBy.appId` | `automations.${number}.name` | `automations.${number}.configuration.status` | `automations.${number}.configuration.trigger.appId` | `automations.${number}.configuration.trigger.triggerKey` | `automations.${number}.origin` | `automations.${number}.settings.hidden` | `automations.${number}.settings.readonly` | `automations.${number}.settings.disableDelete` | `automations.${number}.settings.disableStatusChange` | `automations.${number}.settings.actionSettings.disableDelayAddition` | `automations.${number}.settings.actionSettings.disableConditionAddition` | `automations.${number}.archived`>>;
 interface QueryAutomationsWithDraftsOptions {
     /**
      * Query.
@@ -2872,9 +2872,7 @@ declare function deleteDraftAutomation(automationId: string): Promise<void>;
  * @applicableIdentity APP
  * @fqn wix.automations.v2.AutomationsService.PublishDraftAutomation
  */
-declare function publishDraftAutomation(automationId: string): Promise<NonNullablePaths<PublishDraftAutomationResponse, {
-    [P in AutomationNonNullablePaths]: `automation.${P}`;
-}[AutomationNonNullablePaths]>>;
+declare function publishDraftAutomation(automationId: string): Promise<NonNullablePaths<PublishDraftAutomationResponse, `automation.applicationInfo.appId` | `automation.preinstalledInfo.appId` | `automation.createdBy.userId` | `automation.createdBy.appId` | `automation.name` | `automation.configuration.status` | `automation.configuration.trigger.appId` | `automation.configuration.trigger.triggerKey` | `automation.configuration.trigger.filters` | `automation.configuration.trigger.filters.${number}._id` | `automation.configuration.trigger.filters.${number}.fieldKey` | `automation.configuration.trigger.filters.${number}.filterExpression` | `automation.configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `automation.configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `automation.configuration.trigger.rateLimit.maxActivationsExpression` | `automation.configuration.trigger.rateLimit.durationTimeUnit` | `automation.configuration.rootActionIds` | `automation.origin` | `automation.settings.hidden` | `automation.settings.readonly` | `automation.settings.disableDelete` | `automation.settings.disableStatusChange` | `automation.settings.actionSettings.permanentActionIds` | `automation.settings.actionSettings.readonlyActionIds` | `automation.settings.actionSettings.disableDelayAddition` | `automation.settings.actionSettings.disableConditionAddition` | `automation.archived`>>;
 /**
  * Validates the specified automation.
  * @param automation - Automation to validate.
@@ -2915,9 +2913,7 @@ interface ValidateAutomationByIdOptions {
  * @applicableIdentity APP
  * @fqn wix.automations.v2.AutomationRevisionsService.GetAutomationRevision
  */
-declare function getAutomationRevision(automationId: string, options?: GetAutomationRevisionOptions): Promise<NonNullablePaths<GetAutomationRevisionResponse, {
-    [P in AutomationNonNullablePaths]: `automation.${P}`;
-}[AutomationNonNullablePaths]>>;
+declare function getAutomationRevision(automationId: string, options?: GetAutomationRevisionOptions): Promise<NonNullablePaths<GetAutomationRevisionResponse, `automation.applicationInfo.appId` | `automation.preinstalledInfo.appId` | `automation.createdBy.userId` | `automation.createdBy.appId` | `automation.name` | `automation.configuration.status` | `automation.configuration.trigger.appId` | `automation.configuration.trigger.triggerKey` | `automation.configuration.trigger.filters` | `automation.configuration.trigger.filters.${number}._id` | `automation.configuration.trigger.filters.${number}.fieldKey` | `automation.configuration.trigger.filters.${number}.filterExpression` | `automation.configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `automation.configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `automation.configuration.trigger.rateLimit.maxActivationsExpression` | `automation.configuration.trigger.rateLimit.durationTimeUnit` | `automation.configuration.rootActionIds` | `automation.origin` | `automation.settings.hidden` | `automation.settings.readonly` | `automation.settings.disableDelete` | `automation.settings.disableStatusChange` | `automation.settings.actionSettings.permanentActionIds` | `automation.settings.actionSettings.readonlyActionIds` | `automation.settings.actionSettings.disableDelayAddition` | `automation.settings.actionSettings.disableConditionAddition` | `automation.archived`>>;
 interface GetAutomationRevisionOptions {
     /** Revision number. */
     revision?: string | null;