@wix/automations 1.0.75 → 1.0.77

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.
@@ -2388,10 +2388,6 @@ interface AutomationOriginInfoOneOf$1 {
2388
2388
  /** Preinstalled info */
2389
2389
  preinstalledInfo?: PreinstalledOrigin$1;
2390
2390
  }
2391
- interface Enrichment$1 {
2392
- /** Enrichment input mappings. */
2393
- inputMappings?: Record<string, any>[] | null;
2394
- }
2395
2391
  interface ActionSettings$1 {
2396
2392
  /**
2397
2393
  * List of actions that cannot be deleted.
@@ -2414,6 +2410,10 @@ declare enum Domain$1 {
2414
2410
  /** Wix domain. */
2415
2411
  WIX = "WIX"
2416
2412
  }
2413
+ interface Enrichment$1 {
2414
+ /** Enrichment input mappings. */
2415
+ inputMappings?: Record<string, any>[] | null;
2416
+ }
2417
2417
  interface AuditInfo$1 extends AuditInfoIdOneOf$1 {
2418
2418
  /** User ID. */
2419
2419
  userId?: string;
@@ -3040,10 +3040,6 @@ declare enum WebhookIdentityType$1 {
3040
3040
  WIX_USER = "WIX_USER",
3041
3041
  APP = "APP"
3042
3042
  }
3043
- interface BatchActivationRequest {
3044
- /** List of Activation-Request. */
3045
- activationRequests?: ActivationRequest[];
3046
- }
3047
3043
  interface ActivationRequest {
3048
3044
  /** Activation's ID. */
3049
3045
  activationId?: string;
@@ -3271,6 +3267,227 @@ interface ActionsData {
3271
3267
  /** Map of action id to action data. */
3272
3268
  actions?: Record<string, Action$1>;
3273
3269
  }
3270
+ interface ActionStatus {
3271
+ /** Action's status. */
3272
+ _id?: string;
3273
+ /** Activation's ID. */
3274
+ activationId?: string;
3275
+ /** Action's name. */
3276
+ actionName?: string | null;
3277
+ /** Action's status. */
3278
+ status?: Status$1;
3279
+ /** Action's error reason (if there is one). */
3280
+ errorReason?: string | null;
3281
+ /** Activation external id. */
3282
+ activationExternalId?: string;
3283
+ /** Trigger app id. */
3284
+ triggerAppId?: string | null;
3285
+ /** Trigger key. */
3286
+ triggerKey?: string | null;
3287
+ /** The configuration correlation id */
3288
+ configurationCorrelationId?: string | null;
3289
+ }
3290
+ interface BatchActivationRequest {
3291
+ /** List of Activation-Request. */
3292
+ activationRequests?: ActivationRequest[];
3293
+ }
3294
+ interface Empty$1 {
3295
+ }
3296
+ interface ActivationActionStatusChanged extends ActivationActionStatusChangedStatusInfoOneOf {
3297
+ /** Started status information */
3298
+ startedInfo?: StartedStatusInfo;
3299
+ /** Ended status information */
3300
+ endedInfo?: EndedStatusInfo;
3301
+ /** Failed status information */
3302
+ failedInfo?: FailedStatusInfo;
3303
+ /** Action ID */
3304
+ _id?: string;
3305
+ /** Activation ID */
3306
+ activationId?: string;
3307
+ /** Automation info */
3308
+ automationInfo?: AutomationInfo;
3309
+ /** Action type */
3310
+ type?: Type$1;
3311
+ /** Event date */
3312
+ statusChangedDate?: Date | null;
3313
+ /** Action activation status */
3314
+ status?: ActivationActionStatusChangedStatus;
3315
+ }
3316
+ /** @oneof */
3317
+ interface ActivationActionStatusChangedStatusInfoOneOf {
3318
+ /** Started status information */
3319
+ startedInfo?: StartedStatusInfo;
3320
+ /** Ended status information */
3321
+ endedInfo?: EndedStatusInfo;
3322
+ /** Failed status information */
3323
+ failedInfo?: FailedStatusInfo;
3324
+ }
3325
+ interface StartedStatusInfoAppDefinedActionInfo {
3326
+ /** Action input */
3327
+ input?: Record<string, any> | null;
3328
+ }
3329
+ interface StartedStatusInfoDelayActionInfo {
3330
+ /** Indicates when this action becomes completed and the activation will move to the post actions */
3331
+ date?: Date | null;
3332
+ }
3333
+ interface ExpressionEvaluationResult {
3334
+ /** Indicates if the expression was evaluated to true or false */
3335
+ passed?: boolean;
3336
+ /** Indicates if there was an error in the evaluation process */
3337
+ error?: boolean;
3338
+ }
3339
+ interface AppDefinedActionInfo {
3340
+ /** Output returned by the action implementer. */
3341
+ output?: Record<string, any> | null;
3342
+ }
3343
+ interface ConditionActionInfo {
3344
+ /** Indicates that the condition `if` clause evaluated to `true`. */
3345
+ passed?: boolean;
3346
+ /** Collects results per each expression evaluation that took place */
3347
+ expressionResults?: Record<string, ExpressionEvaluationResult>;
3348
+ }
3349
+ interface RateLimitActionInfo {
3350
+ /** Indicates if the rate limiter passed (not reached the quota) */
3351
+ passed?: boolean;
3352
+ }
3353
+ interface DelayActionInfo {
3354
+ /** Enriched and refreshed payload */
3355
+ payload?: Record<string, any> | null;
3356
+ }
3357
+ interface AutomationInfo extends AutomationInfoOriginInfoOneOf {
3358
+ /** Application info */
3359
+ applicationInfo?: ApplicationOrigin$1;
3360
+ /** Preinstalled info */
3361
+ preinstalledInfo?: PreinstalledOrigin$1;
3362
+ /** Automation ID */
3363
+ _id?: string;
3364
+ /** Origin type */
3365
+ origin?: Origin$1;
3366
+ }
3367
+ /** @oneof */
3368
+ interface AutomationInfoOriginInfoOneOf {
3369
+ /** Application info */
3370
+ applicationInfo?: ApplicationOrigin$1;
3371
+ /** Preinstalled info */
3372
+ preinstalledInfo?: PreinstalledOrigin$1;
3373
+ }
3374
+ declare enum ActivationActionStatusChangedStatus {
3375
+ UNKNOWN_ACTION_ACTIVATION_STATUS = "UNKNOWN_ACTION_ACTIVATION_STATUS",
3376
+ /**
3377
+ * Indicates that action activation has started and is in progress.
3378
+ * Relevant to action types: APP_DEFINED, DELAY.
3379
+ */
3380
+ STARTED = "STARTED",
3381
+ /**
3382
+ * Indicates that the action activation was completed without errors.
3383
+ * Relevant to action types: APP_DEFINED, DELAY, CONDITION, RATE_LIMIT.
3384
+ */
3385
+ ENDED = "ENDED",
3386
+ /**
3387
+ * Indicates that the action was skipped and post actions won't start.
3388
+ * Relevant to action types: APP_DEFINED.
3389
+ */
3390
+ SKIPPED = "SKIPPED",
3391
+ /**
3392
+ * Indicates that the action failed.
3393
+ * Relevant to action types: APP_DEFINED, DELAY, RATE_LIMIT.
3394
+ */
3395
+ FAILED = "FAILED"
3396
+ }
3397
+ interface StartedStatusInfo extends StartedStatusInfoTypeInfoOneOf {
3398
+ /** APP DEFINED action additional info */
3399
+ appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
3400
+ /** Delay action additional info */
3401
+ delayActionInfo?: StartedStatusInfoDelayActionInfo;
3402
+ }
3403
+ /** @oneof */
3404
+ interface StartedStatusInfoTypeInfoOneOf {
3405
+ /** APP DEFINED action additional info */
3406
+ appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
3407
+ /** Delay action additional info */
3408
+ delayActionInfo?: StartedStatusInfoDelayActionInfo;
3409
+ }
3410
+ interface EndedStatusInfo extends EndedStatusInfoTypeInfoOneOf {
3411
+ /** APP DEFINED action additional info */
3412
+ appDefinedActionInfo?: AppDefinedActionInfo;
3413
+ /** Condition action additional info */
3414
+ conditionActionInfo?: ConditionActionInfo;
3415
+ /** Rate limit action additional info */
3416
+ rateLimitActionInfo?: RateLimitActionInfo;
3417
+ /** Delay action additional info */
3418
+ delayActionInfo?: DelayActionInfo;
3419
+ }
3420
+ /** @oneof */
3421
+ interface EndedStatusInfoTypeInfoOneOf {
3422
+ /** APP DEFINED action additional info */
3423
+ appDefinedActionInfo?: AppDefinedActionInfo;
3424
+ /** Condition action additional info */
3425
+ conditionActionInfo?: ConditionActionInfo;
3426
+ /** Rate limit action additional info */
3427
+ rateLimitActionInfo?: RateLimitActionInfo;
3428
+ /** Delay action additional info */
3429
+ delayActionInfo?: DelayActionInfo;
3430
+ }
3431
+ interface FailedStatusInfo {
3432
+ /** Error description */
3433
+ errorDescription?: string;
3434
+ /** Error code */
3435
+ errorCode?: string | null;
3436
+ }
3437
+ interface ActivationResumeAfterDelay {
3438
+ /** Activation identifier */
3439
+ _id?: string;
3440
+ /** Activation schedule identifier */
3441
+ scheduleId?: string;
3442
+ /** Activation schedule due date */
3443
+ scheduleDate?: Date | null;
3444
+ /** Activation payload */
3445
+ payload?: Record<string, any> | null;
3446
+ /** Activation Automation */
3447
+ automation?: Automation$1;
3448
+ /** Scheduled action identifier - with the intent to execute that action's post actions */
3449
+ scheduledActionId?: string;
3450
+ /** Optional - external entity id that this activation is related to */
3451
+ externalEntityId?: string | null;
3452
+ }
3453
+ interface ActionCompletedRequest {
3454
+ /** The execution identifier that was given to the spi provider when we invoked the action */
3455
+ executionIdentifier?: string;
3456
+ /** The result of invoking the action. Must conform to the output schema configured by the action provider. */
3457
+ result?: Record<string, any> | null;
3458
+ }
3459
+ interface RefreshPayloadRequest {
3460
+ /** Application definition ID. */
3461
+ appDefId?: string;
3462
+ /** Trigger key. */
3463
+ triggerKey?: string;
3464
+ /** Payload to refresh. */
3465
+ payload?: Record<string, any> | null;
3466
+ /** External entity ID. */
3467
+ externalEntityId?: string | null;
3468
+ }
3469
+ interface RefreshPayloadResponse {
3470
+ /** Updated payload. */
3471
+ payload?: Record<string, any> | null;
3472
+ /** If the automation activation should be canceled (default is false) */
3473
+ cancelActivation?: boolean | null;
3474
+ }
3475
+ interface RunAutomationRequest {
3476
+ /** App of the automation trigger */
3477
+ appId?: string;
3478
+ /** Trigger key of the action */
3479
+ triggerKey?: string;
3480
+ /** Payload of the triggered event */
3481
+ triggerPayload?: Record<string, any> | null;
3482
+ /** Specific automation id to run */
3483
+ automationId?: string;
3484
+ /** Schema of the trigger */
3485
+ triggerSchema?: Record<string, any> | null;
3486
+ }
3487
+ interface RunAutomationResponse {
3488
+ /** Automation activation output payload */
3489
+ output?: Record<string, any> | null;
3490
+ }
3274
3491
  interface ActivationScheduleRequested {
3275
3492
  /** Activation identifier */
3276
3493
  _id?: string;
@@ -3539,236 +3756,19 @@ interface ExecuteFromActionRequest {
3539
3756
  }
3540
3757
  interface ExecuteFromActionResponse {
3541
3758
  }
3542
- interface Empty$1 {
3543
- }
3544
- interface ActivationScheduleCompleted {
3545
- /** Activation identifier */
3546
- _id?: string;
3547
- /** Activation schedule identifier */
3548
- scheduleId?: string;
3549
- /** Activation schedule due date */
3550
- scheduleDate?: Date | null;
3551
- /** Activation payload */
3552
- payload?: Record<string, any> | null;
3553
- /** Activation Automation */
3554
- automation?: Automation$1;
3555
- /** Optional - external entity id that this activation is related to */
3556
- externalEntityId?: string | null;
3557
- }
3558
- interface ActionStatus {
3559
- /** Action's status. */
3560
- _id?: string;
3561
- /** Activation's ID. */
3562
- activationId?: string;
3563
- /** Action's name. */
3564
- actionName?: string | null;
3565
- /** Action's status. */
3566
- status?: Status$1;
3567
- /** Action's error reason (if there is one). */
3568
- errorReason?: string | null;
3569
- /** Activation external id. */
3570
- activationExternalId?: string;
3571
- /** Trigger app id. */
3572
- triggerAppId?: string | null;
3573
- /** Trigger key. */
3574
- triggerKey?: string | null;
3575
- /** The configuration correlation id */
3576
- configurationCorrelationId?: string | null;
3577
- }
3578
- interface ActivationActionStatusChanged extends ActivationActionStatusChangedStatusInfoOneOf {
3579
- /** Started status information */
3580
- startedInfo?: StartedStatusInfo;
3581
- /** Ended status information */
3582
- endedInfo?: EndedStatusInfo;
3583
- /** Failed status information */
3584
- failedInfo?: FailedStatusInfo;
3585
- /** Action ID */
3586
- _id?: string;
3587
- /** Activation ID */
3588
- activationId?: string;
3589
- /** Automation info */
3590
- automationInfo?: AutomationInfo;
3591
- /** Action type */
3592
- type?: Type$1;
3593
- /** Event date */
3594
- statusChangedDate?: Date | null;
3595
- /** Action activation status */
3596
- status?: ActivationActionStatusChangedStatus;
3597
- }
3598
- /** @oneof */
3599
- interface ActivationActionStatusChangedStatusInfoOneOf {
3600
- /** Started status information */
3601
- startedInfo?: StartedStatusInfo;
3602
- /** Ended status information */
3603
- endedInfo?: EndedStatusInfo;
3604
- /** Failed status information */
3605
- failedInfo?: FailedStatusInfo;
3606
- }
3607
- interface StartedStatusInfoAppDefinedActionInfo {
3608
- /** Action input */
3609
- input?: Record<string, any> | null;
3610
- }
3611
- interface StartedStatusInfoDelayActionInfo {
3612
- /** Indicates when this action becomes completed and the activation will move to the post actions */
3613
- date?: Date | null;
3614
- }
3615
- interface ExpressionEvaluationResult {
3616
- /** Indicates if the expression was evaluated to true or false */
3617
- passed?: boolean;
3618
- /** Indicates if there was an error in the evaluation process */
3619
- error?: boolean;
3620
- }
3621
- interface AppDefinedActionInfo {
3622
- /** Output returned by the action implementer. */
3623
- output?: Record<string, any> | null;
3624
- }
3625
- interface ConditionActionInfo {
3626
- /** Indicates that the condition `if` clause evaluated to `true`. */
3627
- passed?: boolean;
3628
- /** Collects results per each expression evaluation that took place */
3629
- expressionResults?: Record<string, ExpressionEvaluationResult>;
3630
- }
3631
- interface RateLimitActionInfo {
3632
- /** Indicates if the rate limiter passed (not reached the quota) */
3633
- passed?: boolean;
3634
- }
3635
- interface DelayActionInfo {
3636
- /** Enriched and refreshed payload */
3637
- payload?: Record<string, any> | null;
3638
- }
3639
- interface AutomationInfo extends AutomationInfoOriginInfoOneOf {
3640
- /** Application info */
3641
- applicationInfo?: ApplicationOrigin$1;
3642
- /** Preinstalled info */
3643
- preinstalledInfo?: PreinstalledOrigin$1;
3644
- /** Automation ID */
3645
- _id?: string;
3646
- /** Origin type */
3647
- origin?: Origin$1;
3648
- }
3649
- /** @oneof */
3650
- interface AutomationInfoOriginInfoOneOf {
3651
- /** Application info */
3652
- applicationInfo?: ApplicationOrigin$1;
3653
- /** Preinstalled info */
3654
- preinstalledInfo?: PreinstalledOrigin$1;
3655
- }
3656
- declare enum ActivationActionStatusChangedStatus {
3657
- UNKNOWN_ACTION_ACTIVATION_STATUS = "UNKNOWN_ACTION_ACTIVATION_STATUS",
3658
- /**
3659
- * Indicates that action activation has started and is in progress.
3660
- * Relevant to action types: APP_DEFINED, DELAY.
3661
- */
3662
- STARTED = "STARTED",
3663
- /**
3664
- * Indicates that the action activation was completed without errors.
3665
- * Relevant to action types: APP_DEFINED, DELAY, CONDITION, RATE_LIMIT.
3666
- */
3667
- ENDED = "ENDED",
3668
- /**
3669
- * Indicates that the action was skipped and post actions won't start.
3670
- * Relevant to action types: APP_DEFINED.
3671
- */
3672
- SKIPPED = "SKIPPED",
3673
- /**
3674
- * Indicates that the action failed.
3675
- * Relevant to action types: APP_DEFINED, DELAY, RATE_LIMIT.
3676
- */
3677
- FAILED = "FAILED"
3678
- }
3679
- interface StartedStatusInfo extends StartedStatusInfoTypeInfoOneOf {
3680
- /** APP DEFINED action additional info */
3681
- appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
3682
- /** Delay action additional info */
3683
- delayActionInfo?: StartedStatusInfoDelayActionInfo;
3684
- }
3685
- /** @oneof */
3686
- interface StartedStatusInfoTypeInfoOneOf {
3687
- /** APP DEFINED action additional info */
3688
- appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
3689
- /** Delay action additional info */
3690
- delayActionInfo?: StartedStatusInfoDelayActionInfo;
3691
- }
3692
- interface EndedStatusInfo extends EndedStatusInfoTypeInfoOneOf {
3693
- /** APP DEFINED action additional info */
3694
- appDefinedActionInfo?: AppDefinedActionInfo;
3695
- /** Condition action additional info */
3696
- conditionActionInfo?: ConditionActionInfo;
3697
- /** Rate limit action additional info */
3698
- rateLimitActionInfo?: RateLimitActionInfo;
3699
- /** Rate limit action additional info */
3700
- delayActionInfo?: DelayActionInfo;
3701
- }
3702
- /** @oneof */
3703
- interface EndedStatusInfoTypeInfoOneOf {
3704
- /** APP DEFINED action additional info */
3705
- appDefinedActionInfo?: AppDefinedActionInfo;
3706
- /** Condition action additional info */
3707
- conditionActionInfo?: ConditionActionInfo;
3708
- /** Rate limit action additional info */
3709
- rateLimitActionInfo?: RateLimitActionInfo;
3710
- /** Rate limit action additional info */
3711
- delayActionInfo?: DelayActionInfo;
3712
- }
3713
- interface FailedStatusInfo {
3714
- /** Error description */
3715
- errorDescription?: string;
3716
- /** Error code */
3717
- errorCode?: string | null;
3718
- }
3719
- interface ActivationResumeAfterDelay {
3720
- /** Activation identifier */
3721
- _id?: string;
3722
- /** Activation schedule identifier */
3723
- scheduleId?: string;
3724
- /** Activation schedule due date */
3725
- scheduleDate?: Date | null;
3726
- /** Activation payload */
3727
- payload?: Record<string, any> | null;
3728
- /** Activation Automation */
3729
- automation?: Automation$1;
3730
- /** Scheduled action identifier - with the intent to execute that action's post actions */
3731
- scheduledActionId?: string;
3732
- /** Optional - external entity id that this activation is related to */
3733
- externalEntityId?: string | null;
3734
- }
3735
- interface ActionCompletedRequest {
3736
- /** The execution identifier that was given to the spi provider when we invoked the action */
3737
- executionIdentifier?: string;
3738
- /** The result of invoking the action. Must conform to the output schema configured by the action provider. */
3739
- result?: Record<string, any> | null;
3740
- }
3741
- interface RefreshPayloadRequest {
3742
- /** Application definition ID. */
3743
- appDefId?: string;
3744
- /** Trigger key. */
3745
- triggerKey?: string;
3746
- /** Payload to refresh. */
3747
- payload?: Record<string, any> | null;
3748
- /** External entity ID. */
3749
- externalEntityId?: string | null;
3750
- }
3751
- interface RefreshPayloadResponse {
3752
- /** Updated payload. */
3753
- payload?: Record<string, any> | null;
3754
- /** If the automation activation should be canceled (default is false) */
3755
- cancelActivation?: boolean | null;
3756
- }
3757
- interface RunAutomationRequest {
3758
- /** App of the automation trigger */
3759
- appId?: string;
3760
- /** Trigger key of the action */
3761
- triggerKey?: string;
3762
- /** Payload of the triggered event */
3763
- triggerPayload?: Record<string, any> | null;
3764
- /** Specific automation id to run */
3765
- automationId?: string;
3766
- /** Schema of the trigger */
3767
- triggerSchema?: Record<string, any> | null;
3768
- }
3769
- interface RunAutomationResponse {
3770
- /** Automation activation output payload */
3771
- output?: Record<string, any> | null;
3759
+ interface ActivationScheduleCompleted {
3760
+ /** Activation identifier */
3761
+ _id?: string;
3762
+ /** Activation schedule identifier */
3763
+ scheduleId?: string;
3764
+ /** Activation schedule due date */
3765
+ scheduleDate?: Date | null;
3766
+ /** Activation payload */
3767
+ payload?: Record<string, any> | null;
3768
+ /** Activation Automation */
3769
+ automation?: Automation$1;
3770
+ /** Optional - external entity id that this activation is related to */
3771
+ externalEntityId?: string | null;
3772
3772
  }
3773
3773
  interface ReportEventResponseNonNullableFields {
3774
3774
  activationIds: string[];
@@ -3975,7 +3975,9 @@ declare const bulkCancelEvent: MaybeContext<BuildRESTFunction<typeof bulkCancelE
3975
3975
  declare const cancelEvent: MaybeContext<BuildRESTFunction<typeof cancelEvent$1> & typeof cancelEvent$1>;
3976
3976
 
3977
3977
  type _publicOnActivationStatusChangedType = typeof onActivationStatusChanged$1;
3978
- /** */
3978
+ /**
3979
+ * activation status changed message
3980
+ */
3979
3981
  declare const onActivationStatusChanged: ReturnType<typeof createEventModule$1<_publicOnActivationStatusChangedType>>;
3980
3982
 
3981
3983
  type index_d$1_ActionActionOneOf = ActionActionOneOf;
@@ -4504,6 +4506,126 @@ interface DraftPublished {
4504
4506
  /** Updated automation after publishing the draft. */
4505
4507
  updatedAutomation?: Automation;
4506
4508
  }
4509
+ interface GetAutomationRevisionRequest {
4510
+ /** Automation ID. */
4511
+ automationId?: string;
4512
+ /** Automation revision. */
4513
+ revision?: string | null;
4514
+ }
4515
+ interface GetAutomationRevisionResponse {
4516
+ /** Automation with the relevant revision. */
4517
+ automation?: Automation;
4518
+ }
4519
+ interface DomainEvent extends DomainEventBodyOneOf {
4520
+ createdEvent?: EntityCreatedEvent;
4521
+ updatedEvent?: EntityUpdatedEvent;
4522
+ deletedEvent?: EntityDeletedEvent;
4523
+ actionEvent?: ActionEvent;
4524
+ /**
4525
+ * Unique event ID.
4526
+ * Allows clients to ignore duplicate webhooks.
4527
+ */
4528
+ _id?: string;
4529
+ /**
4530
+ * Assumes actions are also always typed to an entity_type
4531
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
4532
+ */
4533
+ entityFqdn?: string;
4534
+ /**
4535
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
4536
+ * This is although the created/updated/deleted notion is duplication of the oneof types
4537
+ * Example: created/updated/deleted/started/completed/email_opened
4538
+ */
4539
+ slug?: string;
4540
+ /** ID of the entity associated with the event. */
4541
+ entityId?: string;
4542
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
4543
+ eventTime?: Date | null;
4544
+ /**
4545
+ * Whether the event was triggered as a result of a privacy regulation application
4546
+ * (for example, GDPR).
4547
+ */
4548
+ triggeredByAnonymizeRequest?: boolean | null;
4549
+ /** If present, indicates the action that triggered the event. */
4550
+ originatedFrom?: string | null;
4551
+ /**
4552
+ * A sequence number defining the order of updates to the underlying entity.
4553
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
4554
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
4555
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
4556
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
4557
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
4558
+ */
4559
+ entityEventSequence?: string | null;
4560
+ }
4561
+ /** @oneof */
4562
+ interface DomainEventBodyOneOf {
4563
+ createdEvent?: EntityCreatedEvent;
4564
+ updatedEvent?: EntityUpdatedEvent;
4565
+ deletedEvent?: EntityDeletedEvent;
4566
+ actionEvent?: ActionEvent;
4567
+ }
4568
+ interface EntityCreatedEvent {
4569
+ entity?: string;
4570
+ }
4571
+ interface RestoreInfo {
4572
+ deletedDate?: Date | null;
4573
+ }
4574
+ interface EntityUpdatedEvent {
4575
+ /**
4576
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
4577
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
4578
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
4579
+ */
4580
+ currentEntity?: string;
4581
+ }
4582
+ interface EntityDeletedEvent {
4583
+ /** Entity that was deleted */
4584
+ deletedEntity?: string | null;
4585
+ }
4586
+ interface ActionEvent {
4587
+ body?: string;
4588
+ }
4589
+ interface MessageEnvelope {
4590
+ /** App instance ID. */
4591
+ instanceId?: string | null;
4592
+ /** Event type. */
4593
+ eventType?: string;
4594
+ /** The identification type and identity data. */
4595
+ identity?: IdentificationData;
4596
+ /** Stringify payload. */
4597
+ data?: string;
4598
+ }
4599
+ interface IdentificationData extends IdentificationDataIdOneOf {
4600
+ /** ID of a site visitor that has not logged in to the site. */
4601
+ anonymousVisitorId?: string;
4602
+ /** ID of a site visitor that has logged in to the site. */
4603
+ memberId?: string;
4604
+ /** ID of a Wix user (site owner, contributor, etc.). */
4605
+ wixUserId?: string;
4606
+ /** ID of an app. */
4607
+ appId?: string;
4608
+ /** @readonly */
4609
+ identityType?: WebhookIdentityType;
4610
+ }
4611
+ /** @oneof */
4612
+ interface IdentificationDataIdOneOf {
4613
+ /** ID of a site visitor that has not logged in to the site. */
4614
+ anonymousVisitorId?: string;
4615
+ /** ID of a site visitor that has logged in to the site. */
4616
+ memberId?: string;
4617
+ /** ID of a Wix user (site owner, contributor, etc.). */
4618
+ wixUserId?: string;
4619
+ /** ID of an app. */
4620
+ appId?: string;
4621
+ }
4622
+ declare enum WebhookIdentityType {
4623
+ UNKNOWN = "UNKNOWN",
4624
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
4625
+ MEMBER = "MEMBER",
4626
+ WIX_USER = "WIX_USER",
4627
+ APP = "APP"
4628
+ }
4507
4629
  interface CreateAutomationRequest {
4508
4630
  /** Automation to be created. */
4509
4631
  automation: Automation;
@@ -4784,76 +4906,6 @@ interface Cursors {
4784
4906
  /** Cursor pointing to the previous page in the list of results. */
4785
4907
  prev?: string | null;
4786
4908
  }
4787
- interface DomainEvent extends DomainEventBodyOneOf {
4788
- createdEvent?: EntityCreatedEvent;
4789
- updatedEvent?: EntityUpdatedEvent;
4790
- deletedEvent?: EntityDeletedEvent;
4791
- actionEvent?: ActionEvent;
4792
- /**
4793
- * Unique event ID.
4794
- * Allows clients to ignore duplicate webhooks.
4795
- */
4796
- _id?: string;
4797
- /**
4798
- * Assumes actions are also always typed to an entity_type
4799
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
4800
- */
4801
- entityFqdn?: string;
4802
- /**
4803
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
4804
- * This is although the created/updated/deleted notion is duplication of the oneof types
4805
- * Example: created/updated/deleted/started/completed/email_opened
4806
- */
4807
- slug?: string;
4808
- /** ID of the entity associated with the event. */
4809
- entityId?: string;
4810
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
4811
- eventTime?: Date | null;
4812
- /**
4813
- * Whether the event was triggered as a result of a privacy regulation application
4814
- * (for example, GDPR).
4815
- */
4816
- triggeredByAnonymizeRequest?: boolean | null;
4817
- /** If present, indicates the action that triggered the event. */
4818
- originatedFrom?: string | null;
4819
- /**
4820
- * A sequence number defining the order of updates to the underlying entity.
4821
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
4822
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
4823
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
4824
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
4825
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
4826
- */
4827
- entityEventSequence?: string | null;
4828
- }
4829
- /** @oneof */
4830
- interface DomainEventBodyOneOf {
4831
- createdEvent?: EntityCreatedEvent;
4832
- updatedEvent?: EntityUpdatedEvent;
4833
- deletedEvent?: EntityDeletedEvent;
4834
- actionEvent?: ActionEvent;
4835
- }
4836
- interface EntityCreatedEvent {
4837
- entity?: string;
4838
- }
4839
- interface RestoreInfo {
4840
- deletedDate?: Date | null;
4841
- }
4842
- interface EntityUpdatedEvent {
4843
- /**
4844
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
4845
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
4846
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
4847
- */
4848
- currentEntity?: string;
4849
- }
4850
- interface EntityDeletedEvent {
4851
- /** Entity that was deleted */
4852
- deletedEntity?: string | null;
4853
- }
4854
- interface ActionEvent {
4855
- body?: string;
4856
- }
4857
4909
  interface Empty {
4858
4910
  }
4859
4911
  interface CopyAutomationRequest {
@@ -5467,56 +5519,6 @@ interface UpgradeCTA {
5467
5519
  /** CTA button label. */
5468
5520
  label?: string;
5469
5521
  }
5470
- interface MessageEnvelope {
5471
- /** App instance ID. */
5472
- instanceId?: string | null;
5473
- /** Event type. */
5474
- eventType?: string;
5475
- /** The identification type and identity data. */
5476
- identity?: IdentificationData;
5477
- /** Stringify payload. */
5478
- data?: string;
5479
- }
5480
- interface IdentificationData extends IdentificationDataIdOneOf {
5481
- /** ID of a site visitor that has not logged in to the site. */
5482
- anonymousVisitorId?: string;
5483
- /** ID of a site visitor that has logged in to the site. */
5484
- memberId?: string;
5485
- /** ID of a Wix user (site owner, contributor, etc.). */
5486
- wixUserId?: string;
5487
- /** ID of an app. */
5488
- appId?: string;
5489
- /** @readonly */
5490
- identityType?: WebhookIdentityType;
5491
- }
5492
- /** @oneof */
5493
- interface IdentificationDataIdOneOf {
5494
- /** ID of a site visitor that has not logged in to the site. */
5495
- anonymousVisitorId?: string;
5496
- /** ID of a site visitor that has logged in to the site. */
5497
- memberId?: string;
5498
- /** ID of a Wix user (site owner, contributor, etc.). */
5499
- wixUserId?: string;
5500
- /** ID of an app. */
5501
- appId?: string;
5502
- }
5503
- declare enum WebhookIdentityType {
5504
- UNKNOWN = "UNKNOWN",
5505
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
5506
- MEMBER = "MEMBER",
5507
- WIX_USER = "WIX_USER",
5508
- APP = "APP"
5509
- }
5510
- interface GetAutomationRevisionRequest {
5511
- /** Automation ID. */
5512
- automationId?: string;
5513
- /** Automation revision. */
5514
- revision?: string | null;
5515
- }
5516
- interface GetAutomationRevisionResponse {
5517
- /** Automation with the relevant revision. */
5518
- automation?: Automation;
5519
- }
5520
5522
  interface ApplicationOriginNonNullableFields {
5521
5523
  appId: string;
5522
5524
  }