@wix/automations 1.0.70 → 1.0.72
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/package.json +5 -5
- package/type-bundles/context.bundle.d.ts +344 -346
- package/type-bundles/index.bundle.d.ts +344 -346
|
@@ -1891,11 +1891,11 @@ interface AutomationCreatedEnvelope$1 {
|
|
|
1891
1891
|
entity: Automation$2;
|
|
1892
1892
|
metadata: EventMetadata$2;
|
|
1893
1893
|
}
|
|
1894
|
-
interface
|
|
1895
|
-
entity: Automation$2;
|
|
1894
|
+
interface AutomationDeletedEnvelope$1 {
|
|
1896
1895
|
metadata: EventMetadata$2;
|
|
1897
1896
|
}
|
|
1898
|
-
interface
|
|
1897
|
+
interface AutomationUpdatedEnvelope$1 {
|
|
1898
|
+
entity: Automation$2;
|
|
1899
1899
|
metadata: EventMetadata$2;
|
|
1900
1900
|
}
|
|
1901
1901
|
interface AutomationDeletedWithEntityEnvelope$1 {
|
|
@@ -2212,8 +2212,8 @@ interface GenerateActionInputMappingFromTemplateSignature {
|
|
|
2212
2212
|
(appId: string, options: GenerateActionInputMappingFromTemplateOptions): Promise<GenerateActionInputMappingFromTemplateResponse>;
|
|
2213
2213
|
}
|
|
2214
2214
|
declare const onAutomationCreated$3: EventDefinition<AutomationCreatedEnvelope$1, "wix.automations.v1.automation_created">;
|
|
2215
|
-
declare const onAutomationUpdated$3: EventDefinition<AutomationUpdatedEnvelope$1, "wix.automations.v1.automation_updated">;
|
|
2216
2215
|
declare const onAutomationDeleted$3: EventDefinition<AutomationDeletedEnvelope$1, "wix.automations.v1.automation_deleted">;
|
|
2216
|
+
declare const onAutomationUpdated$3: EventDefinition<AutomationUpdatedEnvelope$1, "wix.automations.v1.automation_updated">;
|
|
2217
2217
|
declare const onAutomationDeletedWithEntity$3: EventDefinition<AutomationDeletedWithEntityEnvelope$1, "wix.automations.v1.automation_deleted_with_entity">;
|
|
2218
2218
|
declare const onAutomationUpdatedWithPreviousEntity$3: EventDefinition<AutomationUpdatedWithPreviousEntityEnvelope$1, "wix.automations.v1.automation_updated_with_previous_entity">;
|
|
2219
2219
|
|
|
@@ -2236,14 +2236,14 @@ type _publicOnAutomationCreatedType$1 = typeof onAutomationCreated$3;
|
|
|
2236
2236
|
/** */
|
|
2237
2237
|
declare const onAutomationCreated$2: ReturnType<typeof createEventModule$2<_publicOnAutomationCreatedType>>;
|
|
2238
2238
|
|
|
2239
|
-
type _publicOnAutomationUpdatedType$1 = typeof onAutomationUpdated$3;
|
|
2240
|
-
/** */
|
|
2241
|
-
declare const onAutomationUpdated$2: ReturnType<typeof createEventModule$2<_publicOnAutomationUpdatedType>>;
|
|
2242
|
-
|
|
2243
2239
|
type _publicOnAutomationDeletedType$1 = typeof onAutomationDeleted$3;
|
|
2244
2240
|
/** */
|
|
2245
2241
|
declare const onAutomationDeleted$2: ReturnType<typeof createEventModule$2<_publicOnAutomationDeletedType>>;
|
|
2246
2242
|
|
|
2243
|
+
type _publicOnAutomationUpdatedType$1 = typeof onAutomationUpdated$3;
|
|
2244
|
+
/** */
|
|
2245
|
+
declare const onAutomationUpdated$2: ReturnType<typeof createEventModule$2<_publicOnAutomationUpdatedType>>;
|
|
2246
|
+
|
|
2247
2247
|
type _publicOnAutomationDeletedWithEntityType$1 = typeof onAutomationDeletedWithEntity$3;
|
|
2248
2248
|
/** */
|
|
2249
2249
|
declare const onAutomationDeletedWithEntity$2: ReturnType<typeof createEventModule$2<_publicOnAutomationDeletedWithEntityType>>;
|
|
@@ -3024,6 +3024,10 @@ declare enum WebhookIdentityType$1 {
|
|
|
3024
3024
|
WIX_USER = "WIX_USER",
|
|
3025
3025
|
APP = "APP"
|
|
3026
3026
|
}
|
|
3027
|
+
interface BatchActivationRequest {
|
|
3028
|
+
/** List of Activation-Request. */
|
|
3029
|
+
activationRequests?: ActivationRequest[];
|
|
3030
|
+
}
|
|
3027
3031
|
interface ActivationRequest {
|
|
3028
3032
|
/** Activation's ID. */
|
|
3029
3033
|
activationId?: string;
|
|
@@ -3251,219 +3255,6 @@ interface ActionsData {
|
|
|
3251
3255
|
/** Map of action id to action data. */
|
|
3252
3256
|
actions?: Record<string, Action$1>;
|
|
3253
3257
|
}
|
|
3254
|
-
interface ActionStatus {
|
|
3255
|
-
/** Action's status. */
|
|
3256
|
-
_id?: string;
|
|
3257
|
-
/** Activation's ID. */
|
|
3258
|
-
activationId?: string;
|
|
3259
|
-
/** Action's name. */
|
|
3260
|
-
actionName?: string | null;
|
|
3261
|
-
/** Action's status. */
|
|
3262
|
-
status?: Status$1;
|
|
3263
|
-
/** Action's error reason (if there is one). */
|
|
3264
|
-
errorReason?: string | null;
|
|
3265
|
-
/** Activation external id. */
|
|
3266
|
-
activationExternalId?: string;
|
|
3267
|
-
/** Trigger app id. */
|
|
3268
|
-
triggerAppId?: string | null;
|
|
3269
|
-
/** Trigger key. */
|
|
3270
|
-
triggerKey?: string | null;
|
|
3271
|
-
/** The configuration correlation id */
|
|
3272
|
-
configurationCorrelationId?: string | null;
|
|
3273
|
-
}
|
|
3274
|
-
interface BatchActivationRequest {
|
|
3275
|
-
/** List of Activation-Request. */
|
|
3276
|
-
activationRequests?: ActivationRequest[];
|
|
3277
|
-
}
|
|
3278
|
-
interface Empty$1 {
|
|
3279
|
-
}
|
|
3280
|
-
interface ActivationActionStatusChanged extends ActivationActionStatusChangedStatusInfoOneOf {
|
|
3281
|
-
/** Started status information */
|
|
3282
|
-
startedInfo?: StartedStatusInfo;
|
|
3283
|
-
/** Ended status information */
|
|
3284
|
-
endedInfo?: EndedStatusInfo;
|
|
3285
|
-
/** Failed status information */
|
|
3286
|
-
failedInfo?: FailedStatusInfo;
|
|
3287
|
-
/** Action ID */
|
|
3288
|
-
_id?: string;
|
|
3289
|
-
/** Activation ID */
|
|
3290
|
-
activationId?: string;
|
|
3291
|
-
/** Automation info */
|
|
3292
|
-
automationInfo?: AutomationInfo;
|
|
3293
|
-
/** Action type */
|
|
3294
|
-
type?: Type$1;
|
|
3295
|
-
/** Event date */
|
|
3296
|
-
statusChangedDate?: Date | null;
|
|
3297
|
-
/** Action activation status */
|
|
3298
|
-
status?: ActivationActionStatusChangedStatus;
|
|
3299
|
-
}
|
|
3300
|
-
/** @oneof */
|
|
3301
|
-
interface ActivationActionStatusChangedStatusInfoOneOf {
|
|
3302
|
-
/** Started status information */
|
|
3303
|
-
startedInfo?: StartedStatusInfo;
|
|
3304
|
-
/** Ended status information */
|
|
3305
|
-
endedInfo?: EndedStatusInfo;
|
|
3306
|
-
/** Failed status information */
|
|
3307
|
-
failedInfo?: FailedStatusInfo;
|
|
3308
|
-
}
|
|
3309
|
-
interface StartedStatusInfoAppDefinedActionInfo {
|
|
3310
|
-
/** Action input */
|
|
3311
|
-
input?: Record<string, any> | null;
|
|
3312
|
-
}
|
|
3313
|
-
interface DelayActionInfo {
|
|
3314
|
-
/** Indicates when this action becomes completed and the activation will move to the post actions */
|
|
3315
|
-
date?: Date | null;
|
|
3316
|
-
}
|
|
3317
|
-
interface ExpressionEvaluationResult {
|
|
3318
|
-
/** Indicates if the expression was evaluated to true or false */
|
|
3319
|
-
passed?: boolean;
|
|
3320
|
-
/** Indicates if there was an error in the evaluation process */
|
|
3321
|
-
error?: boolean;
|
|
3322
|
-
}
|
|
3323
|
-
interface AppDefinedActionInfo {
|
|
3324
|
-
/** Output returned by the action implementer. */
|
|
3325
|
-
output?: Record<string, any> | null;
|
|
3326
|
-
}
|
|
3327
|
-
interface ConditionActionInfo {
|
|
3328
|
-
/** Indicates that the condition `if` clause evaluated to `true`. */
|
|
3329
|
-
passed?: boolean;
|
|
3330
|
-
/** Collects results per each expression evaluation that took place */
|
|
3331
|
-
expressionResults?: Record<string, ExpressionEvaluationResult>;
|
|
3332
|
-
}
|
|
3333
|
-
interface RateLimitActionInfo {
|
|
3334
|
-
/** Indicates if the rate limiter passed (not reached the quota) */
|
|
3335
|
-
passed?: boolean;
|
|
3336
|
-
}
|
|
3337
|
-
interface AutomationInfo extends AutomationInfoOriginInfoOneOf {
|
|
3338
|
-
/** Application info */
|
|
3339
|
-
applicationInfo?: ApplicationOrigin$1;
|
|
3340
|
-
/** Preinstalled info */
|
|
3341
|
-
preinstalledInfo?: PreinstalledOrigin$1;
|
|
3342
|
-
/** Automation ID */
|
|
3343
|
-
_id?: string;
|
|
3344
|
-
/** Origin type */
|
|
3345
|
-
origin?: Origin$1;
|
|
3346
|
-
}
|
|
3347
|
-
/** @oneof */
|
|
3348
|
-
interface AutomationInfoOriginInfoOneOf {
|
|
3349
|
-
/** Application info */
|
|
3350
|
-
applicationInfo?: ApplicationOrigin$1;
|
|
3351
|
-
/** Preinstalled info */
|
|
3352
|
-
preinstalledInfo?: PreinstalledOrigin$1;
|
|
3353
|
-
}
|
|
3354
|
-
declare enum ActivationActionStatusChangedStatus {
|
|
3355
|
-
UNKNOWN_ACTION_ACTIVATION_STATUS = "UNKNOWN_ACTION_ACTIVATION_STATUS",
|
|
3356
|
-
/**
|
|
3357
|
-
* Indicates that action activation has started and is in progress.
|
|
3358
|
-
* Relevant to action types: APP_DEFINED, DELAY.
|
|
3359
|
-
*/
|
|
3360
|
-
STARTED = "STARTED",
|
|
3361
|
-
/**
|
|
3362
|
-
* Indicates that the action activation was completed without errors.
|
|
3363
|
-
* Relevant to action types: APP_DEFINED, DELAY, CONDITION, RATE_LIMIT.
|
|
3364
|
-
*/
|
|
3365
|
-
ENDED = "ENDED",
|
|
3366
|
-
/**
|
|
3367
|
-
* Indicates that the action was skipped and post actions won't start.
|
|
3368
|
-
* Relevant to action types: APP_DEFINED.
|
|
3369
|
-
*/
|
|
3370
|
-
SKIPPED = "SKIPPED",
|
|
3371
|
-
/**
|
|
3372
|
-
* Indicates that the action failed.
|
|
3373
|
-
* Relevant to action types: APP_DEFINED, DELAY, RATE_LIMIT.
|
|
3374
|
-
*/
|
|
3375
|
-
FAILED = "FAILED"
|
|
3376
|
-
}
|
|
3377
|
-
interface StartedStatusInfo extends StartedStatusInfoTypeInfoOneOf {
|
|
3378
|
-
/** APP DEFINED action additional info */
|
|
3379
|
-
appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
|
|
3380
|
-
/** Delay action additional info */
|
|
3381
|
-
delayActionInfo?: DelayActionInfo;
|
|
3382
|
-
}
|
|
3383
|
-
/** @oneof */
|
|
3384
|
-
interface StartedStatusInfoTypeInfoOneOf {
|
|
3385
|
-
/** APP DEFINED action additional info */
|
|
3386
|
-
appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
|
|
3387
|
-
/** Delay action additional info */
|
|
3388
|
-
delayActionInfo?: DelayActionInfo;
|
|
3389
|
-
}
|
|
3390
|
-
interface EndedStatusInfo extends EndedStatusInfoTypeInfoOneOf {
|
|
3391
|
-
/** APP DEFINED action additional info */
|
|
3392
|
-
appDefinedActionInfo?: AppDefinedActionInfo;
|
|
3393
|
-
/** Condition action additional info */
|
|
3394
|
-
conditionActionInfo?: ConditionActionInfo;
|
|
3395
|
-
/** Rate limit action additional info */
|
|
3396
|
-
rateLimitActionInfo?: RateLimitActionInfo;
|
|
3397
|
-
}
|
|
3398
|
-
/** @oneof */
|
|
3399
|
-
interface EndedStatusInfoTypeInfoOneOf {
|
|
3400
|
-
/** APP DEFINED action additional info */
|
|
3401
|
-
appDefinedActionInfo?: AppDefinedActionInfo;
|
|
3402
|
-
/** Condition action additional info */
|
|
3403
|
-
conditionActionInfo?: ConditionActionInfo;
|
|
3404
|
-
/** Rate limit action additional info */
|
|
3405
|
-
rateLimitActionInfo?: RateLimitActionInfo;
|
|
3406
|
-
}
|
|
3407
|
-
interface FailedStatusInfo {
|
|
3408
|
-
/** Error description */
|
|
3409
|
-
errorDescription?: string;
|
|
3410
|
-
/** Error code */
|
|
3411
|
-
errorCode?: string | null;
|
|
3412
|
-
}
|
|
3413
|
-
interface ActivationResumeAfterDelay {
|
|
3414
|
-
/** Activation identifier */
|
|
3415
|
-
_id?: string;
|
|
3416
|
-
/** Activation schedule identifier */
|
|
3417
|
-
scheduleId?: string;
|
|
3418
|
-
/** Activation schedule due date */
|
|
3419
|
-
scheduleDate?: Date | null;
|
|
3420
|
-
/** Activation payload */
|
|
3421
|
-
payload?: Record<string, any> | null;
|
|
3422
|
-
/** Activation Automation */
|
|
3423
|
-
automation?: Automation$1;
|
|
3424
|
-
/** Scheduled action identifier - with the intent to execute that action's post actions */
|
|
3425
|
-
scheduledActionId?: string;
|
|
3426
|
-
/** Optional - external entity id that this activation is related to */
|
|
3427
|
-
externalEntityId?: string | null;
|
|
3428
|
-
}
|
|
3429
|
-
interface ActionCompletedRequest {
|
|
3430
|
-
/** The execution identifier that was given to the spi provider when we invoked the action */
|
|
3431
|
-
executionIdentifier?: string;
|
|
3432
|
-
/** The result of invoking the action. Must conform to the output schema configured by the action provider. */
|
|
3433
|
-
result?: Record<string, any> | null;
|
|
3434
|
-
}
|
|
3435
|
-
interface RefreshPayloadRequest {
|
|
3436
|
-
/** Application definition ID. */
|
|
3437
|
-
appDefId?: string;
|
|
3438
|
-
/** Trigger key. */
|
|
3439
|
-
triggerKey?: string;
|
|
3440
|
-
/** Payload to refresh. */
|
|
3441
|
-
payload?: Record<string, any> | null;
|
|
3442
|
-
/** External entity ID. */
|
|
3443
|
-
externalEntityId?: string | null;
|
|
3444
|
-
}
|
|
3445
|
-
interface RefreshPayloadResponse {
|
|
3446
|
-
/** Updated payload. */
|
|
3447
|
-
payload?: Record<string, any> | null;
|
|
3448
|
-
/** If the automation activation should be canceled (default is false) */
|
|
3449
|
-
cancelActivation?: boolean | null;
|
|
3450
|
-
}
|
|
3451
|
-
interface RunAutomationRequest {
|
|
3452
|
-
/** App of the automation trigger */
|
|
3453
|
-
appId?: string;
|
|
3454
|
-
/** Trigger key of the action */
|
|
3455
|
-
triggerKey?: string;
|
|
3456
|
-
/** Payload of the triggered event */
|
|
3457
|
-
triggerPayload?: Record<string, any> | null;
|
|
3458
|
-
/** Specific automation id to run */
|
|
3459
|
-
automationId?: string;
|
|
3460
|
-
/** Schema of the trigger */
|
|
3461
|
-
triggerSchema?: Record<string, any> | null;
|
|
3462
|
-
}
|
|
3463
|
-
interface RunAutomationResponse {
|
|
3464
|
-
/** Automation activation output payload */
|
|
3465
|
-
output?: Record<string, any> | null;
|
|
3466
|
-
}
|
|
3467
3258
|
interface ActivationScheduleRequested {
|
|
3468
3259
|
/** Activation identifier */
|
|
3469
3260
|
_id?: string;
|
|
@@ -3732,6 +3523,8 @@ interface ExecuteFromActionRequest {
|
|
|
3732
3523
|
}
|
|
3733
3524
|
interface ExecuteFromActionResponse {
|
|
3734
3525
|
}
|
|
3526
|
+
interface Empty$1 {
|
|
3527
|
+
}
|
|
3735
3528
|
interface ActivationScheduleCompleted {
|
|
3736
3529
|
/** Activation identifier */
|
|
3737
3530
|
_id?: string;
|
|
@@ -3746,8 +3539,215 @@ interface ActivationScheduleCompleted {
|
|
|
3746
3539
|
/** Optional - external entity id that this activation is related to */
|
|
3747
3540
|
externalEntityId?: string | null;
|
|
3748
3541
|
}
|
|
3749
|
-
interface
|
|
3750
|
-
|
|
3542
|
+
interface ActionStatus {
|
|
3543
|
+
/** Action's status. */
|
|
3544
|
+
_id?: string;
|
|
3545
|
+
/** Activation's ID. */
|
|
3546
|
+
activationId?: string;
|
|
3547
|
+
/** Action's name. */
|
|
3548
|
+
actionName?: string | null;
|
|
3549
|
+
/** Action's status. */
|
|
3550
|
+
status?: Status$1;
|
|
3551
|
+
/** Action's error reason (if there is one). */
|
|
3552
|
+
errorReason?: string | null;
|
|
3553
|
+
/** Activation external id. */
|
|
3554
|
+
activationExternalId?: string;
|
|
3555
|
+
/** Trigger app id. */
|
|
3556
|
+
triggerAppId?: string | null;
|
|
3557
|
+
/** Trigger key. */
|
|
3558
|
+
triggerKey?: string | null;
|
|
3559
|
+
/** The configuration correlation id */
|
|
3560
|
+
configurationCorrelationId?: string | null;
|
|
3561
|
+
}
|
|
3562
|
+
interface ActivationActionStatusChanged extends ActivationActionStatusChangedStatusInfoOneOf {
|
|
3563
|
+
/** Started status information */
|
|
3564
|
+
startedInfo?: StartedStatusInfo;
|
|
3565
|
+
/** Ended status information */
|
|
3566
|
+
endedInfo?: EndedStatusInfo;
|
|
3567
|
+
/** Failed status information */
|
|
3568
|
+
failedInfo?: FailedStatusInfo;
|
|
3569
|
+
/** Action ID */
|
|
3570
|
+
_id?: string;
|
|
3571
|
+
/** Activation ID */
|
|
3572
|
+
activationId?: string;
|
|
3573
|
+
/** Automation info */
|
|
3574
|
+
automationInfo?: AutomationInfo;
|
|
3575
|
+
/** Action type */
|
|
3576
|
+
type?: Type$1;
|
|
3577
|
+
/** Event date */
|
|
3578
|
+
statusChangedDate?: Date | null;
|
|
3579
|
+
/** Action activation status */
|
|
3580
|
+
status?: ActivationActionStatusChangedStatus;
|
|
3581
|
+
}
|
|
3582
|
+
/** @oneof */
|
|
3583
|
+
interface ActivationActionStatusChangedStatusInfoOneOf {
|
|
3584
|
+
/** Started status information */
|
|
3585
|
+
startedInfo?: StartedStatusInfo;
|
|
3586
|
+
/** Ended status information */
|
|
3587
|
+
endedInfo?: EndedStatusInfo;
|
|
3588
|
+
/** Failed status information */
|
|
3589
|
+
failedInfo?: FailedStatusInfo;
|
|
3590
|
+
}
|
|
3591
|
+
interface StartedStatusInfoAppDefinedActionInfo {
|
|
3592
|
+
/** Action input */
|
|
3593
|
+
input?: Record<string, any> | null;
|
|
3594
|
+
}
|
|
3595
|
+
interface DelayActionInfo {
|
|
3596
|
+
/** Indicates when this action becomes completed and the activation will move to the post actions */
|
|
3597
|
+
date?: Date | null;
|
|
3598
|
+
}
|
|
3599
|
+
interface ExpressionEvaluationResult {
|
|
3600
|
+
/** Indicates if the expression was evaluated to true or false */
|
|
3601
|
+
passed?: boolean;
|
|
3602
|
+
/** Indicates if there was an error in the evaluation process */
|
|
3603
|
+
error?: boolean;
|
|
3604
|
+
}
|
|
3605
|
+
interface AppDefinedActionInfo {
|
|
3606
|
+
/** Output returned by the action implementer. */
|
|
3607
|
+
output?: Record<string, any> | null;
|
|
3608
|
+
}
|
|
3609
|
+
interface ConditionActionInfo {
|
|
3610
|
+
/** Indicates that the condition `if` clause evaluated to `true`. */
|
|
3611
|
+
passed?: boolean;
|
|
3612
|
+
/** Collects results per each expression evaluation that took place */
|
|
3613
|
+
expressionResults?: Record<string, ExpressionEvaluationResult>;
|
|
3614
|
+
}
|
|
3615
|
+
interface RateLimitActionInfo {
|
|
3616
|
+
/** Indicates if the rate limiter passed (not reached the quota) */
|
|
3617
|
+
passed?: boolean;
|
|
3618
|
+
}
|
|
3619
|
+
interface AutomationInfo extends AutomationInfoOriginInfoOneOf {
|
|
3620
|
+
/** Application info */
|
|
3621
|
+
applicationInfo?: ApplicationOrigin$1;
|
|
3622
|
+
/** Preinstalled info */
|
|
3623
|
+
preinstalledInfo?: PreinstalledOrigin$1;
|
|
3624
|
+
/** Automation ID */
|
|
3625
|
+
_id?: string;
|
|
3626
|
+
/** Origin type */
|
|
3627
|
+
origin?: Origin$1;
|
|
3628
|
+
}
|
|
3629
|
+
/** @oneof */
|
|
3630
|
+
interface AutomationInfoOriginInfoOneOf {
|
|
3631
|
+
/** Application info */
|
|
3632
|
+
applicationInfo?: ApplicationOrigin$1;
|
|
3633
|
+
/** Preinstalled info */
|
|
3634
|
+
preinstalledInfo?: PreinstalledOrigin$1;
|
|
3635
|
+
}
|
|
3636
|
+
declare enum ActivationActionStatusChangedStatus {
|
|
3637
|
+
UNKNOWN_ACTION_ACTIVATION_STATUS = "UNKNOWN_ACTION_ACTIVATION_STATUS",
|
|
3638
|
+
/**
|
|
3639
|
+
* Indicates that action activation has started and is in progress.
|
|
3640
|
+
* Relevant to action types: APP_DEFINED, DELAY.
|
|
3641
|
+
*/
|
|
3642
|
+
STARTED = "STARTED",
|
|
3643
|
+
/**
|
|
3644
|
+
* Indicates that the action activation was completed without errors.
|
|
3645
|
+
* Relevant to action types: APP_DEFINED, DELAY, CONDITION, RATE_LIMIT.
|
|
3646
|
+
*/
|
|
3647
|
+
ENDED = "ENDED",
|
|
3648
|
+
/**
|
|
3649
|
+
* Indicates that the action was skipped and post actions won't start.
|
|
3650
|
+
* Relevant to action types: APP_DEFINED.
|
|
3651
|
+
*/
|
|
3652
|
+
SKIPPED = "SKIPPED",
|
|
3653
|
+
/**
|
|
3654
|
+
* Indicates that the action failed.
|
|
3655
|
+
* Relevant to action types: APP_DEFINED, DELAY, RATE_LIMIT.
|
|
3656
|
+
*/
|
|
3657
|
+
FAILED = "FAILED"
|
|
3658
|
+
}
|
|
3659
|
+
interface StartedStatusInfo extends StartedStatusInfoTypeInfoOneOf {
|
|
3660
|
+
/** APP DEFINED action additional info */
|
|
3661
|
+
appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
|
|
3662
|
+
/** Delay action additional info */
|
|
3663
|
+
delayActionInfo?: DelayActionInfo;
|
|
3664
|
+
}
|
|
3665
|
+
/** @oneof */
|
|
3666
|
+
interface StartedStatusInfoTypeInfoOneOf {
|
|
3667
|
+
/** APP DEFINED action additional info */
|
|
3668
|
+
appDefinedActionInfo?: StartedStatusInfoAppDefinedActionInfo;
|
|
3669
|
+
/** Delay action additional info */
|
|
3670
|
+
delayActionInfo?: DelayActionInfo;
|
|
3671
|
+
}
|
|
3672
|
+
interface EndedStatusInfo extends EndedStatusInfoTypeInfoOneOf {
|
|
3673
|
+
/** APP DEFINED action additional info */
|
|
3674
|
+
appDefinedActionInfo?: AppDefinedActionInfo;
|
|
3675
|
+
/** Condition action additional info */
|
|
3676
|
+
conditionActionInfo?: ConditionActionInfo;
|
|
3677
|
+
/** Rate limit action additional info */
|
|
3678
|
+
rateLimitActionInfo?: RateLimitActionInfo;
|
|
3679
|
+
}
|
|
3680
|
+
/** @oneof */
|
|
3681
|
+
interface EndedStatusInfoTypeInfoOneOf {
|
|
3682
|
+
/** APP DEFINED action additional info */
|
|
3683
|
+
appDefinedActionInfo?: AppDefinedActionInfo;
|
|
3684
|
+
/** Condition action additional info */
|
|
3685
|
+
conditionActionInfo?: ConditionActionInfo;
|
|
3686
|
+
/** Rate limit action additional info */
|
|
3687
|
+
rateLimitActionInfo?: RateLimitActionInfo;
|
|
3688
|
+
}
|
|
3689
|
+
interface FailedStatusInfo {
|
|
3690
|
+
/** Error description */
|
|
3691
|
+
errorDescription?: string;
|
|
3692
|
+
/** Error code */
|
|
3693
|
+
errorCode?: string | null;
|
|
3694
|
+
}
|
|
3695
|
+
interface ActivationResumeAfterDelay {
|
|
3696
|
+
/** Activation identifier */
|
|
3697
|
+
_id?: string;
|
|
3698
|
+
/** Activation schedule identifier */
|
|
3699
|
+
scheduleId?: string;
|
|
3700
|
+
/** Activation schedule due date */
|
|
3701
|
+
scheduleDate?: Date | null;
|
|
3702
|
+
/** Activation payload */
|
|
3703
|
+
payload?: Record<string, any> | null;
|
|
3704
|
+
/** Activation Automation */
|
|
3705
|
+
automation?: Automation$1;
|
|
3706
|
+
/** Scheduled action identifier - with the intent to execute that action's post actions */
|
|
3707
|
+
scheduledActionId?: string;
|
|
3708
|
+
/** Optional - external entity id that this activation is related to */
|
|
3709
|
+
externalEntityId?: string | null;
|
|
3710
|
+
}
|
|
3711
|
+
interface ActionCompletedRequest {
|
|
3712
|
+
/** The execution identifier that was given to the spi provider when we invoked the action */
|
|
3713
|
+
executionIdentifier?: string;
|
|
3714
|
+
/** The result of invoking the action. Must conform to the output schema configured by the action provider. */
|
|
3715
|
+
result?: Record<string, any> | null;
|
|
3716
|
+
}
|
|
3717
|
+
interface RefreshPayloadRequest {
|
|
3718
|
+
/** Application definition ID. */
|
|
3719
|
+
appDefId?: string;
|
|
3720
|
+
/** Trigger key. */
|
|
3721
|
+
triggerKey?: string;
|
|
3722
|
+
/** Payload to refresh. */
|
|
3723
|
+
payload?: Record<string, any> | null;
|
|
3724
|
+
/** External entity ID. */
|
|
3725
|
+
externalEntityId?: string | null;
|
|
3726
|
+
}
|
|
3727
|
+
interface RefreshPayloadResponse {
|
|
3728
|
+
/** Updated payload. */
|
|
3729
|
+
payload?: Record<string, any> | null;
|
|
3730
|
+
/** If the automation activation should be canceled (default is false) */
|
|
3731
|
+
cancelActivation?: boolean | null;
|
|
3732
|
+
}
|
|
3733
|
+
interface RunAutomationRequest {
|
|
3734
|
+
/** App of the automation trigger */
|
|
3735
|
+
appId?: string;
|
|
3736
|
+
/** Trigger key of the action */
|
|
3737
|
+
triggerKey?: string;
|
|
3738
|
+
/** Payload of the triggered event */
|
|
3739
|
+
triggerPayload?: Record<string, any> | null;
|
|
3740
|
+
/** Specific automation id to run */
|
|
3741
|
+
automationId?: string;
|
|
3742
|
+
/** Schema of the trigger */
|
|
3743
|
+
triggerSchema?: Record<string, any> | null;
|
|
3744
|
+
}
|
|
3745
|
+
interface RunAutomationResponse {
|
|
3746
|
+
/** Automation activation output payload */
|
|
3747
|
+
output?: Record<string, any> | null;
|
|
3748
|
+
}
|
|
3749
|
+
interface ReportEventResponseNonNullableFields {
|
|
3750
|
+
activationIds: string[];
|
|
3751
3751
|
}
|
|
3752
3752
|
interface ApplicationErrorNonNullableFields$1 {
|
|
3753
3753
|
code: string;
|
|
@@ -3951,9 +3951,7 @@ declare const bulkCancelEvent: MaybeContext<BuildRESTFunction<typeof bulkCancelE
|
|
|
3951
3951
|
declare const cancelEvent: MaybeContext<BuildRESTFunction<typeof cancelEvent$1> & typeof cancelEvent$1>;
|
|
3952
3952
|
|
|
3953
3953
|
type _publicOnActivationStatusChangedType = typeof onActivationStatusChanged$1;
|
|
3954
|
-
/**
|
|
3955
|
-
* activation status changed message
|
|
3956
|
-
*/
|
|
3954
|
+
/** */
|
|
3957
3955
|
declare const onActivationStatusChanged: ReturnType<typeof createEventModule$1<_publicOnActivationStatusChangedType>>;
|
|
3958
3956
|
|
|
3959
3957
|
type context$1_ActionActionOneOf = ActionActionOneOf;
|
|
@@ -4472,126 +4470,6 @@ interface DraftPublished {
|
|
|
4472
4470
|
/** Updated automation after publishing the draft. */
|
|
4473
4471
|
updatedAutomation?: Automation;
|
|
4474
4472
|
}
|
|
4475
|
-
interface GetAutomationRevisionRequest {
|
|
4476
|
-
/** Automation ID. */
|
|
4477
|
-
automationId?: string;
|
|
4478
|
-
/** Automation revision. */
|
|
4479
|
-
revision?: string | null;
|
|
4480
|
-
}
|
|
4481
|
-
interface GetAutomationRevisionResponse {
|
|
4482
|
-
/** Automation with the relevant revision. */
|
|
4483
|
-
automation?: Automation;
|
|
4484
|
-
}
|
|
4485
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
4486
|
-
createdEvent?: EntityCreatedEvent;
|
|
4487
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
4488
|
-
deletedEvent?: EntityDeletedEvent;
|
|
4489
|
-
actionEvent?: ActionEvent;
|
|
4490
|
-
/**
|
|
4491
|
-
* Unique event ID.
|
|
4492
|
-
* Allows clients to ignore duplicate webhooks.
|
|
4493
|
-
*/
|
|
4494
|
-
_id?: string;
|
|
4495
|
-
/**
|
|
4496
|
-
* Assumes actions are also always typed to an entity_type
|
|
4497
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
4498
|
-
*/
|
|
4499
|
-
entityFqdn?: string;
|
|
4500
|
-
/**
|
|
4501
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
4502
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
4503
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
4504
|
-
*/
|
|
4505
|
-
slug?: string;
|
|
4506
|
-
/** ID of the entity associated with the event. */
|
|
4507
|
-
entityId?: string;
|
|
4508
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
4509
|
-
eventTime?: Date | null;
|
|
4510
|
-
/**
|
|
4511
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
4512
|
-
* (for example, GDPR).
|
|
4513
|
-
*/
|
|
4514
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
4515
|
-
/** If present, indicates the action that triggered the event. */
|
|
4516
|
-
originatedFrom?: string | null;
|
|
4517
|
-
/**
|
|
4518
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
4519
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
4520
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
4521
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
4522
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
4523
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
4524
|
-
*/
|
|
4525
|
-
entityEventSequence?: string | null;
|
|
4526
|
-
}
|
|
4527
|
-
/** @oneof */
|
|
4528
|
-
interface DomainEventBodyOneOf {
|
|
4529
|
-
createdEvent?: EntityCreatedEvent;
|
|
4530
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
4531
|
-
deletedEvent?: EntityDeletedEvent;
|
|
4532
|
-
actionEvent?: ActionEvent;
|
|
4533
|
-
}
|
|
4534
|
-
interface EntityCreatedEvent {
|
|
4535
|
-
entity?: string;
|
|
4536
|
-
}
|
|
4537
|
-
interface RestoreInfo {
|
|
4538
|
-
deletedDate?: Date | null;
|
|
4539
|
-
}
|
|
4540
|
-
interface EntityUpdatedEvent {
|
|
4541
|
-
/**
|
|
4542
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
4543
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
4544
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
4545
|
-
*/
|
|
4546
|
-
currentEntity?: string;
|
|
4547
|
-
}
|
|
4548
|
-
interface EntityDeletedEvent {
|
|
4549
|
-
/** Entity that was deleted */
|
|
4550
|
-
deletedEntity?: string | null;
|
|
4551
|
-
}
|
|
4552
|
-
interface ActionEvent {
|
|
4553
|
-
body?: string;
|
|
4554
|
-
}
|
|
4555
|
-
interface MessageEnvelope {
|
|
4556
|
-
/** App instance ID. */
|
|
4557
|
-
instanceId?: string | null;
|
|
4558
|
-
/** Event type. */
|
|
4559
|
-
eventType?: string;
|
|
4560
|
-
/** The identification type and identity data. */
|
|
4561
|
-
identity?: IdentificationData;
|
|
4562
|
-
/** Stringify payload. */
|
|
4563
|
-
data?: string;
|
|
4564
|
-
}
|
|
4565
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
4566
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
4567
|
-
anonymousVisitorId?: string;
|
|
4568
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
4569
|
-
memberId?: string;
|
|
4570
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
4571
|
-
wixUserId?: string;
|
|
4572
|
-
/** ID of an app. */
|
|
4573
|
-
appId?: string;
|
|
4574
|
-
/** @readonly */
|
|
4575
|
-
identityType?: WebhookIdentityType;
|
|
4576
|
-
}
|
|
4577
|
-
/** @oneof */
|
|
4578
|
-
interface IdentificationDataIdOneOf {
|
|
4579
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
4580
|
-
anonymousVisitorId?: string;
|
|
4581
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
4582
|
-
memberId?: string;
|
|
4583
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
4584
|
-
wixUserId?: string;
|
|
4585
|
-
/** ID of an app. */
|
|
4586
|
-
appId?: string;
|
|
4587
|
-
}
|
|
4588
|
-
declare enum WebhookIdentityType {
|
|
4589
|
-
UNKNOWN = "UNKNOWN",
|
|
4590
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
4591
|
-
MEMBER = "MEMBER",
|
|
4592
|
-
WIX_USER = "WIX_USER",
|
|
4593
|
-
APP = "APP"
|
|
4594
|
-
}
|
|
4595
4473
|
interface CreateAutomationRequest {
|
|
4596
4474
|
/** Automation to be created. */
|
|
4597
4475
|
automation: Automation;
|
|
@@ -4872,6 +4750,76 @@ interface Cursors {
|
|
|
4872
4750
|
/** Cursor pointing to the previous page in the list of results. */
|
|
4873
4751
|
prev?: string | null;
|
|
4874
4752
|
}
|
|
4753
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
4754
|
+
createdEvent?: EntityCreatedEvent;
|
|
4755
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
4756
|
+
deletedEvent?: EntityDeletedEvent;
|
|
4757
|
+
actionEvent?: ActionEvent;
|
|
4758
|
+
/**
|
|
4759
|
+
* Unique event ID.
|
|
4760
|
+
* Allows clients to ignore duplicate webhooks.
|
|
4761
|
+
*/
|
|
4762
|
+
_id?: string;
|
|
4763
|
+
/**
|
|
4764
|
+
* Assumes actions are also always typed to an entity_type
|
|
4765
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
4766
|
+
*/
|
|
4767
|
+
entityFqdn?: string;
|
|
4768
|
+
/**
|
|
4769
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
4770
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
4771
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
4772
|
+
*/
|
|
4773
|
+
slug?: string;
|
|
4774
|
+
/** ID of the entity associated with the event. */
|
|
4775
|
+
entityId?: string;
|
|
4776
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
4777
|
+
eventTime?: Date | null;
|
|
4778
|
+
/**
|
|
4779
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
4780
|
+
* (for example, GDPR).
|
|
4781
|
+
*/
|
|
4782
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
4783
|
+
/** If present, indicates the action that triggered the event. */
|
|
4784
|
+
originatedFrom?: string | null;
|
|
4785
|
+
/**
|
|
4786
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
4787
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
4788
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
4789
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
4790
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
4791
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
4792
|
+
*/
|
|
4793
|
+
entityEventSequence?: string | null;
|
|
4794
|
+
}
|
|
4795
|
+
/** @oneof */
|
|
4796
|
+
interface DomainEventBodyOneOf {
|
|
4797
|
+
createdEvent?: EntityCreatedEvent;
|
|
4798
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
4799
|
+
deletedEvent?: EntityDeletedEvent;
|
|
4800
|
+
actionEvent?: ActionEvent;
|
|
4801
|
+
}
|
|
4802
|
+
interface EntityCreatedEvent {
|
|
4803
|
+
entity?: string;
|
|
4804
|
+
}
|
|
4805
|
+
interface RestoreInfo {
|
|
4806
|
+
deletedDate?: Date | null;
|
|
4807
|
+
}
|
|
4808
|
+
interface EntityUpdatedEvent {
|
|
4809
|
+
/**
|
|
4810
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
4811
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
4812
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
4813
|
+
*/
|
|
4814
|
+
currentEntity?: string;
|
|
4815
|
+
}
|
|
4816
|
+
interface EntityDeletedEvent {
|
|
4817
|
+
/** Entity that was deleted */
|
|
4818
|
+
deletedEntity?: string | null;
|
|
4819
|
+
}
|
|
4820
|
+
interface ActionEvent {
|
|
4821
|
+
body?: string;
|
|
4822
|
+
}
|
|
4875
4823
|
interface Empty {
|
|
4876
4824
|
}
|
|
4877
4825
|
interface CopyAutomationRequest {
|
|
@@ -5485,6 +5433,56 @@ interface UpgradeCTA {
|
|
|
5485
5433
|
/** CTA button label. */
|
|
5486
5434
|
label?: string;
|
|
5487
5435
|
}
|
|
5436
|
+
interface MessageEnvelope {
|
|
5437
|
+
/** App instance ID. */
|
|
5438
|
+
instanceId?: string | null;
|
|
5439
|
+
/** Event type. */
|
|
5440
|
+
eventType?: string;
|
|
5441
|
+
/** The identification type and identity data. */
|
|
5442
|
+
identity?: IdentificationData;
|
|
5443
|
+
/** Stringify payload. */
|
|
5444
|
+
data?: string;
|
|
5445
|
+
}
|
|
5446
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
5447
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
5448
|
+
anonymousVisitorId?: string;
|
|
5449
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
5450
|
+
memberId?: string;
|
|
5451
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
5452
|
+
wixUserId?: string;
|
|
5453
|
+
/** ID of an app. */
|
|
5454
|
+
appId?: string;
|
|
5455
|
+
/** @readonly */
|
|
5456
|
+
identityType?: WebhookIdentityType;
|
|
5457
|
+
}
|
|
5458
|
+
/** @oneof */
|
|
5459
|
+
interface IdentificationDataIdOneOf {
|
|
5460
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
5461
|
+
anonymousVisitorId?: string;
|
|
5462
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
5463
|
+
memberId?: string;
|
|
5464
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
5465
|
+
wixUserId?: string;
|
|
5466
|
+
/** ID of an app. */
|
|
5467
|
+
appId?: string;
|
|
5468
|
+
}
|
|
5469
|
+
declare enum WebhookIdentityType {
|
|
5470
|
+
UNKNOWN = "UNKNOWN",
|
|
5471
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
5472
|
+
MEMBER = "MEMBER",
|
|
5473
|
+
WIX_USER = "WIX_USER",
|
|
5474
|
+
APP = "APP"
|
|
5475
|
+
}
|
|
5476
|
+
interface GetAutomationRevisionRequest {
|
|
5477
|
+
/** Automation ID. */
|
|
5478
|
+
automationId?: string;
|
|
5479
|
+
/** Automation revision. */
|
|
5480
|
+
revision?: string | null;
|
|
5481
|
+
}
|
|
5482
|
+
interface GetAutomationRevisionResponse {
|
|
5483
|
+
/** Automation with the relevant revision. */
|
|
5484
|
+
automation?: Automation;
|
|
5485
|
+
}
|
|
5488
5486
|
interface ApplicationOriginNonNullableFields {
|
|
5489
5487
|
appId: string;
|
|
5490
5488
|
}
|