@wix/automations 1.0.8 → 1.0.9

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.
@@ -1,5 +1,5 @@
1
1
  /** Automation */
2
- interface Automation$1 {
2
+ interface Automation$3 {
3
3
  /**
4
4
  * Automation ID
5
5
  * @readonly
@@ -15,9 +15,9 @@ interface Automation$1 {
15
15
  * Automation Type
16
16
  * @readonly
17
17
  */
18
- type?: Type$1;
18
+ type?: Type$3;
19
19
  /** Automation Status */
20
- status?: Status$1;
20
+ status?: Status$3;
21
21
  /** Rule that contains a trigger and some actions */
22
22
  rule?: Rule$1;
23
23
  /**
@@ -53,30 +53,30 @@ interface Automation$1 {
53
53
  /** @readonly */
54
54
  migratedToV3?: boolean | null;
55
55
  }
56
- declare enum Type$1 {
56
+ declare enum Type$3 {
57
57
  CUSTOM = "CUSTOM",
58
58
  APPLICATION = "APPLICATION"
59
59
  }
60
- declare enum Status$1 {
60
+ declare enum Status$3 {
61
61
  ACTIVE = "ACTIVE",
62
62
  INACTIVE = "INACTIVE"
63
63
  }
64
64
  interface Rule$1 {
65
65
  /** an event triggered by visitors on a site, or by a site manager (owner & team). */
66
- trigger?: Trigger$1;
66
+ trigger?: Trigger$3;
67
67
  /**
68
68
  * the actions responding to the trigger happening.
69
69
  * ** IMPORTANT NOTE: the order of the actions is important, and will be executed in the order they appear in the list **
70
70
  */
71
- actions?: Action$1[];
71
+ actions?: Action$3[];
72
72
  }
73
- interface Trigger$1 {
73
+ interface Trigger$3 {
74
74
  /** the id of the app defining the trigger */
75
75
  appId?: string;
76
76
  /** Identifier for this trigger - human readable action key */
77
77
  triggerKey?: string;
78
78
  /** optional list of filters on schema fields */
79
- filters?: Filter$1[];
79
+ filters?: Filter$3[];
80
80
  /**
81
81
  * optional - allows to define a trigger whose following actions will be executed only if the same event for the same resource has not in the last X seconds.
82
82
  * for example, if the trigger is "session booked", the resource is a contact and the timeframe is 3600 seconds (contact hasn't booked another session in the last hour),
@@ -84,7 +84,7 @@ interface Trigger$1 {
84
84
  */
85
85
  debounce?: Debounce$1;
86
86
  }
87
- interface Filter$1 {
87
+ interface Filter$3 {
88
88
  /** the filter identifier */
89
89
  id?: string | null;
90
90
  /** the field key from the schema, for example "formId" */
@@ -106,7 +106,7 @@ interface Debounce$1 {
106
106
  */
107
107
  fieldKey?: string;
108
108
  }
109
- interface Action$1 {
109
+ interface Action$3 {
110
110
  /**
111
111
  * the id of the action for delayed events
112
112
  * @readonly
@@ -135,7 +135,7 @@ interface Action$1 {
135
135
  /** Optional delay configuration for the action */
136
136
  delay?: Delay$1;
137
137
  /** allows you define an activation policy - like number of activations in a time frame, or limit by some identifier, like contact (e.g. send email to user only at first login) */
138
- rateLimit?: RateLimit$1;
138
+ rateLimit?: RateLimit$3;
139
139
  /**
140
140
  * allows the user to define a condition for the action to be executed, if the condition fails the action (and following actions) will not be executed
141
141
  * @deprecated allows the user to define a condition for the action to be executed, if the condition fails the action (and following actions) will not be executed
@@ -189,7 +189,7 @@ interface DelayTypeOneOf$1 {
189
189
  /** A delay which is calculated based on a date field in the trigger payload. May also be used together with an Offset delay. */
190
190
  until?: Until$1;
191
191
  }
192
- interface RateLimit$1 {
192
+ interface RateLimit$3 {
193
193
  /** time frame in minutes */
194
194
  timeFrame?: number | null;
195
195
  /** number of activations allowed in the given time frame */
@@ -234,7 +234,7 @@ interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
234
234
  /** Paging options to limit and skip the number of items. */
235
235
  paging?: Paging$1;
236
236
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
237
- cursorPaging?: CursorPaging$1;
237
+ cursorPaging?: CursorPaging$3;
238
238
  /**
239
239
  * Filter object in the following format:
240
240
  * `"filter" : {
@@ -248,7 +248,7 @@ interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
248
248
  * Sort object in the following format:
249
249
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
250
250
  */
251
- sort?: Sorting$1[];
251
+ sort?: Sorting$3[];
252
252
  /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
253
253
  fields?: string[];
254
254
  /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
@@ -259,15 +259,15 @@ interface QueryV2PagingMethodOneOf$1 {
259
259
  /** Paging options to limit and skip the number of items. */
260
260
  paging?: Paging$1;
261
261
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
262
- cursorPaging?: CursorPaging$1;
262
+ cursorPaging?: CursorPaging$3;
263
263
  }
264
- interface Sorting$1 {
264
+ interface Sorting$3 {
265
265
  /** Name of the field to sort by. */
266
266
  fieldName?: string;
267
267
  /** Sort order. */
268
- order?: SortOrder$1;
268
+ order?: SortOrder$3;
269
269
  }
270
- declare enum SortOrder$1 {
270
+ declare enum SortOrder$3 {
271
271
  ASC = "ASC",
272
272
  DESC = "DESC"
273
273
  }
@@ -277,7 +277,7 @@ interface Paging$1 {
277
277
  /** Number of items to skip in the current sort order. */
278
278
  offset?: number | null;
279
279
  }
280
- interface CursorPaging$1 {
280
+ interface CursorPaging$3 {
281
281
  /** Maximum number of items to return in the results. */
282
282
  limit?: number | null;
283
283
  /**
@@ -298,109 +298,109 @@ interface PagingMetadataV2$1 {
298
298
  /** Flag that indicates the server failed to calculate the `total` field. */
299
299
  tooManyToCount?: boolean | null;
300
300
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
301
- cursors?: Cursors$1;
301
+ cursors?: Cursors$3;
302
302
  }
303
- interface Cursors$1 {
303
+ interface Cursors$3 {
304
304
  /** Cursor string pointing to the next page in the list of results. */
305
305
  next?: string | null;
306
306
  /** Cursor pointing to the previous page in the list of results. */
307
307
  prev?: string | null;
308
308
  }
309
- interface CreateAutomationRequest$1 {
309
+ interface CreateAutomationRequest$3 {
310
310
  /** Automation to be created */
311
- automation: Automation$1;
311
+ automation: Automation$3;
312
312
  }
313
- interface CreateAutomationResponse$1 {
313
+ interface CreateAutomationResponse$3 {
314
314
  /** The created Automation */
315
- automation?: Automation$1;
315
+ automation?: Automation$3;
316
316
  }
317
- interface GetAutomationRequest$1 {
317
+ interface GetAutomationRequest$3 {
318
318
  /** Automation ID */
319
319
  automationId: string;
320
320
  /** Automation type */
321
- automationType?: Type$1;
321
+ automationType?: Type$3;
322
322
  }
323
- interface GetAutomationResponse$1 {
323
+ interface GetAutomationResponse$3 {
324
324
  /** Automation */
325
- automation?: Automation$1;
325
+ automation?: Automation$3;
326
326
  }
327
- interface UpdateAutomationRequest$1 {
327
+ interface UpdateAutomationRequest$3 {
328
328
  /** Automation to be updated, may be partial */
329
- automation: Automation$1;
329
+ automation: Automation$3;
330
330
  }
331
- interface UpdateAutomationResponse$1 {
331
+ interface UpdateAutomationResponse$3 {
332
332
  /** The updated Automation */
333
- automation?: Automation$1;
333
+ automation?: Automation$3;
334
334
  }
335
- interface DeleteAutomationRequest$1 {
335
+ interface DeleteAutomationRequest$3 {
336
336
  /** Id of the Automation to delete */
337
337
  automationId: string;
338
338
  /** The revision of the Automation */
339
339
  revision?: string;
340
340
  }
341
- interface DeleteAutomationResponse$1 {
341
+ interface DeleteAutomationResponse$3 {
342
342
  }
343
- interface QueryAutomationsRequest$1 {
343
+ interface QueryAutomationsRequest$3 {
344
344
  /** WQL expression */
345
345
  query: QueryV2$1;
346
346
  /** Automation type */
347
- automationType?: Type$1;
347
+ automationType?: Type$3;
348
348
  }
349
- interface QueryAutomationsResponse$1 {
349
+ interface QueryAutomationsResponse$3 {
350
350
  /** List of automations */
351
- automations?: Automation$1[];
351
+ automations?: Automation$3[];
352
352
  /** Paging metadata */
353
353
  paging?: PagingMetadataV2$1;
354
354
  }
355
355
  interface OverrideApplicationAutomationRequest$1 {
356
356
  /** Application Automation */
357
- automation: Automation$1;
357
+ automation: Automation$3;
358
358
  }
359
359
  interface OverrideApplicationAutomationResponse$1 {
360
360
  /** Custom Automation */
361
- automation?: Automation$1;
361
+ automation?: Automation$3;
362
362
  }
363
363
  interface ValidateAutomationByIdRequest$1 {
364
364
  /** Automation ID */
365
365
  automationId: string;
366
366
  /** Automation type */
367
- automationType?: Type$1;
367
+ automationType?: Type$3;
368
368
  }
369
369
  interface ValidateAutomationByIdResponse$1 {
370
370
  /** is the Automation valid */
371
371
  valid?: boolean;
372
372
  /** list of validation errors for the automation Trigger */
373
- triggerValidationErrors?: TriggerValidationError$1[];
373
+ triggerValidationErrors?: TriggerValidationError$3[];
374
374
  /** list of validation information for the automation Actions */
375
- actionValidationInfo?: ActionValidationInfo$1[];
375
+ actionValidationInfo?: ActionValidationInfo$3[];
376
376
  }
377
- interface TriggerValidationError$1 extends TriggerValidationErrorErrorOneOf$1 {
377
+ interface TriggerValidationError$3 extends TriggerValidationErrorErrorOneOf$3 {
378
378
  /** trigger configuration error */
379
- configurationError?: TriggerConfigurationError$1;
379
+ configurationError?: TriggerConfigurationError$3;
380
380
  /** provider configuration error */
381
- providerConfigurationError?: ProviderConfigurationError$1;
381
+ providerConfigurationError?: ProviderConfigurationError$3;
382
382
  /** validation error type */
383
- errorType?: TriggerValidationErrorValidationErrorType$1;
383
+ errorType?: TriggerValidationErrorValidationErrorType$3;
384
384
  }
385
385
  /** @oneof */
386
- interface TriggerValidationErrorErrorOneOf$1 {
386
+ interface TriggerValidationErrorErrorOneOf$3 {
387
387
  /** trigger configuration error */
388
- configurationError?: TriggerConfigurationError$1;
388
+ configurationError?: TriggerConfigurationError$3;
389
389
  /** provider configuration error */
390
- providerConfigurationError?: ProviderConfigurationError$1;
390
+ providerConfigurationError?: ProviderConfigurationError$3;
391
391
  }
392
- declare enum TriggerValidationErrorValidationErrorType$1 {
392
+ declare enum TriggerValidationErrorValidationErrorType$3 {
393
393
  UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
394
394
  CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
395
395
  PROVIDER_ERROR = "PROVIDER_ERROR"
396
396
  }
397
- interface TriggerConfigurationError$1 {
397
+ interface TriggerConfigurationError$3 {
398
398
  /** trigger error type */
399
- errorType?: TriggerErrorType$1;
399
+ errorType?: TriggerErrorType$3;
400
400
  /** optional - related filter field key */
401
401
  filterFieldKey?: string | null;
402
402
  }
403
- declare enum TriggerErrorType$1 {
403
+ declare enum TriggerErrorType$3 {
404
404
  UNKNOWN_TRIGGER_ERROR_TYPE = "UNKNOWN_TRIGGER_ERROR_TYPE",
405
405
  NOT_FOUND = "NOT_FOUND",
406
406
  APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
@@ -410,7 +410,7 @@ declare enum TriggerErrorType$1 {
410
410
  INVALID_FILTER_FIELD_KEY = "INVALID_FILTER_FIELD_KEY",
411
411
  INVALID_FILTER_EXPRESSION = "INVALID_FILTER_EXPRESSION"
412
412
  }
413
- interface ProviderConfigurationError$1 {
413
+ interface ProviderConfigurationError$3 {
414
414
  /** Key corresponding to the field in the schema. */
415
415
  fieldKey?: string | null;
416
416
  /** Error message. */
@@ -422,7 +422,7 @@ interface ProviderConfigurationError$1 {
422
422
  /** Title for the error. */
423
423
  title?: string;
424
424
  }
425
- interface ActionValidationInfo$1 {
425
+ interface ActionValidationInfo$3 {
426
426
  /** the id of the action in the automation */
427
427
  actionId?: string | null;
428
428
  /** the id of the app defining the action */
@@ -430,35 +430,35 @@ interface ActionValidationInfo$1 {
430
430
  /** human readable identifier of the action per app */
431
431
  actionKey?: string;
432
432
  /** list of action validation errors */
433
- validationErrors?: ActionValidationError$1[];
433
+ validationErrors?: ActionValidationError$3[];
434
434
  }
435
- interface ActionValidationError$1 extends ActionValidationErrorErrorOneOf$1 {
435
+ interface ActionValidationError$3 extends ActionValidationErrorErrorOneOf$3 {
436
436
  /** action configuration error */
437
- configurationError?: ActionConfigurationError$1;
437
+ configurationError?: ActionConfigurationError$3;
438
438
  /** provider configuration error */
439
- providerConfigurationError?: ProviderConfigurationError$1;
439
+ providerConfigurationError?: ProviderConfigurationError$3;
440
440
  /** validation error type */
441
- errorType?: ValidationErrorType$1;
441
+ errorType?: ValidationErrorType$3;
442
442
  }
443
443
  /** @oneof */
444
- interface ActionValidationErrorErrorOneOf$1 {
444
+ interface ActionValidationErrorErrorOneOf$3 {
445
445
  /** action configuration error */
446
- configurationError?: ActionConfigurationError$1;
446
+ configurationError?: ActionConfigurationError$3;
447
447
  /** provider configuration error */
448
- providerConfigurationError?: ProviderConfigurationError$1;
448
+ providerConfigurationError?: ProviderConfigurationError$3;
449
449
  }
450
- declare enum ValidationErrorType$1 {
450
+ declare enum ValidationErrorType$3 {
451
451
  UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
452
452
  CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
453
453
  PROVIDER_ERROR = "PROVIDER_ERROR"
454
454
  }
455
- interface ActionConfigurationError$1 {
455
+ interface ActionConfigurationError$3 {
456
456
  /** action error type */
457
- errorType?: ActionErrorType$1;
457
+ errorType?: ActionErrorType$3;
458
458
  /** optional - related field key */
459
459
  fieldKey?: string | null;
460
460
  }
461
- declare enum ActionErrorType$1 {
461
+ declare enum ActionErrorType$3 {
462
462
  UNKNOWN_ACTION_ERROR_TYPE = "UNKNOWN_ACTION_ERROR_TYPE",
463
463
  NOT_FOUND = "NOT_FOUND",
464
464
  APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
@@ -474,17 +474,17 @@ declare enum ActionErrorType$1 {
474
474
  INPUT_MAPPING_SCHEMA_MISMATCH = "INPUT_MAPPING_SCHEMA_MISMATCH",
475
475
  INPUT_MAPPING_VARIABLE_MISSING_FROM_SCHEMA = "INPUT_MAPPING_VARIABLE_MISSING_FROM_SCHEMA"
476
476
  }
477
- interface ValidateAutomationRequest$1 {
477
+ interface ValidateAutomationRequest$3 {
478
478
  /** Automation to validate */
479
- automation: Automation$1;
479
+ automation: Automation$3;
480
480
  }
481
- interface ValidateAutomationResponse$1 {
481
+ interface ValidateAutomationResponse$3 {
482
482
  /** is the Automation valid */
483
483
  valid?: boolean;
484
484
  /** list of validation errors for the automation Trigger */
485
- triggerValidationErrors?: TriggerValidationError$1[];
485
+ triggerValidationErrors?: TriggerValidationError$3[];
486
486
  /** list of validation information for the automation Actions */
487
- actionValidationInfo?: ActionValidationInfo$1[];
487
+ actionValidationInfo?: ActionValidationInfo$3[];
488
488
  }
489
489
  interface GetAutomationActivationReportsRequest$1 {
490
490
  /** Automation ID */
@@ -529,7 +529,7 @@ interface PagingMetadata$1 {
529
529
  /** Flag that indicates the server failed to calculate the `total` field. */
530
530
  tooManyToCount?: boolean | null;
531
531
  }
532
- interface FilterNonNullableFields$1 {
532
+ interface FilterNonNullableFields$3 {
533
533
  fieldKey: string;
534
534
  filterExpression: string;
535
535
  }
@@ -537,10 +537,10 @@ interface DebounceNonNullableFields$1 {
537
537
  timeFrameInSeconds: number;
538
538
  fieldKey: string;
539
539
  }
540
- interface TriggerNonNullableFields$1 {
540
+ interface TriggerNonNullableFields$3 {
541
541
  appId: string;
542
542
  triggerKey: string;
543
- filters: FilterNonNullableFields$1[];
543
+ filters: FilterNonNullableFields$3[];
544
544
  debounce?: DebounceNonNullableFields$1;
545
545
  }
546
546
  interface OffsetNonNullableFields$1 {
@@ -555,7 +555,7 @@ interface DelayNonNullableFields$1 {
555
555
  for?: OffsetNonNullableFields$1;
556
556
  until?: UntilNonNullableFields$1;
557
557
  }
558
- interface RateLimitNonNullableFields$1 {
558
+ interface RateLimitNonNullableFields$3 {
559
559
  activations: number;
560
560
  }
561
561
  interface ConditionNonNullableFields$1 {
@@ -573,12 +573,12 @@ interface ActionNonNullableFields$1 {
573
573
  actionKey: string;
574
574
  actionConfig: string;
575
575
  delay?: DelayNonNullableFields$1;
576
- rateLimit?: RateLimitNonNullableFields$1;
576
+ rateLimit?: RateLimitNonNullableFields$3;
577
577
  condition?: ConditionNonNullableFields$1;
578
578
  conditions?: ConditionsNonNullableFields$1;
579
579
  }
580
580
  interface RuleNonNullableFields$1 {
581
- trigger?: TriggerNonNullableFields$1;
581
+ trigger?: TriggerNonNullableFields$3;
582
582
  actions: ActionNonNullableFields$1[];
583
583
  }
584
584
  interface AutomationMetadataNonNullableFields$1 {
@@ -588,63 +588,63 @@ interface AutomationMetadataNonNullableFields$1 {
588
588
  actionRemovalDisabled: boolean;
589
589
  actionConditionsEditingDisabled: boolean;
590
590
  }
591
- interface AutomationNonNullableFields$1 {
591
+ interface AutomationNonNullableFields$3 {
592
592
  name: string;
593
593
  description: string;
594
- type: Type$1;
595
- status: Status$1;
594
+ type: Type$3;
595
+ status: Status$3;
596
596
  rule?: RuleNonNullableFields$1;
597
597
  metadata?: AutomationMetadataNonNullableFields$1;
598
598
  }
599
- interface CreateAutomationResponseNonNullableFields$1 {
600
- automation?: AutomationNonNullableFields$1;
599
+ interface CreateAutomationResponseNonNullableFields$3 {
600
+ automation?: AutomationNonNullableFields$3;
601
601
  }
602
- interface GetAutomationResponseNonNullableFields$1 {
603
- automation?: AutomationNonNullableFields$1;
602
+ interface GetAutomationResponseNonNullableFields$3 {
603
+ automation?: AutomationNonNullableFields$3;
604
604
  }
605
- interface UpdateAutomationResponseNonNullableFields$1 {
606
- automation?: AutomationNonNullableFields$1;
605
+ interface UpdateAutomationResponseNonNullableFields$3 {
606
+ automation?: AutomationNonNullableFields$3;
607
607
  }
608
- interface QueryAutomationsResponseNonNullableFields$1 {
609
- automations: AutomationNonNullableFields$1[];
608
+ interface QueryAutomationsResponseNonNullableFields$3 {
609
+ automations: AutomationNonNullableFields$3[];
610
610
  }
611
611
  interface OverrideApplicationAutomationResponseNonNullableFields$1 {
612
- automation?: AutomationNonNullableFields$1;
612
+ automation?: AutomationNonNullableFields$3;
613
613
  }
614
- interface TriggerConfigurationErrorNonNullableFields$1 {
615
- errorType: TriggerErrorType$1;
614
+ interface TriggerConfigurationErrorNonNullableFields$3 {
615
+ errorType: TriggerErrorType$3;
616
616
  }
617
- interface ProviderConfigurationErrorNonNullableFields$1 {
617
+ interface ProviderConfigurationErrorNonNullableFields$3 {
618
618
  message: string;
619
619
  title: string;
620
620
  }
621
- interface TriggerValidationErrorNonNullableFields$1 {
622
- configurationError?: TriggerConfigurationErrorNonNullableFields$1;
623
- providerConfigurationError?: ProviderConfigurationErrorNonNullableFields$1;
624
- errorType: TriggerValidationErrorValidationErrorType$1;
621
+ interface TriggerValidationErrorNonNullableFields$3 {
622
+ configurationError?: TriggerConfigurationErrorNonNullableFields$3;
623
+ providerConfigurationError?: ProviderConfigurationErrorNonNullableFields$3;
624
+ errorType: TriggerValidationErrorValidationErrorType$3;
625
625
  }
626
- interface ActionConfigurationErrorNonNullableFields$1 {
627
- errorType: ActionErrorType$1;
626
+ interface ActionConfigurationErrorNonNullableFields$3 {
627
+ errorType: ActionErrorType$3;
628
628
  }
629
- interface ActionValidationErrorNonNullableFields$1 {
630
- configurationError?: ActionConfigurationErrorNonNullableFields$1;
631
- providerConfigurationError?: ProviderConfigurationErrorNonNullableFields$1;
632
- errorType: ValidationErrorType$1;
629
+ interface ActionValidationErrorNonNullableFields$3 {
630
+ configurationError?: ActionConfigurationErrorNonNullableFields$3;
631
+ providerConfigurationError?: ProviderConfigurationErrorNonNullableFields$3;
632
+ errorType: ValidationErrorType$3;
633
633
  }
634
- interface ActionValidationInfoNonNullableFields$1 {
634
+ interface ActionValidationInfoNonNullableFields$3 {
635
635
  appId: string;
636
636
  actionKey: string;
637
- validationErrors: ActionValidationErrorNonNullableFields$1[];
637
+ validationErrors: ActionValidationErrorNonNullableFields$3[];
638
638
  }
639
639
  interface ValidateAutomationByIdResponseNonNullableFields$1 {
640
640
  valid: boolean;
641
- triggerValidationErrors: TriggerValidationErrorNonNullableFields$1[];
642
- actionValidationInfo: ActionValidationInfoNonNullableFields$1[];
641
+ triggerValidationErrors: TriggerValidationErrorNonNullableFields$3[];
642
+ actionValidationInfo: ActionValidationInfoNonNullableFields$3[];
643
643
  }
644
- interface ValidateAutomationResponseNonNullableFields$1 {
644
+ interface ValidateAutomationResponseNonNullableFields$3 {
645
645
  valid: boolean;
646
- triggerValidationErrors: TriggerValidationErrorNonNullableFields$1[];
647
- actionValidationInfo: ActionValidationInfoNonNullableFields$1[];
646
+ triggerValidationErrors: TriggerValidationErrorNonNullableFields$3[];
647
+ actionValidationInfo: ActionValidationInfoNonNullableFields$3[];
648
648
  }
649
649
  interface ActivationReportNonNullableFields$1 {
650
650
  activationId: string;
@@ -656,7 +656,7 @@ interface GetAutomationActivationReportsResponseNonNullableFields$1 {
656
656
  }
657
657
 
658
658
  /** Automation */
659
- interface Automation {
659
+ interface Automation$2 {
660
660
  /**
661
661
  * Automation ID
662
662
  * @readonly
@@ -672,9 +672,9 @@ interface Automation {
672
672
  * Automation Type
673
673
  * @readonly
674
674
  */
675
- type?: Type;
675
+ type?: Type$2;
676
676
  /** Automation Status */
677
- status?: Status;
677
+ status?: Status$2;
678
678
  /** Rule that contains a trigger and some actions */
679
679
  rule?: Rule;
680
680
  /**
@@ -710,30 +710,30 @@ interface Automation {
710
710
  /** @readonly */
711
711
  migratedToV3?: boolean | null;
712
712
  }
713
- declare enum Type {
713
+ declare enum Type$2 {
714
714
  CUSTOM = "CUSTOM",
715
715
  APPLICATION = "APPLICATION"
716
716
  }
717
- declare enum Status {
717
+ declare enum Status$2 {
718
718
  ACTIVE = "ACTIVE",
719
719
  INACTIVE = "INACTIVE"
720
720
  }
721
721
  interface Rule {
722
722
  /** an event triggered by visitors on a site, or by a site manager (owner & team). */
723
- trigger?: Trigger;
723
+ trigger?: Trigger$2;
724
724
  /**
725
725
  * the actions responding to the trigger happening.
726
726
  * ** IMPORTANT NOTE: the order of the actions is important, and will be executed in the order they appear in the list **
727
727
  */
728
- actions?: Action[];
728
+ actions?: Action$2[];
729
729
  }
730
- interface Trigger {
730
+ interface Trigger$2 {
731
731
  /** the id of the app defining the trigger */
732
732
  appId?: string;
733
733
  /** Identifier for this trigger - human readable action key */
734
734
  triggerKey?: string;
735
735
  /** optional list of filters on schema fields */
736
- filters?: Filter[];
736
+ filters?: Filter$2[];
737
737
  /**
738
738
  * optional - allows to define a trigger whose following actions will be executed only if the same event for the same resource has not in the last X seconds.
739
739
  * for example, if the trigger is "session booked", the resource is a contact and the timeframe is 3600 seconds (contact hasn't booked another session in the last hour),
@@ -741,7 +741,7 @@ interface Trigger {
741
741
  */
742
742
  debounce?: Debounce;
743
743
  }
744
- interface Filter {
744
+ interface Filter$2 {
745
745
  /** the filter identifier */
746
746
  _id?: string | null;
747
747
  /** the field key from the schema, for example "formId" */
@@ -763,7 +763,7 @@ interface Debounce {
763
763
  */
764
764
  fieldKey?: string;
765
765
  }
766
- interface Action {
766
+ interface Action$2 {
767
767
  /**
768
768
  * the id of the action for delayed events
769
769
  * @readonly
@@ -792,7 +792,7 @@ interface Action {
792
792
  /** Optional delay configuration for the action */
793
793
  delay?: Delay;
794
794
  /** allows you define an activation policy - like number of activations in a time frame, or limit by some identifier, like contact (e.g. send email to user only at first login) */
795
- rateLimit?: RateLimit;
795
+ rateLimit?: RateLimit$2;
796
796
  /**
797
797
  * allows the user to define a condition for the action to be executed, if the condition fails the action (and following actions) will not be executed
798
798
  * @deprecated allows the user to define a condition for the action to be executed, if the condition fails the action (and following actions) will not be executed
@@ -846,7 +846,7 @@ interface DelayTypeOneOf {
846
846
  /** A delay which is calculated based on a date field in the trigger payload. May also be used together with an Offset delay. */
847
847
  until?: Until;
848
848
  }
849
- interface RateLimit {
849
+ interface RateLimit$2 {
850
850
  /** time frame in minutes */
851
851
  timeFrame?: number | null;
852
852
  /** number of activations allowed in the given time frame */
@@ -891,7 +891,7 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
891
891
  /** Paging options to limit and skip the number of items. */
892
892
  paging?: Paging;
893
893
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
894
- cursorPaging?: CursorPaging;
894
+ cursorPaging?: CursorPaging$2;
895
895
  /**
896
896
  * Filter object in the following format:
897
897
  * `"filter" : {
@@ -905,7 +905,7 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
905
905
  * Sort object in the following format:
906
906
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
907
907
  */
908
- sort?: Sorting[];
908
+ sort?: Sorting$2[];
909
909
  /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
910
910
  fields?: string[];
911
911
  /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
@@ -916,15 +916,15 @@ interface QueryV2PagingMethodOneOf {
916
916
  /** Paging options to limit and skip the number of items. */
917
917
  paging?: Paging;
918
918
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
919
- cursorPaging?: CursorPaging;
919
+ cursorPaging?: CursorPaging$2;
920
920
  }
921
- interface Sorting {
921
+ interface Sorting$2 {
922
922
  /** Name of the field to sort by. */
923
923
  fieldName?: string;
924
924
  /** Sort order. */
925
- order?: SortOrder;
925
+ order?: SortOrder$2;
926
926
  }
927
- declare enum SortOrder {
927
+ declare enum SortOrder$2 {
928
928
  ASC = "ASC",
929
929
  DESC = "DESC"
930
930
  }
@@ -934,7 +934,7 @@ interface Paging {
934
934
  /** Number of items to skip in the current sort order. */
935
935
  offset?: number | null;
936
936
  }
937
- interface CursorPaging {
937
+ interface CursorPaging$2 {
938
938
  /** Maximum number of items to return in the results. */
939
939
  limit?: number | null;
940
940
  /**
@@ -955,109 +955,109 @@ interface PagingMetadataV2 {
955
955
  /** Flag that indicates the server failed to calculate the `total` field. */
956
956
  tooManyToCount?: boolean | null;
957
957
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
958
- cursors?: Cursors;
958
+ cursors?: Cursors$2;
959
959
  }
960
- interface Cursors {
960
+ interface Cursors$2 {
961
961
  /** Cursor string pointing to the next page in the list of results. */
962
962
  next?: string | null;
963
963
  /** Cursor pointing to the previous page in the list of results. */
964
964
  prev?: string | null;
965
965
  }
966
- interface CreateAutomationRequest {
966
+ interface CreateAutomationRequest$2 {
967
967
  /** Automation to be created */
968
- automation: Automation;
968
+ automation: Automation$2;
969
969
  }
970
- interface CreateAutomationResponse {
970
+ interface CreateAutomationResponse$2 {
971
971
  /** The created Automation */
972
- automation?: Automation;
972
+ automation?: Automation$2;
973
973
  }
974
- interface GetAutomationRequest {
974
+ interface GetAutomationRequest$2 {
975
975
  /** Automation ID */
976
976
  automationId: string;
977
977
  /** Automation type */
978
- automationType?: Type;
978
+ automationType?: Type$2;
979
979
  }
980
- interface GetAutomationResponse {
980
+ interface GetAutomationResponse$2 {
981
981
  /** Automation */
982
- automation?: Automation;
982
+ automation?: Automation$2;
983
983
  }
984
- interface UpdateAutomationRequest {
984
+ interface UpdateAutomationRequest$2 {
985
985
  /** Automation to be updated, may be partial */
986
- automation: Automation;
986
+ automation: Automation$2;
987
987
  }
988
- interface UpdateAutomationResponse {
988
+ interface UpdateAutomationResponse$2 {
989
989
  /** The updated Automation */
990
- automation?: Automation;
990
+ automation?: Automation$2;
991
991
  }
992
- interface DeleteAutomationRequest {
992
+ interface DeleteAutomationRequest$2 {
993
993
  /** Id of the Automation to delete */
994
994
  automationId: string;
995
995
  /** The revision of the Automation */
996
996
  revision?: string;
997
997
  }
998
- interface DeleteAutomationResponse {
998
+ interface DeleteAutomationResponse$2 {
999
999
  }
1000
- interface QueryAutomationsRequest {
1000
+ interface QueryAutomationsRequest$2 {
1001
1001
  /** WQL expression */
1002
1002
  query: QueryV2;
1003
1003
  /** Automation type */
1004
- automationType?: Type;
1004
+ automationType?: Type$2;
1005
1005
  }
1006
- interface QueryAutomationsResponse {
1006
+ interface QueryAutomationsResponse$2 {
1007
1007
  /** List of automations */
1008
- automations?: Automation[];
1008
+ automations?: Automation$2[];
1009
1009
  /** Paging metadata */
1010
1010
  paging?: PagingMetadataV2;
1011
1011
  }
1012
1012
  interface OverrideApplicationAutomationRequest {
1013
1013
  /** Application Automation */
1014
- automation: Automation;
1014
+ automation: Automation$2;
1015
1015
  }
1016
1016
  interface OverrideApplicationAutomationResponse {
1017
1017
  /** Custom Automation */
1018
- automation?: Automation;
1018
+ automation?: Automation$2;
1019
1019
  }
1020
1020
  interface ValidateAutomationByIdRequest {
1021
1021
  /** Automation ID */
1022
1022
  automationId: string;
1023
1023
  /** Automation type */
1024
- automationType?: Type;
1024
+ automationType?: Type$2;
1025
1025
  }
1026
1026
  interface ValidateAutomationByIdResponse {
1027
1027
  /** is the Automation valid */
1028
1028
  valid?: boolean;
1029
1029
  /** list of validation errors for the automation Trigger */
1030
- triggerValidationErrors?: TriggerValidationError[];
1030
+ triggerValidationErrors?: TriggerValidationError$2[];
1031
1031
  /** list of validation information for the automation Actions */
1032
- actionValidationInfo?: ActionValidationInfo[];
1032
+ actionValidationInfo?: ActionValidationInfo$2[];
1033
1033
  }
1034
- interface TriggerValidationError extends TriggerValidationErrorErrorOneOf {
1034
+ interface TriggerValidationError$2 extends TriggerValidationErrorErrorOneOf$2 {
1035
1035
  /** trigger configuration error */
1036
- configurationError?: TriggerConfigurationError;
1036
+ configurationError?: TriggerConfigurationError$2;
1037
1037
  /** provider configuration error */
1038
- providerConfigurationError?: ProviderConfigurationError;
1038
+ providerConfigurationError?: ProviderConfigurationError$2;
1039
1039
  /** validation error type */
1040
- errorType?: TriggerValidationErrorValidationErrorType;
1040
+ errorType?: TriggerValidationErrorValidationErrorType$2;
1041
1041
  }
1042
1042
  /** @oneof */
1043
- interface TriggerValidationErrorErrorOneOf {
1043
+ interface TriggerValidationErrorErrorOneOf$2 {
1044
1044
  /** trigger configuration error */
1045
- configurationError?: TriggerConfigurationError;
1045
+ configurationError?: TriggerConfigurationError$2;
1046
1046
  /** provider configuration error */
1047
- providerConfigurationError?: ProviderConfigurationError;
1047
+ providerConfigurationError?: ProviderConfigurationError$2;
1048
1048
  }
1049
- declare enum TriggerValidationErrorValidationErrorType {
1049
+ declare enum TriggerValidationErrorValidationErrorType$2 {
1050
1050
  UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
1051
1051
  CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
1052
1052
  PROVIDER_ERROR = "PROVIDER_ERROR"
1053
1053
  }
1054
- interface TriggerConfigurationError {
1054
+ interface TriggerConfigurationError$2 {
1055
1055
  /** trigger error type */
1056
- errorType?: TriggerErrorType;
1056
+ errorType?: TriggerErrorType$2;
1057
1057
  /** optional - related filter field key */
1058
1058
  filterFieldKey?: string | null;
1059
1059
  }
1060
- declare enum TriggerErrorType {
1060
+ declare enum TriggerErrorType$2 {
1061
1061
  UNKNOWN_TRIGGER_ERROR_TYPE = "UNKNOWN_TRIGGER_ERROR_TYPE",
1062
1062
  NOT_FOUND = "NOT_FOUND",
1063
1063
  APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
@@ -1067,7 +1067,7 @@ declare enum TriggerErrorType {
1067
1067
  INVALID_FILTER_FIELD_KEY = "INVALID_FILTER_FIELD_KEY",
1068
1068
  INVALID_FILTER_EXPRESSION = "INVALID_FILTER_EXPRESSION"
1069
1069
  }
1070
- interface ProviderConfigurationError {
1070
+ interface ProviderConfigurationError$2 {
1071
1071
  /** Key corresponding to the field in the schema. */
1072
1072
  fieldKey?: string | null;
1073
1073
  /** Error message. */
@@ -1079,7 +1079,7 @@ interface ProviderConfigurationError {
1079
1079
  /** Title for the error. */
1080
1080
  title?: string;
1081
1081
  }
1082
- interface ActionValidationInfo {
1082
+ interface ActionValidationInfo$2 {
1083
1083
  /** the id of the action in the automation */
1084
1084
  actionId?: string | null;
1085
1085
  /** the id of the app defining the action */
@@ -1087,35 +1087,35 @@ interface ActionValidationInfo {
1087
1087
  /** human readable identifier of the action per app */
1088
1088
  actionKey?: string;
1089
1089
  /** list of action validation errors */
1090
- validationErrors?: ActionValidationError[];
1090
+ validationErrors?: ActionValidationError$2[];
1091
1091
  }
1092
- interface ActionValidationError extends ActionValidationErrorErrorOneOf {
1092
+ interface ActionValidationError$2 extends ActionValidationErrorErrorOneOf$2 {
1093
1093
  /** action configuration error */
1094
- configurationError?: ActionConfigurationError;
1094
+ configurationError?: ActionConfigurationError$2;
1095
1095
  /** provider configuration error */
1096
- providerConfigurationError?: ProviderConfigurationError;
1096
+ providerConfigurationError?: ProviderConfigurationError$2;
1097
1097
  /** validation error type */
1098
- errorType?: ValidationErrorType;
1098
+ errorType?: ValidationErrorType$2;
1099
1099
  }
1100
1100
  /** @oneof */
1101
- interface ActionValidationErrorErrorOneOf {
1101
+ interface ActionValidationErrorErrorOneOf$2 {
1102
1102
  /** action configuration error */
1103
- configurationError?: ActionConfigurationError;
1103
+ configurationError?: ActionConfigurationError$2;
1104
1104
  /** provider configuration error */
1105
- providerConfigurationError?: ProviderConfigurationError;
1105
+ providerConfigurationError?: ProviderConfigurationError$2;
1106
1106
  }
1107
- declare enum ValidationErrorType {
1107
+ declare enum ValidationErrorType$2 {
1108
1108
  UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
1109
1109
  CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
1110
1110
  PROVIDER_ERROR = "PROVIDER_ERROR"
1111
1111
  }
1112
- interface ActionConfigurationError {
1112
+ interface ActionConfigurationError$2 {
1113
1113
  /** action error type */
1114
- errorType?: ActionErrorType;
1114
+ errorType?: ActionErrorType$2;
1115
1115
  /** optional - related field key */
1116
1116
  fieldKey?: string | null;
1117
1117
  }
1118
- declare enum ActionErrorType {
1118
+ declare enum ActionErrorType$2 {
1119
1119
  UNKNOWN_ACTION_ERROR_TYPE = "UNKNOWN_ACTION_ERROR_TYPE",
1120
1120
  NOT_FOUND = "NOT_FOUND",
1121
1121
  APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
@@ -1131,17 +1131,17 @@ declare enum ActionErrorType {
1131
1131
  INPUT_MAPPING_SCHEMA_MISMATCH = "INPUT_MAPPING_SCHEMA_MISMATCH",
1132
1132
  INPUT_MAPPING_VARIABLE_MISSING_FROM_SCHEMA = "INPUT_MAPPING_VARIABLE_MISSING_FROM_SCHEMA"
1133
1133
  }
1134
- interface ValidateAutomationRequest {
1134
+ interface ValidateAutomationRequest$2 {
1135
1135
  /** Automation to validate */
1136
- automation: Automation;
1136
+ automation: Automation$2;
1137
1137
  }
1138
- interface ValidateAutomationResponse {
1138
+ interface ValidateAutomationResponse$2 {
1139
1139
  /** is the Automation valid */
1140
1140
  valid?: boolean;
1141
1141
  /** list of validation errors for the automation Trigger */
1142
- triggerValidationErrors?: TriggerValidationError[];
1142
+ triggerValidationErrors?: TriggerValidationError$2[];
1143
1143
  /** list of validation information for the automation Actions */
1144
- actionValidationInfo?: ActionValidationInfo[];
1144
+ actionValidationInfo?: ActionValidationInfo$2[];
1145
1145
  }
1146
1146
  interface GetAutomationActivationReportsRequest {
1147
1147
  /** Automation ID */
@@ -1186,7 +1186,7 @@ interface PagingMetadata {
1186
1186
  /** Flag that indicates the server failed to calculate the `total` field. */
1187
1187
  tooManyToCount?: boolean | null;
1188
1188
  }
1189
- interface FilterNonNullableFields {
1189
+ interface FilterNonNullableFields$2 {
1190
1190
  fieldKey: string;
1191
1191
  filterExpression: string;
1192
1192
  }
@@ -1194,10 +1194,10 @@ interface DebounceNonNullableFields {
1194
1194
  timeFrameInSeconds: number;
1195
1195
  fieldKey: string;
1196
1196
  }
1197
- interface TriggerNonNullableFields {
1197
+ interface TriggerNonNullableFields$2 {
1198
1198
  appId: string;
1199
1199
  triggerKey: string;
1200
- filters: FilterNonNullableFields[];
1200
+ filters: FilterNonNullableFields$2[];
1201
1201
  debounce?: DebounceNonNullableFields;
1202
1202
  }
1203
1203
  interface OffsetNonNullableFields {
@@ -1212,7 +1212,7 @@ interface DelayNonNullableFields {
1212
1212
  for?: OffsetNonNullableFields;
1213
1213
  until?: UntilNonNullableFields;
1214
1214
  }
1215
- interface RateLimitNonNullableFields {
1215
+ interface RateLimitNonNullableFields$2 {
1216
1216
  activations: number;
1217
1217
  }
1218
1218
  interface ConditionNonNullableFields {
@@ -1230,12 +1230,12 @@ interface ActionNonNullableFields {
1230
1230
  actionKey: string;
1231
1231
  actionConfig: string;
1232
1232
  delay?: DelayNonNullableFields;
1233
- rateLimit?: RateLimitNonNullableFields;
1233
+ rateLimit?: RateLimitNonNullableFields$2;
1234
1234
  condition?: ConditionNonNullableFields;
1235
1235
  conditions?: ConditionsNonNullableFields;
1236
1236
  }
1237
1237
  interface RuleNonNullableFields {
1238
- trigger?: TriggerNonNullableFields;
1238
+ trigger?: TriggerNonNullableFields$2;
1239
1239
  actions: ActionNonNullableFields[];
1240
1240
  }
1241
1241
  interface AutomationMetadataNonNullableFields {
@@ -1245,63 +1245,63 @@ interface AutomationMetadataNonNullableFields {
1245
1245
  actionRemovalDisabled: boolean;
1246
1246
  actionConditionsEditingDisabled: boolean;
1247
1247
  }
1248
- interface AutomationNonNullableFields {
1248
+ interface AutomationNonNullableFields$2 {
1249
1249
  name: string;
1250
1250
  description: string;
1251
- type: Type;
1252
- status: Status;
1251
+ type: Type$2;
1252
+ status: Status$2;
1253
1253
  rule?: RuleNonNullableFields;
1254
1254
  metadata?: AutomationMetadataNonNullableFields;
1255
1255
  }
1256
- interface CreateAutomationResponseNonNullableFields {
1257
- automation?: AutomationNonNullableFields;
1256
+ interface CreateAutomationResponseNonNullableFields$2 {
1257
+ automation?: AutomationNonNullableFields$2;
1258
1258
  }
1259
- interface GetAutomationResponseNonNullableFields {
1260
- automation?: AutomationNonNullableFields;
1259
+ interface GetAutomationResponseNonNullableFields$2 {
1260
+ automation?: AutomationNonNullableFields$2;
1261
1261
  }
1262
- interface UpdateAutomationResponseNonNullableFields {
1263
- automation?: AutomationNonNullableFields;
1262
+ interface UpdateAutomationResponseNonNullableFields$2 {
1263
+ automation?: AutomationNonNullableFields$2;
1264
1264
  }
1265
- interface QueryAutomationsResponseNonNullableFields {
1266
- automations: AutomationNonNullableFields[];
1265
+ interface QueryAutomationsResponseNonNullableFields$2 {
1266
+ automations: AutomationNonNullableFields$2[];
1267
1267
  }
1268
1268
  interface OverrideApplicationAutomationResponseNonNullableFields {
1269
- automation?: AutomationNonNullableFields;
1269
+ automation?: AutomationNonNullableFields$2;
1270
1270
  }
1271
- interface TriggerConfigurationErrorNonNullableFields {
1272
- errorType: TriggerErrorType;
1271
+ interface TriggerConfigurationErrorNonNullableFields$2 {
1272
+ errorType: TriggerErrorType$2;
1273
1273
  }
1274
- interface ProviderConfigurationErrorNonNullableFields {
1274
+ interface ProviderConfigurationErrorNonNullableFields$2 {
1275
1275
  message: string;
1276
1276
  title: string;
1277
1277
  }
1278
- interface TriggerValidationErrorNonNullableFields {
1279
- configurationError?: TriggerConfigurationErrorNonNullableFields;
1280
- providerConfigurationError?: ProviderConfigurationErrorNonNullableFields;
1281
- errorType: TriggerValidationErrorValidationErrorType;
1278
+ interface TriggerValidationErrorNonNullableFields$2 {
1279
+ configurationError?: TriggerConfigurationErrorNonNullableFields$2;
1280
+ providerConfigurationError?: ProviderConfigurationErrorNonNullableFields$2;
1281
+ errorType: TriggerValidationErrorValidationErrorType$2;
1282
1282
  }
1283
- interface ActionConfigurationErrorNonNullableFields {
1284
- errorType: ActionErrorType;
1283
+ interface ActionConfigurationErrorNonNullableFields$2 {
1284
+ errorType: ActionErrorType$2;
1285
1285
  }
1286
- interface ActionValidationErrorNonNullableFields {
1287
- configurationError?: ActionConfigurationErrorNonNullableFields;
1288
- providerConfigurationError?: ProviderConfigurationErrorNonNullableFields;
1289
- errorType: ValidationErrorType;
1286
+ interface ActionValidationErrorNonNullableFields$2 {
1287
+ configurationError?: ActionConfigurationErrorNonNullableFields$2;
1288
+ providerConfigurationError?: ProviderConfigurationErrorNonNullableFields$2;
1289
+ errorType: ValidationErrorType$2;
1290
1290
  }
1291
- interface ActionValidationInfoNonNullableFields {
1291
+ interface ActionValidationInfoNonNullableFields$2 {
1292
1292
  appId: string;
1293
1293
  actionKey: string;
1294
- validationErrors: ActionValidationErrorNonNullableFields[];
1294
+ validationErrors: ActionValidationErrorNonNullableFields$2[];
1295
1295
  }
1296
1296
  interface ValidateAutomationByIdResponseNonNullableFields {
1297
1297
  valid: boolean;
1298
- triggerValidationErrors: TriggerValidationErrorNonNullableFields[];
1299
- actionValidationInfo: ActionValidationInfoNonNullableFields[];
1298
+ triggerValidationErrors: TriggerValidationErrorNonNullableFields$2[];
1299
+ actionValidationInfo: ActionValidationInfoNonNullableFields$2[];
1300
1300
  }
1301
- interface ValidateAutomationResponseNonNullableFields {
1301
+ interface ValidateAutomationResponseNonNullableFields$2 {
1302
1302
  valid: boolean;
1303
- triggerValidationErrors: TriggerValidationErrorNonNullableFields[];
1304
- actionValidationInfo: ActionValidationInfoNonNullableFields[];
1303
+ triggerValidationErrors: TriggerValidationErrorNonNullableFields$2[];
1304
+ actionValidationInfo: ActionValidationInfoNonNullableFields$2[];
1305
1305
  }
1306
1306
  interface ActivationReportNonNullableFields {
1307
1307
  activationId: string;
@@ -1312,7 +1312,7 @@ interface GetAutomationActivationReportsResponseNonNullableFields {
1312
1312
  activationReports: ActivationReportNonNullableFields[];
1313
1313
  }
1314
1314
 
1315
- type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1315
+ type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1316
1316
  getUrl: (context: any) => string;
1317
1317
  httpMethod: K;
1318
1318
  path: string;
@@ -1322,37 +1322,31 @@ type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown,
1322
1322
  __responseType: Q;
1323
1323
  __originalResponseType: R;
1324
1324
  };
1325
- declare function createAutomation(): __PublicMethodMetaInfo$1<'POST', {}, CreateAutomationRequest, CreateAutomationRequest$1, CreateAutomationResponse & CreateAutomationResponseNonNullableFields, CreateAutomationResponse$1 & CreateAutomationResponseNonNullableFields$1>;
1326
- declare function getAutomation(): __PublicMethodMetaInfo$1<'GET', {
1325
+ declare function createAutomation$1(): __PublicMethodMetaInfo$2<'POST', {}, CreateAutomationRequest$2, CreateAutomationRequest$3, CreateAutomationResponse$2 & CreateAutomationResponseNonNullableFields$2, CreateAutomationResponse$3 & CreateAutomationResponseNonNullableFields$3>;
1326
+ declare function getAutomation$1(): __PublicMethodMetaInfo$2<'GET', {
1327
1327
  automationId: string;
1328
- }, GetAutomationRequest, GetAutomationRequest$1, GetAutomationResponse & GetAutomationResponseNonNullableFields, GetAutomationResponse$1 & GetAutomationResponseNonNullableFields$1>;
1329
- declare function updateAutomation(): __PublicMethodMetaInfo$1<'PATCH', {
1328
+ }, GetAutomationRequest$2, GetAutomationRequest$3, GetAutomationResponse$2 & GetAutomationResponseNonNullableFields$2, GetAutomationResponse$3 & GetAutomationResponseNonNullableFields$3>;
1329
+ declare function updateAutomation$1(): __PublicMethodMetaInfo$2<'PATCH', {
1330
1330
  automationId: string;
1331
- }, UpdateAutomationRequest, UpdateAutomationRequest$1, UpdateAutomationResponse & UpdateAutomationResponseNonNullableFields, UpdateAutomationResponse$1 & UpdateAutomationResponseNonNullableFields$1>;
1332
- declare function deleteAutomation(): __PublicMethodMetaInfo$1<'DELETE', {
1331
+ }, UpdateAutomationRequest$2, UpdateAutomationRequest$3, UpdateAutomationResponse$2 & UpdateAutomationResponseNonNullableFields$2, UpdateAutomationResponse$3 & UpdateAutomationResponseNonNullableFields$3>;
1332
+ declare function deleteAutomation$1(): __PublicMethodMetaInfo$2<'DELETE', {
1333
1333
  automationId: string;
1334
- }, DeleteAutomationRequest, DeleteAutomationRequest$1, DeleteAutomationResponse, DeleteAutomationResponse$1>;
1335
- declare function queryAutomations(): __PublicMethodMetaInfo$1<'POST', {}, QueryAutomationsRequest, QueryAutomationsRequest$1, QueryAutomationsResponse & QueryAutomationsResponseNonNullableFields, QueryAutomationsResponse$1 & QueryAutomationsResponseNonNullableFields$1>;
1336
- declare function overrideApplicationAutomation(): __PublicMethodMetaInfo$1<'POST', {}, OverrideApplicationAutomationRequest, OverrideApplicationAutomationRequest$1, OverrideApplicationAutomationResponse & OverrideApplicationAutomationResponseNonNullableFields, OverrideApplicationAutomationResponse$1 & OverrideApplicationAutomationResponseNonNullableFields$1>;
1337
- declare function validateAutomationById(): __PublicMethodMetaInfo$1<'POST', {
1334
+ }, DeleteAutomationRequest$2, DeleteAutomationRequest$3, DeleteAutomationResponse$2, DeleteAutomationResponse$3>;
1335
+ declare function queryAutomations$1(): __PublicMethodMetaInfo$2<'POST', {}, QueryAutomationsRequest$2, QueryAutomationsRequest$3, QueryAutomationsResponse$2 & QueryAutomationsResponseNonNullableFields$2, QueryAutomationsResponse$3 & QueryAutomationsResponseNonNullableFields$3>;
1336
+ declare function overrideApplicationAutomation(): __PublicMethodMetaInfo$2<'POST', {}, OverrideApplicationAutomationRequest, OverrideApplicationAutomationRequest$1, OverrideApplicationAutomationResponse & OverrideApplicationAutomationResponseNonNullableFields, OverrideApplicationAutomationResponse$1 & OverrideApplicationAutomationResponseNonNullableFields$1>;
1337
+ declare function validateAutomationById(): __PublicMethodMetaInfo$2<'POST', {
1338
1338
  automationId: string;
1339
1339
  }, ValidateAutomationByIdRequest, ValidateAutomationByIdRequest$1, ValidateAutomationByIdResponse & ValidateAutomationByIdResponseNonNullableFields, ValidateAutomationByIdResponse$1 & ValidateAutomationByIdResponseNonNullableFields$1>;
1340
- declare function validateAutomation(): __PublicMethodMetaInfo$1<'POST', {}, ValidateAutomationRequest, ValidateAutomationRequest$1, ValidateAutomationResponse & ValidateAutomationResponseNonNullableFields, ValidateAutomationResponse$1 & ValidateAutomationResponseNonNullableFields$1>;
1341
- declare function getAutomationActivationStats(): __PublicMethodMetaInfo$1<'GET', {
1340
+ declare function validateAutomation$1(): __PublicMethodMetaInfo$2<'POST', {}, ValidateAutomationRequest$2, ValidateAutomationRequest$3, ValidateAutomationResponse$2 & ValidateAutomationResponseNonNullableFields$2, ValidateAutomationResponse$3 & ValidateAutomationResponseNonNullableFields$3>;
1341
+ declare function getAutomationActivationStats(): __PublicMethodMetaInfo$2<'GET', {
1342
1342
  automationId: string;
1343
1343
  }, GetAutomationActivationReportsRequest, GetAutomationActivationReportsRequest$1, GetAutomationActivationReportsResponse & GetAutomationActivationReportsResponseNonNullableFields, GetAutomationActivationReportsResponse$1 & GetAutomationActivationReportsResponseNonNullableFields$1>;
1344
1344
 
1345
- declare const meta$1_createAutomation: typeof createAutomation;
1346
- declare const meta$1_deleteAutomation: typeof deleteAutomation;
1347
- declare const meta$1_getAutomation: typeof getAutomation;
1348
- declare const meta$1_getAutomationActivationStats: typeof getAutomationActivationStats;
1349
- declare const meta$1_overrideApplicationAutomation: typeof overrideApplicationAutomation;
1350
- declare const meta$1_queryAutomations: typeof queryAutomations;
1351
- declare const meta$1_updateAutomation: typeof updateAutomation;
1352
- declare const meta$1_validateAutomation: typeof validateAutomation;
1353
- declare const meta$1_validateAutomationById: typeof validateAutomationById;
1354
- declare namespace meta$1 {
1355
- export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_createAutomation as createAutomation, meta$1_deleteAutomation as deleteAutomation, meta$1_getAutomation as getAutomation, meta$1_getAutomationActivationStats as getAutomationActivationStats, meta$1_overrideApplicationAutomation as overrideApplicationAutomation, meta$1_queryAutomations as queryAutomations, meta$1_updateAutomation as updateAutomation, meta$1_validateAutomation as validateAutomation, meta$1_validateAutomationById as validateAutomationById };
1345
+ declare const meta$2_getAutomationActivationStats: typeof getAutomationActivationStats;
1346
+ declare const meta$2_overrideApplicationAutomation: typeof overrideApplicationAutomation;
1347
+ declare const meta$2_validateAutomationById: typeof validateAutomationById;
1348
+ declare namespace meta$2 {
1349
+ export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, createAutomation$1 as createAutomation, deleteAutomation$1 as deleteAutomation, getAutomation$1 as getAutomation, meta$2_getAutomationActivationStats as getAutomationActivationStats, meta$2_overrideApplicationAutomation as overrideApplicationAutomation, queryAutomations$1 as queryAutomations, updateAutomation$1 as updateAutomation, validateAutomation$1 as validateAutomation, meta$2_validateAutomationById as validateAutomationById };
1356
1350
  }
1357
1351
 
1358
1352
  interface ReportEventRequest$1 {
@@ -1767,7 +1761,7 @@ interface BulkCancelEventResponseNonNullableFields {
1767
1761
  bulkActionMetadata?: BulkActionMetadataNonNullableFields;
1768
1762
  }
1769
1763
 
1770
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1764
+ type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1771
1765
  getUrl: (context: any) => string;
1772
1766
  httpMethod: K;
1773
1767
  path: string;
@@ -1777,18 +1771,1459 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
1777
1771
  __responseType: Q;
1778
1772
  __originalResponseType: R;
1779
1773
  };
1780
- declare function reportEvent(): __PublicMethodMetaInfo<'POST', {}, ReportEventRequest, ReportEventRequest$1, ReportEventResponse & ReportEventResponseNonNullableFields, ReportEventResponse$1 & ReportEventResponseNonNullableFields$1>;
1781
- declare function bulkReportEvent(): __PublicMethodMetaInfo<'POST', {}, BulkReportEventRequest, BulkReportEventRequest$1, BulkReportEventResponse & BulkReportEventResponseNonNullableFields, BulkReportEventResponse$1 & BulkReportEventResponseNonNullableFields$1>;
1782
- declare function bulkCancelEvent(): __PublicMethodMetaInfo<'POST', {}, BulkCancelEventRequest, BulkCancelEventRequest$1, BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields, BulkCancelEventResponse$1 & BulkCancelEventResponseNonNullableFields$1>;
1783
- declare function cancelEvent(): __PublicMethodMetaInfo<'POST', {}, CancelEventRequest, CancelEventRequest$1, CancelEventResponse, CancelEventResponse$1>;
1774
+ declare function reportEvent(): __PublicMethodMetaInfo$1<'POST', {}, ReportEventRequest, ReportEventRequest$1, ReportEventResponse & ReportEventResponseNonNullableFields, ReportEventResponse$1 & ReportEventResponseNonNullableFields$1>;
1775
+ declare function bulkReportEvent(): __PublicMethodMetaInfo$1<'POST', {}, BulkReportEventRequest, BulkReportEventRequest$1, BulkReportEventResponse & BulkReportEventResponseNonNullableFields, BulkReportEventResponse$1 & BulkReportEventResponseNonNullableFields$1>;
1776
+ declare function bulkCancelEvent(): __PublicMethodMetaInfo$1<'POST', {}, BulkCancelEventRequest, BulkCancelEventRequest$1, BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields, BulkCancelEventResponse$1 & BulkCancelEventResponseNonNullableFields$1>;
1777
+ declare function cancelEvent(): __PublicMethodMetaInfo$1<'POST', {}, CancelEventRequest, CancelEventRequest$1, CancelEventResponse, CancelEventResponse$1>;
1778
+
1779
+ declare const meta$1_bulkCancelEvent: typeof bulkCancelEvent;
1780
+ declare const meta$1_bulkReportEvent: typeof bulkReportEvent;
1781
+ declare const meta$1_cancelEvent: typeof cancelEvent;
1782
+ declare const meta$1_reportEvent: typeof reportEvent;
1783
+ declare namespace meta$1 {
1784
+ export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_bulkCancelEvent as bulkCancelEvent, meta$1_bulkReportEvent as bulkReportEvent, meta$1_cancelEvent as cancelEvent, meta$1_reportEvent as reportEvent };
1785
+ }
1786
+
1787
+ /** Automation */
1788
+ interface Automation$1 extends AutomationOriginInfoOneOf$1 {
1789
+ /** Application info */
1790
+ applicationInfo?: ApplicationOrigin$1;
1791
+ /** Preinstalled info */
1792
+ preinstalledInfo?: PreinstalledOrigin$1;
1793
+ /**
1794
+ * Automation ID.
1795
+ * @readonly
1796
+ */
1797
+ id?: string | null;
1798
+ /**
1799
+ * Revision number, which increments by 1 each time the Automation is updated.
1800
+ * To prevent conflicting changes,
1801
+ * the current revision must be passed when updating the Automation.
1802
+ *
1803
+ * Ignored when creating an Automation.
1804
+ * @readonly
1805
+ */
1806
+ revision?: string | null;
1807
+ /**
1808
+ * information about the creator of the automation
1809
+ * @readonly
1810
+ */
1811
+ createdBy?: AuditInfo$1;
1812
+ /**
1813
+ * Date and time the Automation was created.
1814
+ * @readonly
1815
+ */
1816
+ createdDate?: Date;
1817
+ /**
1818
+ * information about who updated of the automation
1819
+ * @readonly
1820
+ */
1821
+ updatedBy?: AuditInfo$1;
1822
+ /**
1823
+ * Date and time the Automation was last updated.
1824
+ * @readonly
1825
+ */
1826
+ updatedDate?: Date;
1827
+ /** Automation name */
1828
+ name?: string;
1829
+ /** Automation description */
1830
+ description?: string | null;
1831
+ /** Automation runtime configuration */
1832
+ configuration?: AutomationConfiguration$1;
1833
+ /** Origin type */
1834
+ origin?: Origin$1;
1835
+ /** Automation settings */
1836
+ settings?: AutomationSettings$1;
1837
+ }
1838
+ /** @oneof */
1839
+ interface AutomationOriginInfoOneOf$1 {
1840
+ /** Application info */
1841
+ applicationInfo?: ApplicationOrigin$1;
1842
+ /** Preinstalled info */
1843
+ preinstalledInfo?: PreinstalledOrigin$1;
1844
+ }
1845
+ interface ActionSettings$1 {
1846
+ /** list of permanent action ids of actions that cannot be deleted (default - empty, all actions are deletable by default) */
1847
+ permanentActionIds?: string[];
1848
+ /** list of readonly action ids, (default - empty, all actions are editable by default) */
1849
+ readonlyActionIds?: string[];
1850
+ /** sets if adding a delay action is disabled for this automation */
1851
+ disableDelayAddition?: boolean;
1852
+ /** sets if adding a condition action is disabled for this automation */
1853
+ disableConditionAddition?: boolean;
1854
+ }
1855
+ interface AuditInfo$1 extends AuditInfoIdOneOf$1 {
1856
+ /** user identifier */
1857
+ userId?: string;
1858
+ /** application identifier */
1859
+ appId?: string;
1860
+ }
1861
+ /** @oneof */
1862
+ interface AuditInfoIdOneOf$1 {
1863
+ /** user identifier */
1864
+ userId?: string;
1865
+ /** application identifier */
1866
+ appId?: string;
1867
+ }
1868
+ /** Automation runtime configuration */
1869
+ interface AutomationConfiguration$1 {
1870
+ /** Automation's Status */
1871
+ status?: Status$1;
1872
+ /** Trigger configuration */
1873
+ trigger?: Trigger$1;
1874
+ /** actions that run in parallel after the trigger */
1875
+ rootActionIds?: string[];
1876
+ /**
1877
+ * map of all actions by actionId
1878
+ * The key is the actionId of the action, and the value is the action configuration
1879
+ */
1880
+ actions?: Record<string, Action$1>;
1881
+ }
1882
+ declare enum TimeUnit$1 {
1883
+ UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
1884
+ MINUTES = "MINUTES",
1885
+ HOURS = "HOURS",
1886
+ DAYS = "DAYS",
1887
+ WEEKS = "WEEKS",
1888
+ MONTHS = "MONTHS"
1889
+ }
1890
+ interface Filter$1 {
1891
+ /** the filter identifier */
1892
+ id?: string;
1893
+ /** the field key from the schema, for example "formId" */
1894
+ fieldKey?: string;
1895
+ /** filter expression that evaluates to a boolean, for example - {{ contains(["guid1","guid2"];formId) }} */
1896
+ filterExpression?: string;
1897
+ }
1898
+ interface FutureDateActivationOffset$1 {
1899
+ /**
1900
+ * expression of offset before the trigger's time (in selected time unit), when the Automation should run
1901
+ * only allows negative offset from the trigger's date (before the trigger), positive offset should be achieved via offset delay action
1902
+ * preScheduledEventOffsetExpression: "{{5}}" + timeUnit: Days - to run the Automation 5 days before the trigger's date
1903
+ * or, preScheduledEventOffsetExpression: "{{ someNumberField }}" + timeUnit: Minutes, to run the Automation someNumberField's value in minutes before the trigger's date
1904
+ */
1905
+ preScheduledEventOffsetExpression?: string;
1906
+ /** Time unit for the scheduled event offset */
1907
+ scheduledEventOffsetTimeUnit?: TimeUnit$1;
1908
+ }
1909
+ interface RateLimit$1 {
1910
+ /**
1911
+ * Maximum number of activations expression. the expression will need to be parsed to Int on runtime
1912
+ * for example - "{{ 1 }}" to set max activations to 1, or "{{ var(someNumberField) }}" to set max activations as the value of "someNumberField" from the payload
1913
+ */
1914
+ maxActivationsExpression?: string;
1915
+ /**
1916
+ * Duration of the rate limiting window (in selected time unit) expression for rate limiter, if empty then no time limit. the expression will need to be parsed to Int on runtime
1917
+ * for example - "{{ 10 }}" to set timeframe to be 10 minutes, or {{ var(someNumberField) }} to set timeframe in minutes as the value of "someNumberField" from the payload
1918
+ */
1919
+ durationExpression?: string | null;
1920
+ /** Time unit for the rate limit duration */
1921
+ durationTimeUnit?: TimeUnit$1;
1922
+ /**
1923
+ * Unique identifier of each activation by which rate limiter will count activations, expected return type is string
1924
+ * for example - {{ var(contact.id) }} to set the unique identifier as the value of "contact.id" from the payload
1925
+ */
1926
+ uniqueIdentifierExpression?: string | null;
1927
+ }
1928
+ interface ConditionExpressionGroup$1 {
1929
+ /** expression group operator */
1930
+ operator?: Operator$1;
1931
+ /**
1932
+ * list of boolean expressions to be evaluated with the given operator
1933
+ * examples - {{ true }}, {{ someBooleanField }}, {{ contains(["guid1...","guid2..."];formId) }}
1934
+ */
1935
+ booleanExpressions?: string[];
1936
+ }
1937
+ declare enum Operator$1 {
1938
+ UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
1939
+ OR = "OR",
1940
+ AND = "AND"
1941
+ }
1942
+ declare enum Type$1 {
1943
+ /** Automation will be triggered according to the trigger configuration */
1944
+ UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
1945
+ /** App defined Action */
1946
+ APP_DEFINED = "APP_DEFINED",
1947
+ /** Condition Action */
1948
+ CONDITION = "CONDITION",
1949
+ /** Delay Action */
1950
+ DELAY = "DELAY",
1951
+ /** RateLimit Action */
1952
+ RATE_LIMIT = "RATE_LIMIT",
1953
+ /** Output Action */
1954
+ OUTPUT = "OUTPUT"
1955
+ }
1956
+ interface AppDefinedAction$1 {
1957
+ /** Action app id */
1958
+ appId?: string;
1959
+ /** Action key */
1960
+ actionKey?: string;
1961
+ /**
1962
+ * Action input mapping, example:
1963
+ * {
1964
+ * "to": "{{ var(contact.email) }}",
1965
+ * "subject": "Your registration to {{ var(eventName) }} is Confirmed",
1966
+ * "body": "Hi {{ var(contact.name) }}, you are confirmed for the event"
1967
+ * }
1968
+ */
1969
+ inputMapping?: Record<string, any> | null;
1970
+ /**
1971
+ * optional skip condition configuration - if this action should be skipped when the automation runs (following actions of a skipped action will still run)
1972
+ * the action will be skipped if either of the expression groups evaluate to `true`
1973
+ * the relation between the expression groups is an OR relation.
1974
+ */
1975
+ skipConditionOrExpressionGroups?: ConditionExpressionGroup$1[];
1976
+ /** actions to run in parallel after this action finishes */
1977
+ postActionIds?: string[];
1978
+ }
1979
+ interface ConditionAction$1 {
1980
+ /**
1981
+ * the condition evaluates to `true` if either of the expression groups evaluate to `true`
1982
+ * the relation between the expression groups is an OR relation.
1983
+ */
1984
+ orExpressionGroups?: ConditionExpressionGroup$1[];
1985
+ /** actions to run when the entire condition is evaluated to `true` */
1986
+ truePostActionIds?: string[];
1987
+ /** actions to run when the entire condition is evaluated to `false` */
1988
+ falsePostActionIds?: string[];
1989
+ }
1990
+ interface DelayAction$1 {
1991
+ /**
1992
+ * optional - expression for amount of time to wait (in selected time unit) - from a specific date or from the time the action is executed
1993
+ * offsetExpression: "{{5}}" + timeUnit: Days - to wait for 5 days from the time the delay was invoked
1994
+ * or, offsetExpression: "{{5}}" + timeUnit: Days + dueDateEpochExpression: "{{someDateField}}" - to wait for 5 days from the time date in "someDateField" field in the payload
1995
+ * or, offsetExpression: "{{ someNumberField }}" + timeUnit: Minutes, to wait for someNumberField's value in minutes
1996
+ */
1997
+ offsetExpression?: string | null;
1998
+ /** Time unit for delay offset */
1999
+ offsetTimeUnit?: TimeUnit$1;
2000
+ /**
2001
+ * optional - expression of the due date to wait until, if an offset was defined, it will be calculated from this date
2002
+ * number of milliseconds since the Unix Epoch (1 January, 1970 UTC)
2003
+ * for example - "{{ 18238348023423 }}", or "{{ someEpochFromPayloadField }}" / "{{ contact.birthdate }}"
2004
+ */
2005
+ dueDateEpochExpression?: string | null;
2006
+ /** actions to run in parallel after this action finishes */
2007
+ postActionIds?: string[];
2008
+ }
2009
+ interface RateLimitAction$1 {
2010
+ /**
2011
+ * Maximum number of activations expression. the expression will need to be parsed to Int on runtime
2012
+ * for example - "{{ 1 }}" to set max activations to 1, or "{{ var(someNumberField) }}" to set max activations as the value of "someNumberField" from the payload
2013
+ */
2014
+ maxActivationsExpression?: string;
2015
+ /**
2016
+ * Duration of the rate limiting window (in selected time unit) expression for rate limiter, if empty then no time limit. the expression will need to be parsed to Int on runtime
2017
+ * for example - "{{ 10 }}" to set timeframe to be 10 minutes, or {{ var(someNumberField) }} to set timeframe in minutes as the value of "someNumberField" from the payload
2018
+ */
2019
+ rateLimitDurationExpression?: string | null;
2020
+ /** Time unit for the rate limit duration */
2021
+ rateLimitDurationTimeUnit?: TimeUnit$1;
2022
+ /**
2023
+ * Unique identifier of each activation by which rate limiter will count activations, expected return type is string
2024
+ * for example - {{ var(contact.id) }} to set the unique identifier as the value of "contact.id" from the payload
2025
+ */
2026
+ uniqueIdentifierExpression?: string | null;
2027
+ /** actions to run in parallel after this action finishes */
2028
+ postActionIds?: string[];
2029
+ }
2030
+ declare enum Status$1 {
2031
+ /** unused */
2032
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
2033
+ /** Automation will be triggered according to the trigger configuration */
2034
+ ACTIVE = "ACTIVE",
2035
+ /** Automation will not be triggered */
2036
+ INACTIVE = "INACTIVE"
2037
+ }
2038
+ interface Trigger$1 {
2039
+ /** Trigger Application id */
2040
+ appId?: string;
2041
+ /** Trigger key */
2042
+ triggerKey?: string;
2043
+ /**
2044
+ * optional - list of filters on schema fields
2045
+ * the relation between the filter expressions is an AND relation.
2046
+ * all filter expressions must be evaluated to `true` for a given payload in order for the automation to be executed
2047
+ */
2048
+ filters?: Filter$1[];
2049
+ /** optional - future date trigger activation offset */
2050
+ scheduledEventOffset?: FutureDateActivationOffset$1;
2051
+ /** optional - rate limiting configuration */
2052
+ rateLimit?: RateLimit$1;
2053
+ }
2054
+ interface Action$1 extends ActionInfoOneOf$1 {
2055
+ /** App defined Action (via RPC, HTTP or Velo) */
2056
+ appDefinedInfo?: AppDefinedAction$1;
2057
+ /** Condition action */
2058
+ conditionInfo?: ConditionAction$1;
2059
+ /** Delay action */
2060
+ delayInfo?: DelayAction$1;
2061
+ /** Rate limiting action */
2062
+ rateLimitInfo?: RateLimitAction$1;
2063
+ /** Action id, if not specified, will be generated */
2064
+ id?: string | null;
2065
+ /** Type of the action */
2066
+ type?: Type$1;
2067
+ /**
2068
+ * Human readable name for the action (may only contain alphanumeric characters and underscores) to differentiate from other actions of the same kind.
2069
+ * if the action has output, the output will be available in the payload under this name, otherwise it will be concatenated to the payload as is
2070
+ * without namespaces (or in case of exact same namespaces), if the user has multiple actions of the same kind (appId+actionKey), the output will be overwritten.
2071
+ *
2072
+ * for example, given:
2073
+ * - if the action output looks like this - { "message": "hello" }
2074
+ * - the namespace is "action_1"
2075
+ * - the trigger payload looks like this - { "someField": "50", "someBoolean": true }
2076
+ *
2077
+ * the payload will look like this:
2078
+ * {
2079
+ * "someField": "50",
2080
+ * "someBoolean": true,
2081
+ * "action_1": {
2082
+ * "message": "hello"
2083
+ * }
2084
+ * }
2085
+ *
2086
+ * given the following Automation configuration:
2087
+ *
2088
+ * (Trigger A)
2089
+ * |
2090
+ * (Action B) // namespace = "action_b_1"
2091
+ * |
2092
+ * (Action B) // namespace = "action_b_2"
2093
+ * |
2094
+ * (Action C)
2095
+ *
2096
+ *
2097
+ * the available fields that Action C will be able to use to map to it's input fields will be:
2098
+ * {
2099
+ * "someField": "50",
2100
+ * "someBoolean": true,
2101
+ * "action_b_1": {
2102
+ * "message": "hello"
2103
+ * },
2104
+ * "action_b_2": {
2105
+ * "message": "hello"
2106
+ * }
2107
+ * }
2108
+ * so the user can select which specific action output to use (action_b_1.message or action_b_2.message, in the case above)
2109
+ */
2110
+ namespace?: string | null;
2111
+ }
2112
+ /** @oneof */
2113
+ interface ActionInfoOneOf$1 {
2114
+ /** App defined Action (via RPC, HTTP or Velo) */
2115
+ appDefinedInfo?: AppDefinedAction$1;
2116
+ /** Condition action */
2117
+ conditionInfo?: ConditionAction$1;
2118
+ /** Delay action */
2119
+ delayInfo?: DelayAction$1;
2120
+ /** Rate limiting action */
2121
+ rateLimitInfo?: RateLimitAction$1;
2122
+ }
2123
+ declare enum Origin$1 {
2124
+ /** default value. this is unused */
2125
+ UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
2126
+ /** user created automation */
2127
+ USER = "USER",
2128
+ /** automation created by application (site specific) */
2129
+ APPLICATION = "APPLICATION",
2130
+ /** preinstalled application automation */
2131
+ PREINSTALLED = "PREINSTALLED"
2132
+ }
2133
+ interface ApplicationOrigin$1 {
2134
+ /** identifier for the application */
2135
+ appId?: string;
2136
+ }
2137
+ interface PreinstalledOrigin$1 {
2138
+ /** identifier for the application */
2139
+ appId?: string;
2140
+ /** application component ID */
2141
+ componentId?: string;
2142
+ /** application component Version */
2143
+ componentVersion?: number;
2144
+ /**
2145
+ * is this a user modified preinstalled automation (on a specific site) or the original one
2146
+ * @readonly
2147
+ */
2148
+ override?: boolean | null;
2149
+ }
2150
+ interface AutomationSettings$1 {
2151
+ /** sets if the automation is hidden from users */
2152
+ hidden?: boolean;
2153
+ /** sets if the automation is readonly */
2154
+ readonly?: boolean;
2155
+ /** sets if deleting the automation is disabled */
2156
+ disableDelete?: boolean;
2157
+ /** sets if changing the automation status is disabled (from active to inactive and vice versa) */
2158
+ disableStatusChange?: boolean;
2159
+ /** Automation's action settings */
2160
+ actionSettings?: ActionSettings$1;
2161
+ }
2162
+ interface CreateAutomationRequest$1 {
2163
+ /** Automation to be created. */
2164
+ automation: Automation$1;
2165
+ }
2166
+ interface CreateAutomationResponse$1 {
2167
+ /** The created Automation. */
2168
+ automation?: Automation$1;
2169
+ }
2170
+ interface GetAutomationRequest$1 {
2171
+ /** ID of the Automation to retrieve. */
2172
+ automationId: string;
2173
+ /** Automation Origin */
2174
+ origin?: Origin$1;
2175
+ }
2176
+ interface GetAutomationResponse$1 {
2177
+ /** The requested Automation. */
2178
+ automation?: Automation$1;
2179
+ }
2180
+ interface UpdateAutomationRequest$1 {
2181
+ /** Automation to be updated, may be partial. */
2182
+ automation: Automation$1;
2183
+ }
2184
+ interface UpdateAutomationResponse$1 {
2185
+ /** Updated Automation. */
2186
+ automation?: Automation$1;
2187
+ }
2188
+ interface DeleteAutomationRequest$1 {
2189
+ /** Id of the Automation to delete. */
2190
+ automationId: string;
2191
+ }
2192
+ interface DeleteAutomationResponse$1 {
2193
+ }
2194
+ interface QueryAutomationsRequest$1 {
2195
+ /** WQL expression. */
2196
+ query?: CursorQuery$1;
2197
+ }
2198
+ interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
2199
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2200
+ cursorPaging?: CursorPaging$1;
2201
+ /**
2202
+ * Filter object in the following format:
2203
+ * `"filter" : {
2204
+ * "fieldName1": "value1",
2205
+ * "fieldName2":{"$operator":"value2"}
2206
+ * }`
2207
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2208
+ */
2209
+ filter?: Record<string, any> | null;
2210
+ /**
2211
+ * Sort object in the following format:
2212
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2213
+ */
2214
+ sort?: Sorting$1[];
2215
+ }
2216
+ /** @oneof */
2217
+ interface CursorQueryPagingMethodOneOf$1 {
2218
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2219
+ cursorPaging?: CursorPaging$1;
2220
+ }
2221
+ interface Sorting$1 {
2222
+ /** Name of the field to sort by. */
2223
+ fieldName?: string;
2224
+ /** Sort order. */
2225
+ order?: SortOrder$1;
2226
+ }
2227
+ declare enum SortOrder$1 {
2228
+ ASC = "ASC",
2229
+ DESC = "DESC"
2230
+ }
2231
+ interface CursorPaging$1 {
2232
+ /** Maximum number of items to return in the results. */
2233
+ limit?: number | null;
2234
+ /**
2235
+ * Pointer to the next or previous page in the list of results.
2236
+ *
2237
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2238
+ * Not relevant for the first request.
2239
+ */
2240
+ cursor?: string | null;
2241
+ }
2242
+ interface QueryAutomationsResponse$1 {
2243
+ /** List of Automations. */
2244
+ automations?: Automation$1[];
2245
+ /** Paging metadata */
2246
+ pagingMetadata?: CursorPagingMetadata$1;
2247
+ }
2248
+ interface CursorPagingMetadata$1 {
2249
+ /** Number of items returned in the response. */
2250
+ count?: number | null;
2251
+ /** Cursor strings that point to the next page, previous page, or both. */
2252
+ cursors?: Cursors$1;
2253
+ /**
2254
+ * Whether there are more pages to retrieve following the current page.
2255
+ *
2256
+ * + `true`: Another page of results can be retrieved.
2257
+ * + `false`: This is the last page.
2258
+ */
2259
+ hasNext?: boolean | null;
2260
+ }
2261
+ interface Cursors$1 {
2262
+ /** Cursor string pointing to the next page in the list of results. */
2263
+ next?: string | null;
2264
+ /** Cursor pointing to the previous page in the list of results. */
2265
+ prev?: string | null;
2266
+ }
2267
+ interface ValidateAutomationRequest$1 {
2268
+ /** Automation to validate */
2269
+ automation: Automation$1;
2270
+ /** optional validation settings */
2271
+ validationSettings?: ValidationSettings$1;
2272
+ }
2273
+ interface ValidationSettings$1 {
2274
+ /**
2275
+ * specific actions to include in the validation
2276
+ * if non empty - only the specific actions would be validated (trigger excluded)
2277
+ * if empty, the entire automation will be validated (trigger included)
2278
+ */
2279
+ actionIds?: string[];
2280
+ /** whether or not to skip provider validations (default: false) */
2281
+ skipProviderValidations?: boolean;
2282
+ }
2283
+ interface ValidateAutomationResponse$1 {
2284
+ /** is the Automation valid */
2285
+ valid?: boolean;
2286
+ /** list of validation errors for the automation Trigger */
2287
+ triggerValidationErrors?: TriggerValidationError$1[];
2288
+ /** list of validation information for the automation Actions */
2289
+ actionValidationInfo?: ActionValidationInfo$1[];
2290
+ }
2291
+ interface TriggerValidationError$1 extends TriggerValidationErrorErrorOneOf$1 {
2292
+ /** trigger configuration error */
2293
+ configurationError?: TriggerConfigurationError$1;
2294
+ /** provider configuration error */
2295
+ providerConfigurationError?: ProviderConfigurationError$1;
2296
+ /** validation error type */
2297
+ errorType?: TriggerValidationErrorValidationErrorType$1;
2298
+ }
2299
+ /** @oneof */
2300
+ interface TriggerValidationErrorErrorOneOf$1 {
2301
+ /** trigger configuration error */
2302
+ configurationError?: TriggerConfigurationError$1;
2303
+ /** provider configuration error */
2304
+ providerConfigurationError?: ProviderConfigurationError$1;
2305
+ }
2306
+ declare enum TriggerValidationErrorValidationErrorType$1 {
2307
+ UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
2308
+ CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
2309
+ PROVIDER_ERROR = "PROVIDER_ERROR"
2310
+ }
2311
+ interface TriggerConfigurationError$1 {
2312
+ /** trigger error type */
2313
+ errorType?: TriggerErrorType$1;
2314
+ /** optional - related filter field key */
2315
+ filterFieldKey?: string | null;
2316
+ }
2317
+ declare enum TriggerErrorType$1 {
2318
+ UNKNOWN_TRIGGER_ERROR_TYPE = "UNKNOWN_TRIGGER_ERROR_TYPE",
2319
+ NOT_FOUND = "NOT_FOUND",
2320
+ APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
2321
+ MODERATION_MISMATCH = "MODERATION_MISMATCH",
2322
+ DEPRECATED = "DEPRECATED",
2323
+ INVALID_TRIGGER_KEY = "INVALID_TRIGGER_KEY",
2324
+ INVALID_FILTER_FIELD_KEY = "INVALID_FILTER_FIELD_KEY",
2325
+ INVALID_FILTER_EXPRESSION = "INVALID_FILTER_EXPRESSION"
2326
+ }
2327
+ interface ProviderConfigurationError$1 {
2328
+ /** Key corresponding to the field in the schema. */
2329
+ fieldKey?: string | null;
2330
+ /** Error message. */
2331
+ message?: string;
2332
+ /** Label for a call-to-action button that's displayed with the error. Translated according to the SPI language context. */
2333
+ ctaLabel?: string | null;
2334
+ /** URL to redirect to when the call-to-action button is clicked. */
2335
+ ctaUrl?: string | null;
2336
+ /** Title for the error. */
2337
+ title?: string;
2338
+ }
2339
+ interface ActionValidationInfo$1 {
2340
+ /** the id of the action in the automation */
2341
+ actionId?: string | null;
2342
+ /** the id of the app defining the action */
2343
+ appId?: string;
2344
+ /** human readable identifier of the action per app */
2345
+ actionKey?: string;
2346
+ /** list of action validation errors */
2347
+ validationErrors?: ActionValidationError$1[];
2348
+ }
2349
+ interface ActionValidationError$1 extends ActionValidationErrorErrorOneOf$1 {
2350
+ /** action configuration error */
2351
+ configurationError?: ActionConfigurationError$1;
2352
+ /** provider configuration error */
2353
+ providerConfigurationError?: ProviderConfigurationError$1;
2354
+ /** validation error type */
2355
+ errorType?: ValidationErrorType$1;
2356
+ }
2357
+ /** @oneof */
2358
+ interface ActionValidationErrorErrorOneOf$1 {
2359
+ /** action configuration error */
2360
+ configurationError?: ActionConfigurationError$1;
2361
+ /** provider configuration error */
2362
+ providerConfigurationError?: ProviderConfigurationError$1;
2363
+ }
2364
+ declare enum ValidationErrorType$1 {
2365
+ UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
2366
+ CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
2367
+ PROVIDER_ERROR = "PROVIDER_ERROR"
2368
+ }
2369
+ interface ActionConfigurationError$1 {
2370
+ /** action error type */
2371
+ errorType?: ActionErrorType$1;
2372
+ /** optional - related field key */
2373
+ fieldKey?: string | null;
2374
+ }
2375
+ declare enum ActionErrorType$1 {
2376
+ UNKNOWN_ACTION_ERROR_TYPE = "UNKNOWN_ACTION_ERROR_TYPE",
2377
+ NOT_FOUND = "NOT_FOUND",
2378
+ APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
2379
+ MODERATION_MISMATCH = "MODERATION_MISMATCH",
2380
+ DEPRECATED = "DEPRECATED",
2381
+ INVALID_ACTION_KEY = "INVALID_ACTION_KEY",
2382
+ INVALID_MAPPING = "INVALID_MAPPING",
2383
+ MAPPING_TYPE_MISMATCH = "MAPPING_TYPE_MISMATCH",
2384
+ MAPPING_MISSING_REQUIRED_FIELD = "MAPPING_MISSING_REQUIRED_FIELD",
2385
+ MAPPING_SCHEMA_MISMATCH = "MAPPING_SCHEMA_MISMATCH",
2386
+ MAPPING_VARIABLE_MISSING_FROM_SCHEMA = "MAPPING_VARIABLE_MISSING_FROM_SCHEMA"
2387
+ }
2388
+ interface ApplicationOriginNonNullableFields$1 {
2389
+ appId: string;
2390
+ }
2391
+ interface PreinstalledOriginNonNullableFields$1 {
2392
+ appId: string;
2393
+ componentId: string;
2394
+ componentVersion: number;
2395
+ }
2396
+ interface AuditInfoNonNullableFields$1 {
2397
+ userId: string;
2398
+ appId: string;
2399
+ }
2400
+ interface FilterNonNullableFields$1 {
2401
+ id: string;
2402
+ fieldKey: string;
2403
+ filterExpression: string;
2404
+ }
2405
+ interface FutureDateActivationOffsetNonNullableFields$1 {
2406
+ preScheduledEventOffsetExpression: string;
2407
+ scheduledEventOffsetTimeUnit: TimeUnit$1;
2408
+ }
2409
+ interface RateLimitNonNullableFields$1 {
2410
+ maxActivationsExpression: string;
2411
+ durationTimeUnit: TimeUnit$1;
2412
+ }
2413
+ interface TriggerNonNullableFields$1 {
2414
+ appId: string;
2415
+ triggerKey: string;
2416
+ filters: FilterNonNullableFields$1[];
2417
+ scheduledEventOffset?: FutureDateActivationOffsetNonNullableFields$1;
2418
+ rateLimit?: RateLimitNonNullableFields$1;
2419
+ }
2420
+ interface AutomationConfigurationNonNullableFields$1 {
2421
+ status: Status$1;
2422
+ trigger?: TriggerNonNullableFields$1;
2423
+ rootActionIds: string[];
2424
+ }
2425
+ interface ActionSettingsNonNullableFields$1 {
2426
+ permanentActionIds: string[];
2427
+ readonlyActionIds: string[];
2428
+ disableDelayAddition: boolean;
2429
+ disableConditionAddition: boolean;
2430
+ }
2431
+ interface AutomationSettingsNonNullableFields$1 {
2432
+ hidden: boolean;
2433
+ readonly: boolean;
2434
+ disableDelete: boolean;
2435
+ disableStatusChange: boolean;
2436
+ actionSettings?: ActionSettingsNonNullableFields$1;
2437
+ }
2438
+ interface AutomationNonNullableFields$1 {
2439
+ applicationInfo?: ApplicationOriginNonNullableFields$1;
2440
+ preinstalledInfo?: PreinstalledOriginNonNullableFields$1;
2441
+ createdBy?: AuditInfoNonNullableFields$1;
2442
+ updatedBy?: AuditInfoNonNullableFields$1;
2443
+ name: string;
2444
+ configuration?: AutomationConfigurationNonNullableFields$1;
2445
+ origin: Origin$1;
2446
+ settings?: AutomationSettingsNonNullableFields$1;
2447
+ }
2448
+ interface CreateAutomationResponseNonNullableFields$1 {
2449
+ automation?: AutomationNonNullableFields$1;
2450
+ }
2451
+ interface GetAutomationResponseNonNullableFields$1 {
2452
+ automation?: AutomationNonNullableFields$1;
2453
+ }
2454
+ interface UpdateAutomationResponseNonNullableFields$1 {
2455
+ automation?: AutomationNonNullableFields$1;
2456
+ }
2457
+ interface QueryAutomationsResponseNonNullableFields$1 {
2458
+ automations: AutomationNonNullableFields$1[];
2459
+ }
2460
+ interface TriggerConfigurationErrorNonNullableFields$1 {
2461
+ errorType: TriggerErrorType$1;
2462
+ }
2463
+ interface ProviderConfigurationErrorNonNullableFields$1 {
2464
+ message: string;
2465
+ title: string;
2466
+ }
2467
+ interface TriggerValidationErrorNonNullableFields$1 {
2468
+ configurationError?: TriggerConfigurationErrorNonNullableFields$1;
2469
+ providerConfigurationError?: ProviderConfigurationErrorNonNullableFields$1;
2470
+ errorType: TriggerValidationErrorValidationErrorType$1;
2471
+ }
2472
+ interface ActionConfigurationErrorNonNullableFields$1 {
2473
+ errorType: ActionErrorType$1;
2474
+ }
2475
+ interface ActionValidationErrorNonNullableFields$1 {
2476
+ configurationError?: ActionConfigurationErrorNonNullableFields$1;
2477
+ providerConfigurationError?: ProviderConfigurationErrorNonNullableFields$1;
2478
+ errorType: ValidationErrorType$1;
2479
+ }
2480
+ interface ActionValidationInfoNonNullableFields$1 {
2481
+ appId: string;
2482
+ actionKey: string;
2483
+ validationErrors: ActionValidationErrorNonNullableFields$1[];
2484
+ }
2485
+ interface ValidateAutomationResponseNonNullableFields$1 {
2486
+ valid: boolean;
2487
+ triggerValidationErrors: TriggerValidationErrorNonNullableFields$1[];
2488
+ actionValidationInfo: ActionValidationInfoNonNullableFields$1[];
2489
+ }
2490
+
2491
+ /** Automation */
2492
+ interface Automation extends AutomationOriginInfoOneOf {
2493
+ /** Application info */
2494
+ applicationInfo?: ApplicationOrigin;
2495
+ /** Preinstalled info */
2496
+ preinstalledInfo?: PreinstalledOrigin;
2497
+ /**
2498
+ * Automation ID.
2499
+ * @readonly
2500
+ */
2501
+ _id?: string | null;
2502
+ /**
2503
+ * Revision number, which increments by 1 each time the Automation is updated.
2504
+ * To prevent conflicting changes,
2505
+ * the current revision must be passed when updating the Automation.
2506
+ *
2507
+ * Ignored when creating an Automation.
2508
+ * @readonly
2509
+ */
2510
+ revision?: string | null;
2511
+ /**
2512
+ * information about the creator of the automation
2513
+ * @readonly
2514
+ */
2515
+ createdBy?: AuditInfo;
2516
+ /**
2517
+ * Date and time the Automation was created.
2518
+ * @readonly
2519
+ */
2520
+ _createdDate?: Date;
2521
+ /**
2522
+ * information about who updated of the automation
2523
+ * @readonly
2524
+ */
2525
+ updatedBy?: AuditInfo;
2526
+ /**
2527
+ * Date and time the Automation was last updated.
2528
+ * @readonly
2529
+ */
2530
+ _updatedDate?: Date;
2531
+ /** Automation name */
2532
+ name?: string;
2533
+ /** Automation description */
2534
+ description?: string | null;
2535
+ /** Automation runtime configuration */
2536
+ configuration?: AutomationConfiguration;
2537
+ /** Origin type */
2538
+ origin?: Origin;
2539
+ /** Automation settings */
2540
+ settings?: AutomationSettings;
2541
+ }
2542
+ /** @oneof */
2543
+ interface AutomationOriginInfoOneOf {
2544
+ /** Application info */
2545
+ applicationInfo?: ApplicationOrigin;
2546
+ /** Preinstalled info */
2547
+ preinstalledInfo?: PreinstalledOrigin;
2548
+ }
2549
+ interface ActionSettings {
2550
+ /** list of permanent action ids of actions that cannot be deleted (default - empty, all actions are deletable by default) */
2551
+ permanentActionIds?: string[];
2552
+ /** list of readonly action ids, (default - empty, all actions are editable by default) */
2553
+ readonlyActionIds?: string[];
2554
+ /** sets if adding a delay action is disabled for this automation */
2555
+ disableDelayAddition?: boolean;
2556
+ /** sets if adding a condition action is disabled for this automation */
2557
+ disableConditionAddition?: boolean;
2558
+ }
2559
+ interface AuditInfo extends AuditInfoIdOneOf {
2560
+ /** user identifier */
2561
+ userId?: string;
2562
+ /** application identifier */
2563
+ appId?: string;
2564
+ }
2565
+ /** @oneof */
2566
+ interface AuditInfoIdOneOf {
2567
+ /** user identifier */
2568
+ userId?: string;
2569
+ /** application identifier */
2570
+ appId?: string;
2571
+ }
2572
+ /** Automation runtime configuration */
2573
+ interface AutomationConfiguration {
2574
+ /** Automation's Status */
2575
+ status?: Status;
2576
+ /** Trigger configuration */
2577
+ trigger?: Trigger;
2578
+ /** actions that run in parallel after the trigger */
2579
+ rootActionIds?: string[];
2580
+ /**
2581
+ * map of all actions by actionId
2582
+ * The key is the actionId of the action, and the value is the action configuration
2583
+ */
2584
+ actions?: Record<string, Action>;
2585
+ }
2586
+ declare enum TimeUnit {
2587
+ UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
2588
+ MINUTES = "MINUTES",
2589
+ HOURS = "HOURS",
2590
+ DAYS = "DAYS",
2591
+ WEEKS = "WEEKS",
2592
+ MONTHS = "MONTHS"
2593
+ }
2594
+ interface Filter {
2595
+ /** the filter identifier */
2596
+ _id?: string;
2597
+ /** the field key from the schema, for example "formId" */
2598
+ fieldKey?: string;
2599
+ /** filter expression that evaluates to a boolean, for example - {{ contains(["guid1","guid2"];formId) }} */
2600
+ filterExpression?: string;
2601
+ }
2602
+ interface FutureDateActivationOffset {
2603
+ /**
2604
+ * expression of offset before the trigger's time (in selected time unit), when the Automation should run
2605
+ * only allows negative offset from the trigger's date (before the trigger), positive offset should be achieved via offset delay action
2606
+ * preScheduledEventOffsetExpression: "{{5}}" + timeUnit: Days - to run the Automation 5 days before the trigger's date
2607
+ * or, preScheduledEventOffsetExpression: "{{ someNumberField }}" + timeUnit: Minutes, to run the Automation someNumberField's value in minutes before the trigger's date
2608
+ */
2609
+ preScheduledEventOffsetExpression?: string;
2610
+ /** Time unit for the scheduled event offset */
2611
+ scheduledEventOffsetTimeUnit?: TimeUnit;
2612
+ }
2613
+ interface RateLimit {
2614
+ /**
2615
+ * Maximum number of activations expression. the expression will need to be parsed to Int on runtime
2616
+ * for example - "{{ 1 }}" to set max activations to 1, or "{{ var(someNumberField) }}" to set max activations as the value of "someNumberField" from the payload
2617
+ */
2618
+ maxActivationsExpression?: string;
2619
+ /**
2620
+ * Duration of the rate limiting window (in selected time unit) expression for rate limiter, if empty then no time limit. the expression will need to be parsed to Int on runtime
2621
+ * for example - "{{ 10 }}" to set timeframe to be 10 minutes, or {{ var(someNumberField) }} to set timeframe in minutes as the value of "someNumberField" from the payload
2622
+ */
2623
+ durationExpression?: string | null;
2624
+ /** Time unit for the rate limit duration */
2625
+ durationTimeUnit?: TimeUnit;
2626
+ /**
2627
+ * Unique identifier of each activation by which rate limiter will count activations, expected return type is string
2628
+ * for example - {{ var(contact.id) }} to set the unique identifier as the value of "contact.id" from the payload
2629
+ */
2630
+ uniqueIdentifierExpression?: string | null;
2631
+ }
2632
+ interface ConditionExpressionGroup {
2633
+ /** expression group operator */
2634
+ operator?: Operator;
2635
+ /**
2636
+ * list of boolean expressions to be evaluated with the given operator
2637
+ * examples - {{ true }}, {{ someBooleanField }}, {{ contains(["guid1...","guid2..."];formId) }}
2638
+ */
2639
+ booleanExpressions?: string[];
2640
+ }
2641
+ declare enum Operator {
2642
+ UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
2643
+ OR = "OR",
2644
+ AND = "AND"
2645
+ }
2646
+ declare enum Type {
2647
+ /** Automation will be triggered according to the trigger configuration */
2648
+ UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
2649
+ /** App defined Action */
2650
+ APP_DEFINED = "APP_DEFINED",
2651
+ /** Condition Action */
2652
+ CONDITION = "CONDITION",
2653
+ /** Delay Action */
2654
+ DELAY = "DELAY",
2655
+ /** RateLimit Action */
2656
+ RATE_LIMIT = "RATE_LIMIT",
2657
+ /** Output Action */
2658
+ OUTPUT = "OUTPUT"
2659
+ }
2660
+ interface AppDefinedAction {
2661
+ /** Action app id */
2662
+ appId?: string;
2663
+ /** Action key */
2664
+ actionKey?: string;
2665
+ /**
2666
+ * Action input mapping, example:
2667
+ * {
2668
+ * "to": "{{ var(contact.email) }}",
2669
+ * "subject": "Your registration to {{ var(eventName) }} is Confirmed",
2670
+ * "body": "Hi {{ var(contact.name) }}, you are confirmed for the event"
2671
+ * }
2672
+ */
2673
+ inputMapping?: Record<string, any> | null;
2674
+ /**
2675
+ * optional skip condition configuration - if this action should be skipped when the automation runs (following actions of a skipped action will still run)
2676
+ * the action will be skipped if either of the expression groups evaluate to `true`
2677
+ * the relation between the expression groups is an OR relation.
2678
+ */
2679
+ skipConditionOrExpressionGroups?: ConditionExpressionGroup[];
2680
+ /** actions to run in parallel after this action finishes */
2681
+ postActionIds?: string[];
2682
+ }
2683
+ interface ConditionAction {
2684
+ /**
2685
+ * the condition evaluates to `true` if either of the expression groups evaluate to `true`
2686
+ * the relation between the expression groups is an OR relation.
2687
+ */
2688
+ orExpressionGroups?: ConditionExpressionGroup[];
2689
+ /** actions to run when the entire condition is evaluated to `true` */
2690
+ truePostActionIds?: string[];
2691
+ /** actions to run when the entire condition is evaluated to `false` */
2692
+ falsePostActionIds?: string[];
2693
+ }
2694
+ interface DelayAction {
2695
+ /**
2696
+ * optional - expression for amount of time to wait (in selected time unit) - from a specific date or from the time the action is executed
2697
+ * offsetExpression: "{{5}}" + timeUnit: Days - to wait for 5 days from the time the delay was invoked
2698
+ * or, offsetExpression: "{{5}}" + timeUnit: Days + dueDateEpochExpression: "{{someDateField}}" - to wait for 5 days from the time date in "someDateField" field in the payload
2699
+ * or, offsetExpression: "{{ someNumberField }}" + timeUnit: Minutes, to wait for someNumberField's value in minutes
2700
+ */
2701
+ offsetExpression?: string | null;
2702
+ /** Time unit for delay offset */
2703
+ offsetTimeUnit?: TimeUnit;
2704
+ /**
2705
+ * optional - expression of the due date to wait until, if an offset was defined, it will be calculated from this date
2706
+ * number of milliseconds since the Unix Epoch (1 January, 1970 UTC)
2707
+ * for example - "{{ 18238348023423 }}", or "{{ someEpochFromPayloadField }}" / "{{ contact.birthdate }}"
2708
+ */
2709
+ dueDateEpochExpression?: string | null;
2710
+ /** actions to run in parallel after this action finishes */
2711
+ postActionIds?: string[];
2712
+ }
2713
+ interface RateLimitAction {
2714
+ /**
2715
+ * Maximum number of activations expression. the expression will need to be parsed to Int on runtime
2716
+ * for example - "{{ 1 }}" to set max activations to 1, or "{{ var(someNumberField) }}" to set max activations as the value of "someNumberField" from the payload
2717
+ */
2718
+ maxActivationsExpression?: string;
2719
+ /**
2720
+ * Duration of the rate limiting window (in selected time unit) expression for rate limiter, if empty then no time limit. the expression will need to be parsed to Int on runtime
2721
+ * for example - "{{ 10 }}" to set timeframe to be 10 minutes, or {{ var(someNumberField) }} to set timeframe in minutes as the value of "someNumberField" from the payload
2722
+ */
2723
+ rateLimitDurationExpression?: string | null;
2724
+ /** Time unit for the rate limit duration */
2725
+ rateLimitDurationTimeUnit?: TimeUnit;
2726
+ /**
2727
+ * Unique identifier of each activation by which rate limiter will count activations, expected return type is string
2728
+ * for example - {{ var(contact.id) }} to set the unique identifier as the value of "contact.id" from the payload
2729
+ */
2730
+ uniqueIdentifierExpression?: string | null;
2731
+ /** actions to run in parallel after this action finishes */
2732
+ postActionIds?: string[];
2733
+ }
2734
+ declare enum Status {
2735
+ /** unused */
2736
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
2737
+ /** Automation will be triggered according to the trigger configuration */
2738
+ ACTIVE = "ACTIVE",
2739
+ /** Automation will not be triggered */
2740
+ INACTIVE = "INACTIVE"
2741
+ }
2742
+ interface Trigger {
2743
+ /** Trigger Application id */
2744
+ appId?: string;
2745
+ /** Trigger key */
2746
+ triggerKey?: string;
2747
+ /**
2748
+ * optional - list of filters on schema fields
2749
+ * the relation between the filter expressions is an AND relation.
2750
+ * all filter expressions must be evaluated to `true` for a given payload in order for the automation to be executed
2751
+ */
2752
+ filters?: Filter[];
2753
+ /** optional - future date trigger activation offset */
2754
+ scheduledEventOffset?: FutureDateActivationOffset;
2755
+ /** optional - rate limiting configuration */
2756
+ rateLimit?: RateLimit;
2757
+ }
2758
+ interface Action extends ActionInfoOneOf {
2759
+ /** App defined Action (via RPC, HTTP or Velo) */
2760
+ appDefinedInfo?: AppDefinedAction;
2761
+ /** Condition action */
2762
+ conditionInfo?: ConditionAction;
2763
+ /** Delay action */
2764
+ delayInfo?: DelayAction;
2765
+ /** Rate limiting action */
2766
+ rateLimitInfo?: RateLimitAction;
2767
+ /** Action id, if not specified, will be generated */
2768
+ _id?: string | null;
2769
+ /** Type of the action */
2770
+ type?: Type;
2771
+ /**
2772
+ * Human readable name for the action (may only contain alphanumeric characters and underscores) to differentiate from other actions of the same kind.
2773
+ * if the action has output, the output will be available in the payload under this name, otherwise it will be concatenated to the payload as is
2774
+ * without namespaces (or in case of exact same namespaces), if the user has multiple actions of the same kind (appId+actionKey), the output will be overwritten.
2775
+ *
2776
+ * for example, given:
2777
+ * - if the action output looks like this - { "message": "hello" }
2778
+ * - the namespace is "action_1"
2779
+ * - the trigger payload looks like this - { "someField": "50", "someBoolean": true }
2780
+ *
2781
+ * the payload will look like this:
2782
+ * {
2783
+ * "someField": "50",
2784
+ * "someBoolean": true,
2785
+ * "action_1": {
2786
+ * "message": "hello"
2787
+ * }
2788
+ * }
2789
+ *
2790
+ * given the following Automation configuration:
2791
+ *
2792
+ * (Trigger A)
2793
+ * |
2794
+ * (Action B) // namespace = "action_b_1"
2795
+ * |
2796
+ * (Action B) // namespace = "action_b_2"
2797
+ * |
2798
+ * (Action C)
2799
+ *
2800
+ *
2801
+ * the available fields that Action C will be able to use to map to it's input fields will be:
2802
+ * {
2803
+ * "someField": "50",
2804
+ * "someBoolean": true,
2805
+ * "action_b_1": {
2806
+ * "message": "hello"
2807
+ * },
2808
+ * "action_b_2": {
2809
+ * "message": "hello"
2810
+ * }
2811
+ * }
2812
+ * so the user can select which specific action output to use (action_b_1.message or action_b_2.message, in the case above)
2813
+ */
2814
+ namespace?: string | null;
2815
+ }
2816
+ /** @oneof */
2817
+ interface ActionInfoOneOf {
2818
+ /** App defined Action (via RPC, HTTP or Velo) */
2819
+ appDefinedInfo?: AppDefinedAction;
2820
+ /** Condition action */
2821
+ conditionInfo?: ConditionAction;
2822
+ /** Delay action */
2823
+ delayInfo?: DelayAction;
2824
+ /** Rate limiting action */
2825
+ rateLimitInfo?: RateLimitAction;
2826
+ }
2827
+ declare enum Origin {
2828
+ /** default value. this is unused */
2829
+ UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
2830
+ /** user created automation */
2831
+ USER = "USER",
2832
+ /** automation created by application (site specific) */
2833
+ APPLICATION = "APPLICATION",
2834
+ /** preinstalled application automation */
2835
+ PREINSTALLED = "PREINSTALLED"
2836
+ }
2837
+ interface ApplicationOrigin {
2838
+ /** identifier for the application */
2839
+ appId?: string;
2840
+ }
2841
+ interface PreinstalledOrigin {
2842
+ /** identifier for the application */
2843
+ appId?: string;
2844
+ /** application component ID */
2845
+ componentId?: string;
2846
+ /** application component Version */
2847
+ componentVersion?: number;
2848
+ /**
2849
+ * is this a user modified preinstalled automation (on a specific site) or the original one
2850
+ * @readonly
2851
+ */
2852
+ override?: boolean | null;
2853
+ }
2854
+ interface AutomationSettings {
2855
+ /** sets if the automation is hidden from users */
2856
+ hidden?: boolean;
2857
+ /** sets if the automation is readonly */
2858
+ readonly?: boolean;
2859
+ /** sets if deleting the automation is disabled */
2860
+ disableDelete?: boolean;
2861
+ /** sets if changing the automation status is disabled (from active to inactive and vice versa) */
2862
+ disableStatusChange?: boolean;
2863
+ /** Automation's action settings */
2864
+ actionSettings?: ActionSettings;
2865
+ }
2866
+ interface CreateAutomationRequest {
2867
+ /** Automation to be created. */
2868
+ automation: Automation;
2869
+ }
2870
+ interface CreateAutomationResponse {
2871
+ /** The created Automation. */
2872
+ automation?: Automation;
2873
+ }
2874
+ interface GetAutomationRequest {
2875
+ /** ID of the Automation to retrieve. */
2876
+ automationId: string;
2877
+ /** Automation Origin */
2878
+ origin?: Origin;
2879
+ }
2880
+ interface GetAutomationResponse {
2881
+ /** The requested Automation. */
2882
+ automation?: Automation;
2883
+ }
2884
+ interface UpdateAutomationRequest {
2885
+ /** Automation to be updated, may be partial. */
2886
+ automation: Automation;
2887
+ }
2888
+ interface UpdateAutomationResponse {
2889
+ /** Updated Automation. */
2890
+ automation?: Automation;
2891
+ }
2892
+ interface DeleteAutomationRequest {
2893
+ /** Id of the Automation to delete. */
2894
+ automationId: string;
2895
+ }
2896
+ interface DeleteAutomationResponse {
2897
+ }
2898
+ interface QueryAutomationsRequest {
2899
+ /** WQL expression. */
2900
+ query?: CursorQuery;
2901
+ }
2902
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
2903
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2904
+ cursorPaging?: CursorPaging;
2905
+ /**
2906
+ * Filter object in the following format:
2907
+ * `"filter" : {
2908
+ * "fieldName1": "value1",
2909
+ * "fieldName2":{"$operator":"value2"}
2910
+ * }`
2911
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2912
+ */
2913
+ filter?: Record<string, any> | null;
2914
+ /**
2915
+ * Sort object in the following format:
2916
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2917
+ */
2918
+ sort?: Sorting[];
2919
+ }
2920
+ /** @oneof */
2921
+ interface CursorQueryPagingMethodOneOf {
2922
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2923
+ cursorPaging?: CursorPaging;
2924
+ }
2925
+ interface Sorting {
2926
+ /** Name of the field to sort by. */
2927
+ fieldName?: string;
2928
+ /** Sort order. */
2929
+ order?: SortOrder;
2930
+ }
2931
+ declare enum SortOrder {
2932
+ ASC = "ASC",
2933
+ DESC = "DESC"
2934
+ }
2935
+ interface CursorPaging {
2936
+ /** Maximum number of items to return in the results. */
2937
+ limit?: number | null;
2938
+ /**
2939
+ * Pointer to the next or previous page in the list of results.
2940
+ *
2941
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
2942
+ * Not relevant for the first request.
2943
+ */
2944
+ cursor?: string | null;
2945
+ }
2946
+ interface QueryAutomationsResponse {
2947
+ /** List of Automations. */
2948
+ automations?: Automation[];
2949
+ /** Paging metadata */
2950
+ pagingMetadata?: CursorPagingMetadata;
2951
+ }
2952
+ interface CursorPagingMetadata {
2953
+ /** Number of items returned in the response. */
2954
+ count?: number | null;
2955
+ /** Cursor strings that point to the next page, previous page, or both. */
2956
+ cursors?: Cursors;
2957
+ /**
2958
+ * Whether there are more pages to retrieve following the current page.
2959
+ *
2960
+ * + `true`: Another page of results can be retrieved.
2961
+ * + `false`: This is the last page.
2962
+ */
2963
+ hasNext?: boolean | null;
2964
+ }
2965
+ interface Cursors {
2966
+ /** Cursor string pointing to the next page in the list of results. */
2967
+ next?: string | null;
2968
+ /** Cursor pointing to the previous page in the list of results. */
2969
+ prev?: string | null;
2970
+ }
2971
+ interface ValidateAutomationRequest {
2972
+ /** Automation to validate */
2973
+ automation: Automation;
2974
+ /** optional validation settings */
2975
+ validationSettings?: ValidationSettings;
2976
+ }
2977
+ interface ValidationSettings {
2978
+ /**
2979
+ * specific actions to include in the validation
2980
+ * if non empty - only the specific actions would be validated (trigger excluded)
2981
+ * if empty, the entire automation will be validated (trigger included)
2982
+ */
2983
+ actionIds?: string[];
2984
+ /** whether or not to skip provider validations (default: false) */
2985
+ skipProviderValidations?: boolean;
2986
+ }
2987
+ interface ValidateAutomationResponse {
2988
+ /** is the Automation valid */
2989
+ valid?: boolean;
2990
+ /** list of validation errors for the automation Trigger */
2991
+ triggerValidationErrors?: TriggerValidationError[];
2992
+ /** list of validation information for the automation Actions */
2993
+ actionValidationInfo?: ActionValidationInfo[];
2994
+ }
2995
+ interface TriggerValidationError extends TriggerValidationErrorErrorOneOf {
2996
+ /** trigger configuration error */
2997
+ configurationError?: TriggerConfigurationError;
2998
+ /** provider configuration error */
2999
+ providerConfigurationError?: ProviderConfigurationError;
3000
+ /** validation error type */
3001
+ errorType?: TriggerValidationErrorValidationErrorType;
3002
+ }
3003
+ /** @oneof */
3004
+ interface TriggerValidationErrorErrorOneOf {
3005
+ /** trigger configuration error */
3006
+ configurationError?: TriggerConfigurationError;
3007
+ /** provider configuration error */
3008
+ providerConfigurationError?: ProviderConfigurationError;
3009
+ }
3010
+ declare enum TriggerValidationErrorValidationErrorType {
3011
+ UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
3012
+ CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
3013
+ PROVIDER_ERROR = "PROVIDER_ERROR"
3014
+ }
3015
+ interface TriggerConfigurationError {
3016
+ /** trigger error type */
3017
+ errorType?: TriggerErrorType;
3018
+ /** optional - related filter field key */
3019
+ filterFieldKey?: string | null;
3020
+ }
3021
+ declare enum TriggerErrorType {
3022
+ UNKNOWN_TRIGGER_ERROR_TYPE = "UNKNOWN_TRIGGER_ERROR_TYPE",
3023
+ NOT_FOUND = "NOT_FOUND",
3024
+ APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
3025
+ MODERATION_MISMATCH = "MODERATION_MISMATCH",
3026
+ DEPRECATED = "DEPRECATED",
3027
+ INVALID_TRIGGER_KEY = "INVALID_TRIGGER_KEY",
3028
+ INVALID_FILTER_FIELD_KEY = "INVALID_FILTER_FIELD_KEY",
3029
+ INVALID_FILTER_EXPRESSION = "INVALID_FILTER_EXPRESSION"
3030
+ }
3031
+ interface ProviderConfigurationError {
3032
+ /** Key corresponding to the field in the schema. */
3033
+ fieldKey?: string | null;
3034
+ /** Error message. */
3035
+ message?: string;
3036
+ /** Label for a call-to-action button that's displayed with the error. Translated according to the SPI language context. */
3037
+ ctaLabel?: string | null;
3038
+ /** URL to redirect to when the call-to-action button is clicked. */
3039
+ ctaUrl?: string | null;
3040
+ /** Title for the error. */
3041
+ title?: string;
3042
+ }
3043
+ interface ActionValidationInfo {
3044
+ /** the id of the action in the automation */
3045
+ actionId?: string | null;
3046
+ /** the id of the app defining the action */
3047
+ appId?: string;
3048
+ /** human readable identifier of the action per app */
3049
+ actionKey?: string;
3050
+ /** list of action validation errors */
3051
+ validationErrors?: ActionValidationError[];
3052
+ }
3053
+ interface ActionValidationError extends ActionValidationErrorErrorOneOf {
3054
+ /** action configuration error */
3055
+ configurationError?: ActionConfigurationError;
3056
+ /** provider configuration error */
3057
+ providerConfigurationError?: ProviderConfigurationError;
3058
+ /** validation error type */
3059
+ errorType?: ValidationErrorType;
3060
+ }
3061
+ /** @oneof */
3062
+ interface ActionValidationErrorErrorOneOf {
3063
+ /** action configuration error */
3064
+ configurationError?: ActionConfigurationError;
3065
+ /** provider configuration error */
3066
+ providerConfigurationError?: ProviderConfigurationError;
3067
+ }
3068
+ declare enum ValidationErrorType {
3069
+ UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
3070
+ CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
3071
+ PROVIDER_ERROR = "PROVIDER_ERROR"
3072
+ }
3073
+ interface ActionConfigurationError {
3074
+ /** action error type */
3075
+ errorType?: ActionErrorType;
3076
+ /** optional - related field key */
3077
+ fieldKey?: string | null;
3078
+ }
3079
+ declare enum ActionErrorType {
3080
+ UNKNOWN_ACTION_ERROR_TYPE = "UNKNOWN_ACTION_ERROR_TYPE",
3081
+ NOT_FOUND = "NOT_FOUND",
3082
+ APP_NOT_INSTALLED = "APP_NOT_INSTALLED",
3083
+ MODERATION_MISMATCH = "MODERATION_MISMATCH",
3084
+ DEPRECATED = "DEPRECATED",
3085
+ INVALID_ACTION_KEY = "INVALID_ACTION_KEY",
3086
+ INVALID_MAPPING = "INVALID_MAPPING",
3087
+ MAPPING_TYPE_MISMATCH = "MAPPING_TYPE_MISMATCH",
3088
+ MAPPING_MISSING_REQUIRED_FIELD = "MAPPING_MISSING_REQUIRED_FIELD",
3089
+ MAPPING_SCHEMA_MISMATCH = "MAPPING_SCHEMA_MISMATCH",
3090
+ MAPPING_VARIABLE_MISSING_FROM_SCHEMA = "MAPPING_VARIABLE_MISSING_FROM_SCHEMA"
3091
+ }
3092
+ interface ApplicationOriginNonNullableFields {
3093
+ appId: string;
3094
+ }
3095
+ interface PreinstalledOriginNonNullableFields {
3096
+ appId: string;
3097
+ componentId: string;
3098
+ componentVersion: number;
3099
+ }
3100
+ interface AuditInfoNonNullableFields {
3101
+ userId: string;
3102
+ appId: string;
3103
+ }
3104
+ interface FilterNonNullableFields {
3105
+ _id: string;
3106
+ fieldKey: string;
3107
+ filterExpression: string;
3108
+ }
3109
+ interface FutureDateActivationOffsetNonNullableFields {
3110
+ preScheduledEventOffsetExpression: string;
3111
+ scheduledEventOffsetTimeUnit: TimeUnit;
3112
+ }
3113
+ interface RateLimitNonNullableFields {
3114
+ maxActivationsExpression: string;
3115
+ durationTimeUnit: TimeUnit;
3116
+ }
3117
+ interface TriggerNonNullableFields {
3118
+ appId: string;
3119
+ triggerKey: string;
3120
+ filters: FilterNonNullableFields[];
3121
+ scheduledEventOffset?: FutureDateActivationOffsetNonNullableFields;
3122
+ rateLimit?: RateLimitNonNullableFields;
3123
+ }
3124
+ interface AutomationConfigurationNonNullableFields {
3125
+ status: Status;
3126
+ trigger?: TriggerNonNullableFields;
3127
+ rootActionIds: string[];
3128
+ }
3129
+ interface ActionSettingsNonNullableFields {
3130
+ permanentActionIds: string[];
3131
+ readonlyActionIds: string[];
3132
+ disableDelayAddition: boolean;
3133
+ disableConditionAddition: boolean;
3134
+ }
3135
+ interface AutomationSettingsNonNullableFields {
3136
+ hidden: boolean;
3137
+ readonly: boolean;
3138
+ disableDelete: boolean;
3139
+ disableStatusChange: boolean;
3140
+ actionSettings?: ActionSettingsNonNullableFields;
3141
+ }
3142
+ interface AutomationNonNullableFields {
3143
+ applicationInfo?: ApplicationOriginNonNullableFields;
3144
+ preinstalledInfo?: PreinstalledOriginNonNullableFields;
3145
+ createdBy?: AuditInfoNonNullableFields;
3146
+ updatedBy?: AuditInfoNonNullableFields;
3147
+ name: string;
3148
+ configuration?: AutomationConfigurationNonNullableFields;
3149
+ origin: Origin;
3150
+ settings?: AutomationSettingsNonNullableFields;
3151
+ }
3152
+ interface CreateAutomationResponseNonNullableFields {
3153
+ automation?: AutomationNonNullableFields;
3154
+ }
3155
+ interface GetAutomationResponseNonNullableFields {
3156
+ automation?: AutomationNonNullableFields;
3157
+ }
3158
+ interface UpdateAutomationResponseNonNullableFields {
3159
+ automation?: AutomationNonNullableFields;
3160
+ }
3161
+ interface QueryAutomationsResponseNonNullableFields {
3162
+ automations: AutomationNonNullableFields[];
3163
+ }
3164
+ interface TriggerConfigurationErrorNonNullableFields {
3165
+ errorType: TriggerErrorType;
3166
+ }
3167
+ interface ProviderConfigurationErrorNonNullableFields {
3168
+ message: string;
3169
+ title: string;
3170
+ }
3171
+ interface TriggerValidationErrorNonNullableFields {
3172
+ configurationError?: TriggerConfigurationErrorNonNullableFields;
3173
+ providerConfigurationError?: ProviderConfigurationErrorNonNullableFields;
3174
+ errorType: TriggerValidationErrorValidationErrorType;
3175
+ }
3176
+ interface ActionConfigurationErrorNonNullableFields {
3177
+ errorType: ActionErrorType;
3178
+ }
3179
+ interface ActionValidationErrorNonNullableFields {
3180
+ configurationError?: ActionConfigurationErrorNonNullableFields;
3181
+ providerConfigurationError?: ProviderConfigurationErrorNonNullableFields;
3182
+ errorType: ValidationErrorType;
3183
+ }
3184
+ interface ActionValidationInfoNonNullableFields {
3185
+ appId: string;
3186
+ actionKey: string;
3187
+ validationErrors: ActionValidationErrorNonNullableFields[];
3188
+ }
3189
+ interface ValidateAutomationResponseNonNullableFields {
3190
+ valid: boolean;
3191
+ triggerValidationErrors: TriggerValidationErrorNonNullableFields[];
3192
+ actionValidationInfo: ActionValidationInfoNonNullableFields[];
3193
+ }
3194
+
3195
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
3196
+ getUrl: (context: any) => string;
3197
+ httpMethod: K;
3198
+ path: string;
3199
+ pathParams: M;
3200
+ __requestType: T;
3201
+ __originalRequestType: S;
3202
+ __responseType: Q;
3203
+ __originalResponseType: R;
3204
+ };
3205
+ declare function createAutomation(): __PublicMethodMetaInfo<'POST', {}, CreateAutomationRequest, CreateAutomationRequest$1, CreateAutomationResponse & CreateAutomationResponseNonNullableFields, CreateAutomationResponse$1 & CreateAutomationResponseNonNullableFields$1>;
3206
+ declare function getAutomation(): __PublicMethodMetaInfo<'GET', {
3207
+ automationId: string;
3208
+ }, GetAutomationRequest, GetAutomationRequest$1, GetAutomationResponse & GetAutomationResponseNonNullableFields, GetAutomationResponse$1 & GetAutomationResponseNonNullableFields$1>;
3209
+ declare function updateAutomation(): __PublicMethodMetaInfo<'PATCH', {
3210
+ automationId: string;
3211
+ }, UpdateAutomationRequest, UpdateAutomationRequest$1, UpdateAutomationResponse & UpdateAutomationResponseNonNullableFields, UpdateAutomationResponse$1 & UpdateAutomationResponseNonNullableFields$1>;
3212
+ declare function deleteAutomation(): __PublicMethodMetaInfo<'DELETE', {
3213
+ automationId: string;
3214
+ }, DeleteAutomationRequest, DeleteAutomationRequest$1, DeleteAutomationResponse, DeleteAutomationResponse$1>;
3215
+ declare function queryAutomations(): __PublicMethodMetaInfo<'POST', {}, QueryAutomationsRequest, QueryAutomationsRequest$1, QueryAutomationsResponse & QueryAutomationsResponseNonNullableFields, QueryAutomationsResponse$1 & QueryAutomationsResponseNonNullableFields$1>;
3216
+ declare function validateAutomation(): __PublicMethodMetaInfo<'POST', {}, ValidateAutomationRequest, ValidateAutomationRequest$1, ValidateAutomationResponse & ValidateAutomationResponseNonNullableFields, ValidateAutomationResponse$1 & ValidateAutomationResponseNonNullableFields$1>;
1784
3217
 
1785
3218
  type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
1786
- declare const meta_bulkCancelEvent: typeof bulkCancelEvent;
1787
- declare const meta_bulkReportEvent: typeof bulkReportEvent;
1788
- declare const meta_cancelEvent: typeof cancelEvent;
1789
- declare const meta_reportEvent: typeof reportEvent;
3219
+ declare const meta_createAutomation: typeof createAutomation;
3220
+ declare const meta_deleteAutomation: typeof deleteAutomation;
3221
+ declare const meta_getAutomation: typeof getAutomation;
3222
+ declare const meta_queryAutomations: typeof queryAutomations;
3223
+ declare const meta_updateAutomation: typeof updateAutomation;
3224
+ declare const meta_validateAutomation: typeof validateAutomation;
1790
3225
  declare namespace meta {
1791
- export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkCancelEvent as bulkCancelEvent, meta_bulkReportEvent as bulkReportEvent, meta_cancelEvent as cancelEvent, meta_reportEvent as reportEvent };
3226
+ export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createAutomation as createAutomation, meta_deleteAutomation as deleteAutomation, meta_getAutomation as getAutomation, meta_queryAutomations as queryAutomations, meta_updateAutomation as updateAutomation, meta_validateAutomation as validateAutomation };
1792
3227
  }
1793
3228
 
1794
- export { meta as activations, meta$1 as automationsService };
3229
+ export { meta$1 as activations, meta$2 as automationsService, meta as automationsServiceV2 };