@wix/auto_sdk_automations_activation-log 1.0.0 → 1.0.2

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.
Files changed (45) hide show
  1. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.d.ts +1 -1
  2. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +3 -3
  3. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +1 -1
  4. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +5 -5
  5. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +1 -1
  6. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +195 -192
  7. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js +22 -18
  8. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +1 -1
  9. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.d.ts +212 -195
  10. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +29 -18
  11. package/build/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.js.map +1 -1
  12. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.context.d.ts +1 -1
  13. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +3 -3
  14. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +1 -1
  15. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +5 -5
  16. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +1 -1
  17. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +195 -192
  18. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js +22 -18
  19. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +1 -1
  20. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.d.ts +212 -195
  21. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +29 -18
  22. package/build/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.js.map +1 -1
  23. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.context.d.ts +1 -1
  24. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +3 -3
  25. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +1 -1
  26. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +5 -5
  27. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +1 -1
  28. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +195 -192
  29. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js +22 -18
  30. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +1 -1
  31. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.d.ts +212 -195
  32. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +29 -18
  33. package/build/internal/cjs/src/automations-activation-logs-v1-activation-log-activation-log.universal.js.map +1 -1
  34. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.context.d.ts +1 -1
  35. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.d.ts +3 -3
  36. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.meta.js.map +1 -1
  37. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.public.d.ts +5 -5
  38. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.public.js.map +1 -1
  39. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.types.d.ts +195 -192
  40. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js +22 -18
  41. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.types.js.map +1 -1
  42. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.d.ts +212 -195
  43. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.js +29 -18
  44. package/build/internal/es/src/automations-activation-logs-v1-activation-log-activation-log.universal.js.map +1 -1
  45. package/package.json +4 -4
@@ -314,9 +314,9 @@ export interface ActivationContinuedAfterSchedule {
314
314
  automation?: Automation;
315
315
  }
