@wix/auto_sdk_automations_automations-v-2 1.0.52 → 1.0.53
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +11 -11
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +32 -20
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +14 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +11 -11
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +32 -20
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +14 -2
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +11 -11
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +32 -20
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +14 -2
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +11 -11
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +32 -20
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +14 -2
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -97,6 +97,18 @@ interface ActionSettings {
|
|
|
97
97
|
* @format GUID
|
|
98
98
|
*/
|
|
99
99
|
readonlyActionIds?: string[];
|
|
100
|
+
/**
|
|
101
|
+
* Whether to disable the ability to add a delay to the automation.
|
|
102
|
+
*
|
|
103
|
+
* Default: `false`.
|
|
104
|
+
*/
|
|
105
|
+
disableDelayAddition?: boolean;
|
|
106
|
+
/**
|
|
107
|
+
* Whether to disable the ability to add a condition to the automation.
|
|
108
|
+
*
|
|
109
|
+
* Default: `false`.
|
|
110
|
+
*/
|
|
111
|
+
disableConditionAddition?: boolean;
|
|
100
112
|
}
|
|
101
113
|
declare enum Domain {
|
|
102
114
|
/** User domain (default). */
|
|
@@ -108,6 +120,8 @@ declare enum Domain {
|
|
|
108
120
|
}
|
|
109
121
|
/** @enumType */
|
|
110
122
|
type DomainWithLiterals = Domain | 'USER' | 'WIX' | 'WIX_ACCOUNT';
|
|
123
|
+
interface TriggerSettings {
|
|
124
|
+
}
|
|
111
125
|
interface Enrichment {
|
|
112
126
|
/**
|
|
113
127
|
* Enrichment input mappings.
|
|
@@ -856,8 +870,6 @@ declare enum WebhookIdentityType {
|
|
|
856
870
|
}
|
|
857
871
|
/** @enumType */
|
|
858
872
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
859
|
-
interface TriggerSettings {
|
|
860
|
-
}
|
|
861
873
|
interface CreateAutomationRequest {
|
|
862
874
|
/** Automation to create. */
|
|
863
875
|
automation: Automation;
|
|
@@ -2432,7 +2444,7 @@ declare function onAutomationUpdated(handler: (event: AutomationUpdatedEnvelope)
|
|
|
2432
2444
|
* @returns Details of the created automation.
|
|
2433
2445
|
* @fqn wix.automations.v2.AutomationsService.CreateAutomation
|
|
2434
2446
|
*/
|
|
2435
|
-
declare function createAutomation(automation: NonNullablePaths<Automation, `configuration` | `configuration.actions` | `configuration.rootActionIds` | `configuration.status` | `configuration.trigger` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `name` | `origin`, 4>): 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` | `archived`, 6>>;
|
|
2447
|
+
declare function createAutomation(automation: NonNullablePaths<Automation, `configuration` | `configuration.actions` | `configuration.rootActionIds` | `configuration.status` | `configuration.trigger` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `name` | `origin`, 4>): 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`, 6>>;
|
|
2436
2448
|
/**
|
|
2437
2449
|
* Retrieves an automation by ID.
|
|
2438
2450
|
* @param automationId - Automation ID.
|
|
@@ -2444,7 +2456,7 @@ declare function createAutomation(automation: NonNullablePaths<Automation, `conf
|
|
|
2444
2456
|
* @returns Retrieved automation.
|
|
2445
2457
|
* @fqn wix.automations.v2.AutomationsService.GetAutomation
|
|
2446
2458
|
*/
|
|
2447
|
-
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` | `archived`, 6>>;
|
|
2459
|
+
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`, 6>>;
|
|
2448
2460
|
/**
|
|
2449
2461
|
* Updates the specified automation.
|
|
2450
2462
|
*
|
|
@@ -2460,7 +2472,7 @@ declare function getAutomation(automationId: string): Promise<NonNullablePaths<A
|
|
|
2460
2472
|
* @returns Updated automation.
|
|
2461
2473
|
* @fqn wix.automations.v2.AutomationsService.UpdateAutomation
|
|
2462
2474
|
*/
|
|
2463
|
-
declare function updateAutomation(_id: string, automation: NonNullablePaths<UpdateAutomation, `revision`, 2>): 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` | `archived`, 6>>;
|
|
2475
|
+
declare function updateAutomation(_id: string, automation: NonNullablePaths<UpdateAutomation, `revision`, 2>): 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`, 6>>;
|
|
2464
2476
|
interface UpdateAutomation {
|
|
2465
2477
|
/** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
|
|
2466
2478
|
applicationInfo?: ApplicationOrigin;
|
|
@@ -2566,7 +2578,7 @@ declare function bulkDeleteAutomations(automationIds: string[]): Promise<NonNull
|
|
|
2566
2578
|
* @requiredField automation
|
|
2567
2579
|
* @fqn wix.automations.v2.AutomationsService.GeneratePreinstalledAutomation
|
|
2568
2580
|
*/
|
|
2569
|
-
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.archived`, 7>>;
|
|
2581
|
+
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`, 7>>;
|
|
2570
2582
|
interface GeneratePreinstalledAutomationOptions {
|
|
2571
2583
|
/**
|
|
2572
2584
|
* ID of the app to which the automation belongs.
|
|
@@ -2605,12 +2617,12 @@ interface AutomationsQueryBuilder {
|
|
|
2605
2617
|
* @param value - Value to compare against.
|
|
2606
2618
|
* @documentationMaturity preview
|
|
2607
2619
|
*/
|
|
2608
|
-
eq: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'archived', value: any) => AutomationsQueryBuilder;
|
|
2620
|
+
eq: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any) => AutomationsQueryBuilder;
|
|
2609
2621
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2610
2622
|
* @param value - Value to compare against.
|
|
2611
2623
|
* @documentationMaturity preview
|
|
2612
2624
|
*/
|
|
2613
|
-
ne: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'archived', value: any) => AutomationsQueryBuilder;
|
|
2625
|
+
ne: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any) => AutomationsQueryBuilder;
|
|
2614
2626
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2615
2627
|
* @param value - Value to compare against.
|
|
2616
2628
|
* @documentationMaturity preview
|
|
@@ -2640,24 +2652,24 @@ interface AutomationsQueryBuilder {
|
|
|
2640
2652
|
* @param values - List of values to compare against.
|
|
2641
2653
|
* @documentationMaturity preview
|
|
2642
2654
|
*/
|
|
2643
|
-
hasSome: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'archived', value: any[]) => AutomationsQueryBuilder;
|
|
2655
|
+
hasSome: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any[]) => AutomationsQueryBuilder;
|
|
2644
2656
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
2645
2657
|
* @param values - List of values to compare against.
|
|
2646
2658
|
* @documentationMaturity preview
|
|
2647
2659
|
*/
|
|
2648
2660
|
hasAll: (propertyName: 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds', value: any[]) => AutomationsQueryBuilder;
|
|
2649
2661
|
/** @documentationMaturity preview */
|
|
2650
|
-
in: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'archived', value: any) => AutomationsQueryBuilder;
|
|
2662
|
+
in: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: any) => AutomationsQueryBuilder;
|
|
2651
2663
|
/** @documentationMaturity preview */
|
|
2652
|
-
exists: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'archived', value: boolean) => AutomationsQueryBuilder;
|
|
2664
|
+
exists: (propertyName: 'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived', value: boolean) => AutomationsQueryBuilder;
|
|
2653
2665
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
2654
2666
|
* @documentationMaturity preview
|
|
2655
2667
|
*/
|
|
2656
|
-
ascending: (...propertyNames: Array<'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filters' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'archived'>) => AutomationsQueryBuilder;
|
|
2668
|
+
ascending: (...propertyNames: Array<'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filters' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived'>) => AutomationsQueryBuilder;
|
|
2657
2669
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
2658
2670
|
* @documentationMaturity preview
|
|
2659
2671
|
*/
|
|
2660
|
-
descending: (...propertyNames: Array<'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filters' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'archived'>) => AutomationsQueryBuilder;
|
|
2672
|
+
descending: (...propertyNames: Array<'createdBy.appId' | 'name' | 'configuration.status' | 'configuration.trigger.appId' | 'configuration.trigger.triggerKey' | 'configuration.trigger.filters' | 'configuration.trigger.filterValueSelection.selectedFilterValues' | 'origin' | 'settings' | 'settings.readonly' | 'settings.disableDelete' | 'settings.disableStatusChange' | 'settings.actionSettings' | 'settings.actionSettings.permanentActionIds' | 'settings.actionSettings.readonlyActionIds' | 'settings.actionSettings.disableDelayAddition' | 'settings.actionSettings.disableConditionAddition' | 'archived'>) => AutomationsQueryBuilder;
|
|
2661
2673
|
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
2662
2674
|
* @documentationMaturity preview
|
|
2663
2675
|
*/
|
|
@@ -2705,7 +2717,7 @@ interface GetAggregatedUsageInfoOptions {
|
|
|
2705
2717
|
* @applicableIdentity APP
|
|
2706
2718
|
* @fqn wix.automations.v2.AutomationsService.CopyAutomation
|
|
2707
2719
|
*/
|
|
2708
|
-
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.archived`, 7>>;
|
|
2720
|
+
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`, 7>>;
|
|
2709
2721
|
interface CopyAutomationOptions {
|
|
2710
2722
|
/** Origin of the automation to copy. */
|
|
2711
2723
|
origin?: OriginWithLiterals;
|
|
@@ -2720,7 +2732,7 @@ interface CopyAutomationOptions {
|
|
|
2720
2732
|
* @applicableIdentity APP
|
|
2721
2733
|
* @fqn wix.automations.v2.AutomationsService.CreateDraftAutomation
|
|
2722
2734
|
*/
|
|
2723
|
-
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.archived`, 7>>;
|
|
2735
|
+
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`, 7>>;
|
|
2724
2736
|
interface CreateDraftAutomationOptions {
|
|
2725
2737
|
/** Draft automation to create. */
|
|
2726
2738
|
automation?: Automation;
|
|
@@ -2737,7 +2749,7 @@ interface CreateDraftAutomationOptions {
|
|
|
2737
2749
|
* @applicableIdentity APP
|
|
2738
2750
|
* @fqn wix.automations.v2.AutomationsService.GetOrCreateDraftAutomation
|
|
2739
2751
|
*/
|
|
2740
|
-
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.archived`, 7>>;
|
|
2752
|
+
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`, 7>>;
|
|
2741
2753
|
/**
|
|
2742
2754
|
* Updates a draft automation.
|
|
2743
2755
|
* @param _id - Automation ID.
|
|
@@ -2749,7 +2761,7 @@ declare function getOrCreateDraftAutomation(originalAutomationId: string): Promi
|
|
|
2749
2761
|
* @applicableIdentity APP
|
|
2750
2762
|
* @fqn wix.automations.v2.AutomationsService.UpdateDraftAutomation
|
|
2751
2763
|
*/
|
|
2752
|
-
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.archived`, 7>>;
|
|
2764
|
+
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`, 7>>;
|
|
2753
2765
|
interface UpdateDraftAutomation {
|
|
2754
2766
|
/** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
|
|
2755
2767
|
applicationInfo?: ApplicationOrigin;
|
|
@@ -2841,7 +2853,7 @@ interface UpdateDraftAutomation {
|
|
|
2841
2853
|
* @applicableIdentity APP
|
|
2842
2854
|
* @fqn wix.automations.v2.AutomationsService.QueryAutomationsWithDrafts
|
|
2843
2855
|
*/
|
|
2844
|
-
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}.archived`, 6>>;
|
|
2856
|
+
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`, 6>>;
|
|
2845
2857
|
interface QueryAutomationsWithDraftsOptions {
|
|
2846
2858
|
/**
|
|
2847
2859
|
* Query.
|
|
@@ -2910,7 +2922,7 @@ declare function deleteDraftAutomation(automationId: string): Promise<void>;
|
|
|
2910
2922
|
* @applicableIdentity APP
|
|
2911
2923
|
* @fqn wix.automations.v2.AutomationsService.PublishDraftAutomation
|
|
2912
2924
|
*/
|
|
2913
|
-
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.archived`, 7>>;
|
|
2925
|
+
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`, 7>>;
|
|
2914
2926
|
/**
|
|
2915
2927
|
* Validates the specified automation.
|
|
2916
2928
|
* @param automation - Automation to validate.
|
|
@@ -2951,7 +2963,7 @@ interface ValidateAutomationByIdOptions {
|
|
|
2951
2963
|
* @applicableIdentity APP
|
|
2952
2964
|
* @fqn wix.automations.v2.AutomationRevisionsService.GetAutomationRevision
|
|
2953
2965
|
*/
|
|
2954
|
-
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.archived`, 7>>;
|
|
2966
|
+
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`, 7>>;
|
|
2955
2967
|
interface GetAutomationRevisionOptions {
|
|
2956
2968
|
/** Revision number. */
|
|
2957
2969
|
revision?: string | null;
|