316
316
  export interface Automation extends AutomationOriginInfoOneOf {
317
- /** Application info */
317
+ /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
318
318
  applicationInfo?: ApplicationOrigin;
319
- /** Preinstalled info */
319
+ /** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
320
320
  preinstalledInfo?: PreinstalledOrigin;
321
321
  /**
322
322
  * Automation ID.
@@ -325,37 +325,33 @@ export interface Automation extends AutomationOriginInfoOneOf {
325
325
  */
326
326
  id?: string | null;
327
327
  /**
328
- * Revision number, which increments by 1 each time the automation is updated.
329
- * To prevent conflicting changes,
330
- * the current revision must be passed when updating the automation.
331
- *
332
- * Ignored when creating an automation.
328
+ * Revision number. This increments by 1 whenever the automation is updated. Specify the current revision number whenever updating an existing automation.
333
329
  * @readonly
334
330
  */
335
331
  revision?: string | null;
336
332
  /**
337
- * Information about the creator of the automation.
333
+ * Who created the automation.
338
334
  * @immutable
339
335
  * @readonly
340
336
  */
341
337
  createdBy?: AuditInfo;
342
338
  /**
343
- * Date and time the automation was created.
339
+ * When the automation was created.
344
340
  * @readonly
345
341
  */
346
342
  createdDate?: Date | null;
347
343
  /**
348
- * The entity that last updated the automation.
344
+ * Who last updated the automation.
349
345
  * @readonly
350
346
  */
351
347
  updatedBy?: AuditInfo;
352
348
  /**
353
- * Date and time the automation was last updated.
349
+ * When the automation was last updated.
354
350
  * @readonly
355
351
  */
356
352
  updatedDate?: Date | null;
357
353
  /**
358
- * Automation name that is displayed on the user's site.
354
+ * Automation name as displayed on the user's site.
359
355
  * @minLength 1
360
356
  * @maxLength 500
361
357
  */
@@ -365,60 +361,71 @@ export interface Automation extends AutomationOriginInfoOneOf {
365
361
  * @maxLength 2000
366
362
  */
367
363
  description?: string | null;
368
- /** Object that defines the automation's trigger, actions, and activation status. */
364
+ /** Automation configuration. */
369
365
  configuration?: AutomationConfiguration;
370
366
  /**
371
- * Defines how the automation was added to the site.
367
+ * How the automation was added to the user's site.
372
368
  * @immutable
373
369
  */
374
370
  origin?: Origin;
375
371
  /** Automation settings. */
376
372
  settings?: AutomationSettings;
377
373
  /**
378
- * Draft info (optional - only if the automation is a draft)
374
+ * When the automation is a draft, the draft details.
379
375
  * @readonly
380
376
  */
381
377
  draftInfo?: DraftInfo;
382
378
  /**
383
- * Namespace
384
- * @maxLength 50
379
+ * Whether the automation is archived.
380
+ *
381
+ * To archive an automation, set this to `true`. To restore an archived automation, set this to `false`.
385
382
  */
386
- namespace?: string | null;
387
- /** Extended Fields */
388
- extendedFields?: ExtendedFields;
383
+ archived?: boolean;
389
384
  }
390
385
  /** @oneof */
391
386
  export interface AutomationOriginInfoOneOf {
392
- /** Application info */
387
+ /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
393
388
  applicationInfo?: ApplicationOrigin;
394
- /** Preinstalled info */
389
+ /** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
395
390
  preinstalledInfo?: PreinstalledOrigin;
396
391
  }
397
392
  export interface ActionSettings {
398
393
  /**
399
- * List of actions that cannot be deleted.
400
- * Default: Empty. All actions are deletable by default.
394
+ * Permanent actions. Permanent actions cannot be deleted.
395
+ *
396
+ * When empty, all actions can be deleted by the user.
401
397
  * @maxSize 30
402
398
  * @format GUID
403
399
  */
404
400
  permanentActionIds?: string[];
405
401
  /**
406
- * List of actions that cannot be edited.
407
- * Default: Empty. All actions are editable by default.
402
+ * Read-only actions. Read-only actions cannot be edited.
403
+ *
404
+ * When empty, all actions are editable.
408
405
  * @maxSize 30
409
406
  * @format GUID
410
407
  */
411
408
  readonlyActionIds?: string[];
412
- /** Whether the option to add a delay is disabled for the automation. */
409
+ /**
410
+ * Whether to disable the ability to add a delay to the automation.
411
+ *
412
+ * Default: `false`.
413
+ */
413
414
  disableDelayAddition?: boolean;
414
- /** Whether the option to add a condition is disabled for the automation. */
415
+ /**
416
+ * Whether to disable the ability to add a condition to the automation.
417
+ *
418
+ * Default: `false`.
419
+ */
415
420
  disableConditionAddition?: boolean;
416
421
  }
417
422
  export declare enum Domain {
418
423
  /** User domain (default). */
419
424
  USER = "USER",
420
425
  /** Wix domain. */
421
- WIX = "WIX"
426
+ WIX = "WIX",
427
+ /** Wix account-level domain. */
428
+ WIX_ACCOUNT = "WIX_ACCOUNT"
422
429
  }
423
430
  export interface Enrichment {
424
431
  /**
@@ -429,12 +436,14 @@ export interface Enrichment {
429
436
  }
430
437
  export interface AuditInfo extends AuditInfoIdOneOf {
431
438
  /**
432
- * User ID.
439
+ * [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
433
440
  * @format GUID
434
441
  */
435
442
  userId?: string;
436
443
  /**
437
- * Application ID.
444
+ * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
445
+ *
446
+ * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
438
447
  * @format GUID
439
448
  */
440
449
  appId?: string;
@@ -442,40 +451,45 @@ export interface AuditInfo extends AuditInfoIdOneOf {
442
451
  /** @oneof */
443
452
  export interface AuditInfoIdOneOf {
444
453
  /**
445
- * User ID.
454
+ * [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
446
455
  * @format GUID
447
456
  */
448
457
  userId?: string;
449
458
  /**
450
- * Application ID.
459
+ * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
460
+ *
461
+ * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
451
462
  * @format GUID
452
463
  */
453
464
  appId?: string;
454
465
  }
455
- /** Automation runtime configuration */
456
466
  export interface AutomationConfiguration {
457
467
  /** Status of the automation on the site. */
458
468
  status?: AutomationConfigurationStatus;
459
- /** Automation trigger configuration. */
469
+ /** Trigger configuration. */
460
470
  trigger?: Trigger;
461
471
  /**
462
- * List of IDs of root actions. Root actions are the first actions to run after the trigger. The actions in the list run in parallel.
472
+ * Root action IDs. A root action is the first action that runs after the trigger occurs. Root actions run in parallel.
473
+ *
474
+ * > **Note**: You can currently only specify 1 root action.
463
475
  * @maxSize 20
464
476
  * @format GUID
465
477
  */
466
478
  rootActionIds?: string[];
467
- /**
468
- * Map of all actions that the automation may execute.
469
- * The key is the action ID, and the value is the action configuration.
470
- */
479
+ /** 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. */
471
480
  actions?: Record<string, Action>;
472
481
  }
473
482
  export declare enum TimeUnit {
474
483
  UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
484
+ /** Minutes. */
475
485
  MINUTES = "MINUTES",
486
+ /** Hours. */
476
487
  HOURS = "HOURS",
488
+ /** Days. */
477
489
  DAYS = "DAYS",
490
+ /** Weeks. */
478
491
  WEEKS = "WEEKS",
492
+ /** Months. */
479
493
  MONTHS = "MONTHS"
480
494
  }
481
495
  export interface Filter {
@@ -485,42 +499,49 @@ export interface Filter {
485
499
  */
486
500
  id?: string;
487
501
  /**
488
- * Field key from the payload schema, for example "formId".
502
+ * Field key.
503
+ *
504
+ * You can find the field key in [the trigger payload schema](https://dev.wix.com/docs/rest/business-management/automations/triggers/the-trigger-payload-schema).
489
505
  * @minLength 1
490
506
  * @maxLength 110
491
507
  */
492
508
  fieldKey?: string;
493
509
  /**
494
- * Filter expression that evaluates to a boolean.
510
+ * Filter expression.
511
+ *
512
+ * For the automation to run, the expression must evaluate to `true`.
495
513
  * @maxLength 2500
496
514
  */
497
515
  filterExpression?: string;
498
516
  }
499
517
  export interface FutureDateActivationOffset {
500
518
  /**
501
- * The offset value. The value is always taken as negative, so that the automation runs before the trigger date.
502
- * To create an offset that causes the automation to run after the trigger date, use a delay action.
519
+ * Amount of time before the trigger to run the automation.
520
+ *
521
+ * > **Note**: To delay an automation after the trigger event occurs, use a [delay action](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#delay-action).
503
522
  * @maxLength 1000
504
523
  */
505
524
  preScheduledEventOffsetExpression?: string;
506
- /** Time unit for the scheduled event offset. */
525
+ /** Unit in which to set the action offset. */
507
526
  scheduledEventOffsetTimeUnit?: TimeUnit;
508
527
  }
509
528
  export interface RateLimit {
510
529
  /**
511
- * Value expressing the maximum number of times the trigger can be activated.
530
+ * Maximum number of times the trigger can be activated.
512
531
  * @maxLength 1000
513
532
  */
514
533
  maxActivationsExpression?: string;
515
534
  /**
516
- * Duration of the rate limiting window in the selected time unit. If no value is set, the rate limit is permanent.
535
+ * Duration of the rate limit. The rate limit applies for the specified duration and then expires.
536
+ *
537
+ * When empty, the rate limit does not expire.
517
538
  * @maxLength 1000
518
539
  */
519
540
  durationExpression?: string | null;
520
- /** Time unit for the rate limit duration. */
541
+ /** Unit in which to set the duration of the rate limit. */
521
542
  durationTimeUnit?: TimeUnit;
522
543
  /**
523
- * Unique identifier of each activation, by which rate limiter will count activations.
544
+ * Activation identifier used to count the number of activations.
524
545
  * @minLength 1
525
546
  * @maxLength 400
526
547
  */
@@ -528,17 +549,17 @@ export interface RateLimit {
528
549
  }
529
550
  export interface FilterValueSelection {
530
551
  /**
531
- * Values that can help the user filter certain automations, values will look like "<filter_id>__<selected_value>"
552
+ * Values that can help the user filter certain automations. Specify values in the following format: `<filter_id>__<selected_value>`.
532
553
  * @maxLength 80
533
554
  * @maxSize 50
534
555
  */
535
556
  selectedFilterValues?: string[];
536
557
  }
537
558
  export interface ConditionExpressionGroup {
538
- /** Expression group operator. */
559
+ /** Logical operator used to evaluate the condition expressions. */
539
560
  operator?: Operator;
540
561
  /**
541
- * List of boolean expressions to be evaluated with the given operator.
562
+ * Expressions evaluated using the selected operator.
542
563
  * @minSize 1
543
564
  * @maxSize 20
544
565
  * @maxLength 2500
@@ -546,25 +567,43 @@ export interface ConditionExpressionGroup {
546
567
  booleanExpressions?: string[];
547
568
  }
548
569
  export declare enum Operator {
570
+ /** Unknown. */
549
571
  UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
572
+ /** `OR` operator. */
550
573
  OR = "OR",
574
+ /** `AND` operator. */
551
575
  AND = "AND"
552
576
  }
577
+ /** Path definition */
578
+ export interface Path {
579
+ /**
580
+ * Unique path ID.
581
+ * @format GUID
582
+ */
583
+ id?: string;
584
+ /**
585
+ * Path display name.
586
+ * @minLength 1
587
+ * @maxLength 100
588
+ */
589
+ name?: string;
590
+ /**
591
+ * ID of the action to run when this path is taken.
592
+ * @format GUID
593
+ */
594
+ postActionId?: string | null;
595
+ }
553
596
  export declare enum Type {
554
- /** Automation will be triggered according to the trigger configuration. */
597
+ /** Based on the trigger. */
555
598
  UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
556
- /** App defined Action. */
599
+ /** Defined by a [Wix app](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#app-defined-actions). This action type is available in the site dashboard. */
557
600
  APP_DEFINED = "APP_DEFINED",
558
- /** Condition Action. */
601
+ /** Condition. This determines which action runs next. */
559
602
  CONDITION = "CONDITION",
560
- /** Delay Action. */
603
+ /** Delay. The automation must wait before executing the next step. */
561
604
  DELAY = "DELAY",
562
- /** RateLimit Action. */
563
- RATE_LIMIT = "RATE_LIMIT",
564
- /** Set Variables Action. */
565
- SET_VARIABLES = "SET_VARIABLES",
566
- /** Output Action. */
567
- OUTPUT = "OUTPUT"
605
+ /** Rate-limiter. This stops the automation flow if the subsequent action has reached its maximum allowed executions. */
606
+ RATE_LIMIT = "RATE_LIMIT"
568
607
  }
569
608
  export interface AppDefinedAction {
570
609
  /**
@@ -578,39 +617,39 @@ export interface AppDefinedAction {
578
617
  * @maxLength 100
579
618
  */
580
619
  actionKey?: string;
581
- /** Action input mapping. */
620
+ /** 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). */
582
621
  inputMapping?: Record<string, any> | null;
583
622
  /**
584
- * Array of conditions determining whether to skip the action in the automation flow.
585
- * The action will be skipped if any of the expression groups evaluate to `true`.
586
- * Actions following a skipped action will still run.
623
+ * Action skip conditions. An action is skipped if any of the specified conditions evaluates to `true`.
624
+ *
625
+ * > **Note**: Actions that follow a skipped action still run.
587
626
  * @maxSize 10
588
627
  */
589
628
  skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
590
629
  /**
591
- * List of IDs of actions to run in parallel once the action completes.
630
+ * IDs of actions that run in parallel after the action completes.
592
631
  * @maxSize 20
593
632
  * @format GUID
594
633
  */
595
634
  postActionIds?: string[];
596
- /** Optional output schema of the action. It will be used instead the action schema in case it's provided. */
635
+ /** Action output schema. When specified, this replaces the action schema. */
597
636
  overrideOutputSchema?: Record<string, any> | null;
598
637
  }
599
638
  export interface ConditionAction {
600
639
  /**
601
- * The condition evaluates to `true` if either of the expression groups evaluate to `true`.
640
+ * Condition is `true` if one or more of the expression groups evaluates to `true`.
602
641
  * @minSize 1
603
642
  * @maxSize 10
604
643
  */
605
644
  orExpressionGroups?: ConditionExpressionGroup[];
606
645
  /**
607
- * List of IDs of actions to run when the entire condition is evaluated to `true`.
646
+ * IDs of actions to run when the condition evaluates to `true`.
608
647
  * @maxSize 20
609
648
  * @format GUID
610
649
  */
611
650
  truePostActionIds?: string[];
612
651
  /**
613
- * List of IDs of actions to run when the entire condition is evaluated to `false`.
652
+ * IDs of actions to run when the condition evaluates to `false`.
614
653
  * @maxSize 20
615
654
  * @format GUID
616
655
  */
@@ -618,21 +657,23 @@ export interface ConditionAction {
618
657
  }
619
658
  export interface DelayAction {
620
659
  /**
621
- * Value expressing the amount of time to wait from a specific date or from the time the action is executed.
660
+ * Time to wait before running the action. The wait time starts from when the current action completes.
661
+ *
662
+ * > **Note**: To define the wait time from a specific moment in time, use `dueDateEpochExpression`.
622
663
  * @maxLength 1000
623
664
  */
624
665
  offsetExpression?: string | null;
625
- /** Time unit for delay offset. */
666
+ /** Unit in which to set the wait time to wait before the action runs. */
626
667
  offsetTimeUnit?: TimeUnit;
627
668
  /**
628
- * The action due date. If defined without an offset, the automation will wait until this date to execute the next step.
629
- * If an offset is defined, it's calculated from this date.
630
- * The date is expressed in the number of milliseconds since the Unix Epoch (1 January, 1970 UTC).
669
+ * Action run date in milliseconds elapsed since January 1, 1970 UTC.
670
+ *
671
+ * > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
631
672
  * @maxLength 1000
632
673
  */
633
674
  dueDateEpochExpression?: string | null;
634
675
  /**
635
- * List of IDs of actions to run in parallel after the delay.
676
+ * IDs of actions to run in parallel after the time delay.
636
677
  * @maxSize 20
637
678
  * @format GUID
638
679
  */
@@ -640,17 +681,18 @@ export interface DelayAction {
640
681
  }
641
682
  export interface RateLimitAction {
642
683
  /**
643
- * The maximum number of activations allowed for the action.
684
+ * Maximum number of times the action can run.
644
685
  * @maxLength 1000
645
686
  */
646
687
  maxActivationsExpression?: string;
647
688
  /**
648
- * Duration of the rate limiting window, expressed in selected time unit.
649
- * If no value is set, then there is no time limit on the rate limiter.
689
+ * Rate limit duration.
690
+ *
691
+ * When empty, the rate limit does not expire.
650
692
  * @maxLength 1000
651
693
  */
652
694
  rateLimitDurationExpression?: string | null;
653
- /** Time unit for the rate limit duration. */
695
+ /** Unit in which to set the duration of the rate limit. */
654
696
  rateLimitDurationTimeUnit?: TimeUnit;
655
697
  /**
656
698
  * Unique identifier of each activation by which rate limiter counts activations.
@@ -659,25 +701,23 @@ export interface RateLimitAction {
659
701
  */
660
702
  uniqueIdentifierExpression?: string | null;
661
703
  /**
662
- * List of IDs of actions to run in parallel once the action completes.
704
+ * IDs of actions to run in parallel after the action completes.
663
705
  * @maxSize 20
664
706
  * @format GUID
665
707
  */
666
708
  postActionIds?: string[];
667
709
  }
668
710
  export interface SetVariablesAction {
669
- /**
670
- * output mapping
671
- * for example: {"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }
672
- */
711
+ /** Output mapping. For example: `{"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }`. */
673
712
  outputMapping?: Record<string, any> | null;
674
713
  /**
675
- * output json schema representation
676
- * could be string instead of Struct (and introduce some compression to minimize the size of it)
714
+ * Output JSON schema representation.
715
+ *
716
+ * > **Note**: To minimize request size, you can also specify a string.
677
717
  */
678
718
  outputSchema?: Record<string, any> | null;
679
719
  /**
680
- * List of IDs of actions to run in parallel after variable initialization.
720
+ * IDs of actions to run in parallel after variable initialization.
681
721
  * @maxSize 20
682
722
  * @format GUID
683
723
  */
@@ -687,12 +727,20 @@ export interface OutputAction {
687
727
  /** Output action output mapping. */
688
728
  outputMapping?: Record<string, any> | null;
689
729
  }
730
+ export interface SplitAction {
731
+ /**
732
+ * List of paths to split execution into.
733
+ * @minSize 2
734
+ * @maxSize 10
735
+ */
736
+ paths?: Path[];
737
+ }
690
738
  export declare enum AutomationConfigurationStatus {
691
- /** unused */
739
+ /** Unknown. */
692
740
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
693
- /** Automation will be triggered according to the trigger configuration */
741
+ /** Active. Active automations can be triggered. */
694
742
  ACTIVE = "ACTIVE",
695
- /** Automation will not be triggered */
743
+ /** Inactive. Inactive automations cannot be triggered. */
696
744
  INACTIVE = "INACTIVE"
697
745
  }
698
746
  export interface Trigger {
@@ -703,51 +751,52 @@ export interface Trigger {
703
751
  appId?: string;
704
752
  /**
705
753
  * Trigger key.
754
+ *
755
+ * Learn about [setting up a trigger](https://dev.wix.com/docs/rest/business-management/automations/triggers/add-a-trigger-to-your-app#step-1--set-up-the-trigger).
706
756
  * @minLength 1
707
757
  * @maxLength 100
708
758
  */
709
759
  triggerKey?: string;
710
760
  /**
711
- * List of filters on schema fields.
712
- * In order for the automation to run, all filter expressions must evaluate to `true` for a given payload.
761
+ * Schema field filters. All filter conditions must be met for the automation to run.
762
+ *
763
+ * Learn more about setting up [automation filters](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#filters).
713
764
  * @maxSize 5
714
765
  */
715
766
  filters?: Filter[];
716
- /** Defines the time offset between the trigger date and when the automation runs. */
717
- scheduledEventOffset?: FutureDateActivationOffset;
718
- /** Limits the number of times an automation can be triggered. */
719
- rateLimit?: RateLimit;
720
767
  /**
721
- * An optional configuration, per automation, of a schema that is optionally offered by the trigger provider to affect the behavior of the trigger.
722
- * For example, a trigger provider may offer a schema that allows the user to configure the trigger to happen at a certain time of day,
723
- * He would define a schema with a field called "startDate" and using this parameter the user can define his preferred startDate, per automation.
768
+ * Automation offset. You can schedule automations to run before the trigger occurs.
769
+ *
770
+ * Learn more about [scheduled events](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/configure-your-automation#scheduled-events).
724
771
  */
725
- automationConfigMapping?: Record<string, any> | null;
726
- /** Optional schema of the trigger. It will be used instead the trigger schema in case it's provided. */
772
+ scheduledEventOffset?: FutureDateActivationOffset;
773
+ /** Limit on the number of times an automation can be triggered. */
774
+ rateLimit?: RateLimit;
775
+ /** Trigger schema override. When specified, this replaces the trigger schema. */
727
776
  overrideSchema?: Record<string, any> | null;
728
777
  }
729
778
  export interface Action extends ActionInfoOneOf {
730
- /** Action defined by an app (via RPC, HTTP or Velo). */
779
+ /** Details of the action when its `type` is `APP_DEFINED`. */
731
780
  appDefinedInfo?: AppDefinedAction;
732
- /** Condition action. */
781
+ /** Details of the action when its `type` is `CONDITION`. */
733
782
  conditionInfo?: ConditionAction;
734
- /** Delay action. */
783
+ /** Details of the action when its `type` is `DELAY`. */
735
784
  delayInfo?: DelayAction;
736
- /** Rate-limiting action. */
785
+ /** Details of the action when its `type` is `RATE_LIMIT`. */
737
786
  rateLimitInfo?: RateLimitAction;
738
787
  /**
739
- * Action ID. If not specified, a new ID is generated.
788
+ * Action ID.
789
+ *
790
+ * If not specified, automatically generated by Wix.
740
791
  * @format GUID
741
792
  */
742
793
  id?: string | null;
743
- /** Action type. */
794
+ /** [Action type](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#action-type). */
744
795
  type?: Type;
745
796
  /**
746
- * Human-readable name to differentiate the action from other actions of the same type.
747
- * The name can contain only alphanumeric characters and underscores. If not provided, a namespace in the form `actionkey-indexOfAction` is
748
- * generated automatically.
749
- * If the action has output, the output will be available in the payload under this name.
750
- * If the user has multiple actions with the same appId and actionKey, previous action output will be overwritten.
797
+ * [Action namespace](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#namespace). This differentiates it from other actions of the same type.
798
+ *
799
+ * If the action outputs any data, the data appears under the namespace in the payload sent to the subsequent steps in the automation. If the user has multiple actions with the same `appId` and `actionKey`, the output of the previous action is overwritten.
751
800
  * @minLength 1
752
801
  * @maxLength 100
753
802
  */
@@ -755,18 +804,18 @@ export interface Action extends ActionInfoOneOf {
755
804
  }
756
805
  /** @oneof */
757
806
  export interface ActionInfoOneOf {
758
- /** Action defined by an app (via RPC, HTTP or Velo). */
807
+ /** Details of the action when its `type` is `APP_DEFINED`. */
759
808
  appDefinedInfo?: AppDefinedAction;
760
- /** Condition action. */
809
+ /** Details of the action when its `type` is `CONDITION`. */
761
810
  conditionInfo?: ConditionAction;
762
- /** Delay action. */
811
+ /** Details of the action when its `type` is `DELAY`. */
763
812
  delayInfo?: DelayAction;
764
- /** Rate-limiting action. */
813
+ /** Details of the action when its `type` is `RATE_LIMIT`. */
765
814
  rateLimitInfo?: RateLimitAction;
766
815
  }
767
816
  export interface FilterableAppDefinedActions {
768
817
  /**
769
- * App defined action identifiers, each identifier in form `${appId}_${actionKey}`
818
+ * App-defined action identifiers. Identifiers have the following format: `${appId}_${actionKey}`.
770
819
  * @minSize 1
771
820
  * @maxSize 100
772
821
  * @minLength 1
@@ -775,48 +824,40 @@ export interface FilterableAppDefinedActions {
775
824
  actionIdentifiers?: string[];
776
825
  }
777
826
  export declare enum Origin {
778
- /** Default value. This is unused. */
827
+ /** Default value. */
779
828
  UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
780
- /** User created automation. */
829
+ /** Created by a [Wix user](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-user). */
781
830
  USER = "USER",
782
- /** Automation created by application (site specific). */
831
+ /** Created by a [Wix app](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-app) for a particular site. */
783
832
  APPLICATION = "APPLICATION",
784
- /** Preinstalled application automation. */
785
- PREINSTALLED = "PREINSTALLED",
786
- /** Automation created from a recipe. */
787
- RECIPE = "RECIPE"
833
+ /** [Preinstalled automation](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/pre-installed-automations/about-pre-installed-automations). */
834
+ PREINSTALLED = "PREINSTALLED"
788
835
  }
789
836
  export interface ApplicationOrigin {
790
837
  /**
791
- * Application ID.
838
+ * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
839
+ *
840
+ * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
792
841
  * @format GUID
793
842
  */
794
843
  appId?: string;
795
- /**
796
- * External ID to correlate multiple sites to an automation
797
- * @format GUID
798
- */
799
- appDefinedExternalId?: string | null;
800
844
  }
801
845
  export interface PreinstalledOrigin {
802
846
  /**
803
- * ID of the app that defines the preinstalled automation.
847
+ * ID of the app that added the [preinstalled automation](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/pre-installed-automations/about-pre-installed-automations).
804
848
  * @format GUID
805
849
  */
806
850
  appId?: string;
807
851
  /**
808
- * Application component ID.
809
- * @format GUID
810
- */
811
- componentId?: string;
812
- /** Application component version. */
813
- componentVersion?: number;
814
- /**
815
- * Whether the automation is an override automation. If the user modifies the preinstalled automation installed on their site, a site-specific
816
- * automation is created that overrides the original one. If the user makes no modifications this boolean is set to `false` and the original
817
- * preinstalled automation is used.
852
+ * Whether the automation is an override.
818
853
  *
819
- * Default: `false`
854
+ * When a user modifies the preinstalled automation installed on their site, a site-specific version of the automation is created that overrides the automation that was originally installed. This override automation has the same automation ID as the original preinstalled automation.
855
+ *
856
+ * > **Note**: An override automation can no longer be updated by the app that originally installed it.
857
+ * >
858
+ * > To revert to the original preinstalled version, the user must delete the override by calling the Delete Automation method. Calling Delete Automation on an override automation removes the override method and restores the preinstalled automation that was previously installed.
859
+ *
860
+ * Default: `false`.
820
861
  * @immutable
821
862
  * @readonly
822
863
  */
@@ -825,22 +866,26 @@ export interface PreinstalledOrigin {
825
866
  export interface AutomationSettings {
826
867
  /**
827
868
  * Whether the automation is hidden from users.
869
+ *
828
870
  * Default: `false`
829
871
  */
830
872
  hidden?: boolean;
831
873
  /**
832
874
  * Whether the automation is read-only.
875
+ *
833
876
  * Default: `false`
834
877
  */
835
878
  readonly?: boolean;
836
879
  /**
837
- * Whether the option to delete the automation from the site is disabled.
838
- * Default: `false`
880
+ * Whether to disable the option to delete the automation from the site.
881
+ *
882
+ * Default: `false`.
839
883
  */
840
884
  disableDelete?: boolean;
841
885
  /**
842
- * Whether the option to change the automation status (from active to inactive and vice versa) is disabled.
843
- * Default: `false`
886
+ * Whether to disable the option to change the automation's `configuration.status`, for example from `ACTIVE` to `INACTIVE`.
887
+ *
888
+ * Default: `false`.
844
889
  */
845
890
  disableStatusChange?: boolean;
846
891
  /** Automation action settings. */
@@ -848,7 +893,7 @@ export interface AutomationSettings {
848
893
  }
849
894
  export interface DraftInfo {
850
895
  /**
851
- * Optional - automationId of the original automation.
896
+ * ID of the original automation.
852
897
  * @format GUID
853
898
  * @readonly
854
899
  */
@@ -918,7 +963,7 @@ export interface ListActivationLogsRequest extends ListActivationLogsRequestIden
918
963
  /** Should return payload in the response */
919
964
  includePayload?: boolean | null;
920
965
  /** identifier type for the activations to list */
921
- identifierType?: IdentifierType;
966
+ identifierType: IdentifierType;
922
967
  }
923
968
  /** @oneof */
924
969
  export interface ListActivationLogsRequestIdentifierOneOf {
@@ -1100,45 +1145,3 @@ export declare enum WebhookIdentityType {
1100
1145
  WIX_USER = "WIX_USER",
1101
1146
  APP = "APP"
1102
1147
  }
1103
- interface InitiatedStatusInfoNonNullableFields {
1104
- target: Target;
1105
- }
1106
- interface ScheduledStatusInfoNonNullableFields {
1107
- scheduleId: string;
1108
- }
1109
- interface CancelledStatusInfoNonNullableFields {
1110
- reason: CancellationReason;
1111
- }
1112
- interface FailedStatusInfoNonNullableFields {
1113
- errorDescription: string;
1114
- errorReason: ErrorReason;
1115
- }
1116
- interface SkippedStatusInfoNonNullableFields {
1117
- reason: SkipReason;
1118
- }
1119
- interface WarningNonNullableFields {
1120
- errorDescription: string;
1121
- reason: WarningReason;
1122
- }
1123
- interface ActivationLogNonNullableFields {
1124
- id: string;
1125
- automationId: string;
1126
- automationRevision: string;
1127
- status: Status;
1128
- initiatedInfo?: InitiatedStatusInfoNonNullableFields;
1129
- scheduledInfo?: ScheduledStatusInfoNonNullableFields;
1130
- cancelledInfo?: CancelledStatusInfoNonNullableFields;
1131
- failedInfo?: FailedStatusInfoNonNullableFields;
1132
- skippedInfo?: SkippedStatusInfoNonNullableFields;
1133
- warnings: WarningNonNullableFields[];
1134
- }
1135
- export interface GetActivationLogResponseNonNullableFields {
1136
- activationLog?: ActivationLogNonNullableFields;
1137
- }
1138
- export interface ListActivationLogsResponseNonNullableFields {
1139
- activationLogs: ActivationLogNonNullableFields[];
1140
- }
1141
- export interface SearchActivationLogsByPayloadPiiValueResponseNonNullableFields {
1142
- activationLogs: ActivationLogNonNullableFields[];
1143
- }
1144
- export {};