@wix/auto_sdk_automations_automations-v-2 1.0.45 → 1.0.46

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.
@@ -109,6 +109,23 @@ interface ActionSettings {
109
109
  */
110
110
  disableConditionAddition?: boolean;
111
111
  }
112
+ declare enum Domain {
113
+ /** User domain (default). */
114
+ USER = "USER",
115
+ /** Wix domain. */
116
+ WIX = "WIX",
117
+ /** Wix account-level domain. */
118
+ WIX_ACCOUNT = "WIX_ACCOUNT"
119
+ }
120
+ /** @enumType */
121
+ type DomainWithLiterals = Domain | 'USER' | 'WIX' | 'WIX_ACCOUNT';
122
+ interface Enrichment {
123
+ /**
124
+ * Enrichment input mappings.
125
+ * @maxSize 2
126
+ */
127
+ inputMappings?: Record<string, any>[] | null;
128
+ }
112
129
  interface AuditInfo extends AuditInfoIdOneOf {
113
130
  /**
114
131
  * [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
@@ -224,6 +241,14 @@ interface RateLimit {
224
241
  */
225
242
  uniqueIdentifierExpression?: string | null;
226
243
  }
244
+ interface FilterValueSelection {
245
+ /**
246
+ * Values that can help the user filter certain automations. Specify values in the following format: `<filter_id>__<selected_value>`.
247
+ * @maxLength 80
248
+ * @maxSize 50
249
+ */
250
+ selectedFilterValues?: string[];
251
+ }
227
252
  interface ConditionExpressionGroup {
228
253
  /** Logical operator used to evaluate the condition expressions. */
229
254
  operator?: OperatorWithLiterals;
@@ -262,6 +287,25 @@ declare enum Language {
262
287
  }
263
288
  /** @enumType */
264
289
  type LanguageWithLiterals = Language | 'UNKNOWN_LANGUAGE' | 'JAVASCRIPT';
290
+ /** Path definition */
291
+ interface Path {
292
+ /**
293
+ * Unique path ID.
294
+ * @format GUID
295
+ */
296
+ id?: string;
297
+ /**
298
+ * Path display name.
299
+ * @minLength 1
300
+ * @maxLength 100
301
+ */
302
+ name?: string;
303
+ /**
304
+ * ID of the action to run when this path is taken.
305
+ * @format GUID
306
+ */
307
+ postActionId?: string | null;
308
+ }
265
309
  declare enum Type {
266
310
  /** Based on the trigger. */
267
311
  UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
@@ -412,6 +456,34 @@ interface RateLimitAction {
412
456
  */
413
457
  postActionIds?: string[];
414
458
  }
459
+ interface SetVariablesAction {
460
+ /** Output mapping. For example: `{"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }`. */
461
+ outputMapping?: Record<string, any> | null;
462
+ /**
463
+ * Output JSON schema representation.
464
+ *
465
+ * > **Note**: To minimize request size, you can also specify a string.
466
+ */
467
+ outputSchema?: Record<string, any> | null;
468
+ /**
469
+ * IDs of actions to run in parallel after variable initialization.
470
+ * @maxSize 1
471
+ * @format GUID
472
+ */
473
+ postActionIds?: string[];
474
+ }
475
+ interface OutputAction {
476
+ /** Output action output mapping. */
477
+ outputMapping?: Record<string, any> | null;
478
+ }
479
+ interface SplitAction {
480
+ /**
481
+ * List of paths to split execution into.
482
+ * @minSize 2
483
+ * @maxSize 10
484
+ */
485
+ paths?: Path[];
486
+ }
415
487
  declare enum Status {
416
488
  /** Unknown. */
417
489
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
@@ -503,6 +575,16 @@ interface ActionInfoOneOf {
503
575
  /** Details of the action when its `type` is `RATE_LIMIT`. */
504
576
  rateLimitInfo?: RateLimitAction;
505
577
  }
578
+ interface FilterableAppDefinedActions {
579
+ /**
580
+ * App-defined action identifiers. Identifiers have the following format: `${appId}_${actionKey}`.
581
+ * @minSize 1
582
+ * @maxSize 100
583
+ * @minLength 1
584
+ * @maxLength 150
585
+ */
586
+ actionIdentifiers?: string[];
587
+ }
506
588
  declare enum Origin {
507
589
  /** Default value. */
508
590
  UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
@@ -581,6 +663,21 @@ interface DraftInfo {
581
663
  */
582
664
  originalAutomationId?: string | null;
583
665
  }
666
+ interface Enrichments {
667
+ /** Whether the studio site enrichment is wanted. */
668
+ studioSite?: Enrichment;
669
+ }
670
+ interface ExtendedFields {
671
+ /**
672
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
673
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
674
+ *
675
+ * You can only access fields for which you have the appropriate permissions.
676
+ *
677
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
678
+ */
679
+ namespaces?: Record<string, Record<string, any>>;
680
+ }
584
681
  interface AutoArchivePolicy {
585
682
  /**
586
683
  * Date when to archive the automation
@@ -590,6 +687,177 @@ interface AutoArchivePolicy {
590
687
  */
591
688
  archiveDate?: Date | null;
592
689
  }
690
+ interface Notes {
691
+ }
692
+ interface Note {
693
+ }
694
+ interface Position {
695
+ }
696
+ interface Offset {
697
+ }
698
+ interface Dimensions {
699
+ }
700
+ interface UpdatedWithPreviousEntity {
701
+ /** Previous automation. */
702
+ previousAutomation?: Automation;
703
+ /** Updated automation. */
704
+ currentAutomation?: Automation;
705
+ }
706
+ interface DeletedWithEntity {
707
+ /** Deleted automation. */
708
+ automation?: Automation;
709
+ }
710
+ interface DraftPublished {
711
+ /**
712
+ * ID of the draft automation.
713
+ * @format GUID
714
+ */
715
+ draftAutomationId?: string;
716
+ /**
717
+ * Original automation on which the draft is based.
718
+ *
719
+ * > **Note**: If the draft is not based on an existing automation, the draft itself is the original automation.
720
+ */
721
+ draftOriginalAutomation?: Automation;
722
+ /** Updated, published automation. */
723
+ updatedAutomation?: Automation;
724
+ }
725
+ interface DomainEvent extends DomainEventBodyOneOf {
726
+ createdEvent?: EntityCreatedEvent;
727
+ updatedEvent?: EntityUpdatedEvent;
728
+ deletedEvent?: EntityDeletedEvent;
729
+ actionEvent?: ActionEvent;
730
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
731
+ id?: string;
732
+ /**
733
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
734
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
735
+ */
736
+ entityFqdn?: string;
737
+ /**
738
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
739
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
740
+ */
741
+ slug?: string;
742
+ /** ID of the entity associated with the event. */
743
+ entityId?: string;
744
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
745
+ eventTime?: Date | null;
746
+ /**
747
+ * Whether the event was triggered as a result of a privacy regulation application
748
+ * (for example, GDPR).
749
+ */
750
+ triggeredByAnonymizeRequest?: boolean | null;
751
+ /** If present, indicates the action that triggered the event. */
752
+ originatedFrom?: string | null;
753
+ /**
754
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
755
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
756
+ */
757
+ entityEventSequence?: string | null;
758
+ }
759
+ /** @oneof */
760
+ interface DomainEventBodyOneOf {
761
+ createdEvent?: EntityCreatedEvent;
762
+ updatedEvent?: EntityUpdatedEvent;
763
+ deletedEvent?: EntityDeletedEvent;
764
+ actionEvent?: ActionEvent;
765
+ }
766
+ interface EntityCreatedEvent {
767
+ entityAsJson?: string;
768
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
769
+ restoreInfo?: RestoreInfo;
770
+ }
771
+ interface RestoreInfo {
772
+ deletedDate?: Date | null;
773
+ }
774
+ interface EntityUpdatedEvent {
775
+ /**
776
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
777
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
778
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
779
+ */
780
+ currentEntityAsJson?: string;
781
+ }
782
+ interface EntityDeletedEvent {
783
+ /** Entity that was deleted. */
784
+ deletedEntityAsJson?: string | null;
785
+ }
786
+ interface ActionEvent {
787
+ bodyAsJson?: string;
788
+ }
789
+ interface MessageEnvelope {
790
+ /**
791
+ * App instance ID.
792
+ * @format GUID
793
+ */
794
+ instanceId?: string | null;
795
+ /**
796
+ * Event type.
797
+ * @maxLength 150
798
+ */
799
+ eventType?: string;
800
+ /** The identification type and identity data. */
801
+ identity?: IdentificationData;
802
+ /** Stringify payload. */
803
+ data?: string;
804
+ }
805
+ interface IdentificationData extends IdentificationDataIdOneOf {
806
+ /**
807
+ * ID of a site visitor that has not logged in to the site.
808
+ * @format GUID
809
+ */
810
+ anonymousVisitorId?: string;
811
+ /**
812
+ * ID of a site visitor that has logged in to the site.
813
+ * @format GUID
814
+ */
815
+ memberId?: string;
816
+ /**
817
+ * ID of a Wix user (site owner, contributor, etc.).
818
+ * @format GUID
819
+ */
820
+ wixUserId?: string;
821
+ /**
822
+ * ID of an app.
823
+ * @format GUID
824
+ */
825
+ appId?: string;
826
+ /** @readonly */
827
+ identityType?: WebhookIdentityTypeWithLiterals;
828
+ }
829
+ /** @oneof */
830
+ interface IdentificationDataIdOneOf {
831
+ /**
832
+ * ID of a site visitor that has not logged in to the site.
833
+ * @format GUID
834
+ */
835
+ anonymousVisitorId?: string;
836
+ /**
837
+ * ID of a site visitor that has logged in to the site.
838
+ * @format GUID
839
+ */
840
+ memberId?: string;
841
+ /**
842
+ * ID of a Wix user (site owner, contributor, etc.).
843
+ * @format GUID
844
+ */
845
+ wixUserId?: string;
846
+ /**
847
+ * ID of an app.
848
+ * @format GUID
849
+ */
850
+ appId?: string;
851
+ }
852
+ declare enum WebhookIdentityType {
853
+ UNKNOWN = "UNKNOWN",
854
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
855
+ MEMBER = "MEMBER",
856
+ WIX_USER = "WIX_USER",
857
+ APP = "APP"
858
+ }
859
+ /** @enumType */
860
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
593
861
  interface CreateAutomationRequest {
594
862
  /** Automation to create. */
595
863
  automation: Automation;
@@ -685,6 +953,105 @@ interface BulkActionMetadata {
685
953
  /** Number of failures without details because detailed failure threshold was exceeded. */
686
954
  undetailedFailures?: number;
687
955
  }
956
+ interface CreatePreinstalledAutomationRequest {
957
+ /** Preinstalled automation to create. */
958
+ automation?: Automation;
959
+ /**
960
+ * Hide the created automation behind a spec.
961
+ *
962
+ * For internal use only.
963
+ */
964
+ specInfo?: PreinstalledAutomationSpecInfo;
965
+ /**
966
+ * Original site automation used to create the current preinstalled automation.
967
+ *
968
+ * Usually an existing automation on a site is used to create the preinstalled automation.
969
+ *
970
+ * For internal use only.
971
+ */
972
+ originAutomationInfo?: OriginAutomationInfo;
973
+ /**
974
+ * ID of the app to which the automation belongs.
975
+ * @format GUID
976
+ */
977
+ appId?: string;
978
+ }
979
+ interface PreinstalledAutomationSpecInfo {
980
+ /**
981
+ * Spec to conduct on for the automation.
982
+ *
983
+ * For internal use only.
984
+ * @maxLength 128
985
+ */
986
+ spec?: string;
987
+ /**
988
+ * Value the spec should return in order to affect the user with the operation
989
+ * e.g. creation - show the users the automation, update - show the users the updated automation, deletion - not show the users the automation
990
+ * @maxLength 128
991
+ */
992
+ variantValue?: string | null;
993
+ /**
994
+ * Version from which the experiment should decide whether to expose it to users when !conduct(spec).contains(variant_value)
995
+ * For example, if 50 is set, version 49 and below (including 49) will not expose the preinstalled automation to the user.
996
+ */
997
+ experimentVersion?: number;
998
+ }
999
+ interface OriginAutomationInfo {
1000
+ /**
1001
+ * ID of the original automation.
1002
+ * @format GUID
1003
+ */
1004
+ siteAutomationId?: string;
1005
+ /**
1006
+ * Metasite ID of the original automation.
1007
+ * @format GUID
1008
+ */
1009
+ metaSiteId?: string;
1010
+ }
1011
+ interface CreatePreinstalledAutomationResponse {
1012
+ /** Details of the created preinstalled automation. */
1013
+ automation?: Automation;
1014
+ }
1015
+ interface UpdatePreinstalledAutomationRequest {
1016
+ /** Preinstalled automation to update. */
1017
+ automation?: Automation;
1018
+ /**
1019
+ * Hide the updated automation behind a spec.
1020
+ *
1021
+ * For internal use only.
1022
+ */
1023
+ specInfo?: PreinstalledAutomationSpecInfo;
1024
+ /**
1025
+ * ID of the app to which the automation belongs.
1026
+ * @format GUID
1027
+ */
1028
+ appId?: string;
1029
+ }
1030
+ interface UpdatePreinstalledAutomationResponse {
1031
+ /** Updated preinstalled automation. */
1032
+ automation?: Automation;
1033
+ }
1034
+ interface DeletePreinstalledAutomationRequest {
1035
+ /**
1036
+ * ID of the preinstalled component.
1037
+ * @format GUID
1038
+ */
1039
+ componentId?: string;
1040
+ /**
1041
+ * Makes the deletion operation gradual.
1042
+ * The automation will not return if the variant returns for the site
1043
+ *
1044
+ * For internal use only.
1045
+ */
1046
+ specInfo?: PreinstalledAutomationSpecInfo;
1047
+ /**
1048
+ * ID of the app to which the component belongs.
1049
+ * @format GUID
1050
+ */
1051
+ appId?: string;
1052
+ }
1053
+ interface DeletePreinstalledAutomationResponse {
1054
+ }
688
1055
  interface GeneratePreinstalledAutomationRequest {
689
1056
  /** Automation. */
690
1057
  automation: Automation;
@@ -698,6 +1065,19 @@ interface GeneratePreinstalledAutomationResponse {
698
1065
  /** Automation. */
699
1066
  automation?: Automation;
700
1067
  }
1068
+ interface QueryPreinstalledAutomationsForAppRequest {
1069
+ /**
1070
+ * Query.
1071
+ *
1072
+ * Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
1073
+ */
1074
+ query?: CursorQuery;
1075
+ /**
1076
+ * ID of the app for which to query preinstalled automations.
1077
+ * @format GUID
1078
+ */
1079
+ appId?: string;
1080
+ }
701
1081
  interface CursorQuery extends CursorQueryPagingMethodOneOf {
702
1082
  /** 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`. */
703
1083
  cursorPaging?: CursorPaging;
@@ -753,6 +1133,12 @@ interface CursorPaging {
753
1133
  */
754
1134
  cursor?: string | null;
755
1135
  }
1136
+ interface QueryPreinstalledAutomationsForAppResponse {
1137
+ /** Automations. */
1138
+ automations?: Automation[];
1139
+ /** Paging metadata. */
1140
+ pagingMetadata?: CursorPagingMetadata;
1141
+ }
756
1142
  interface CursorPagingMetadata {
757
1143
  /** Number of items returned in the response. */
758
1144
  count?: number | null;
@@ -778,6 +1164,19 @@ interface Cursors {
778
1164
  */
779
1165
  prev?: string | null;
780
1166
  }
1167
+ interface QueryPreinstalledAutomationsRequest {
1168
+ /**
1169
+ * Query.
1170
+ * Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
1171
+ */
1172
+ query?: CursorQuery;
1173
+ }
1174
+ interface QueryPreinstalledAutomationsResponse {
1175
+ /** Automations. */
1176
+ automations?: Automation[];
1177
+ /** Paging metadata. */
1178
+ pagingMetadata?: CursorPagingMetadata;
1179
+ }
781
1180
  interface QueryAutomationsRequest {
782
1181
  /**
783
1182
  * Query.
@@ -844,6 +1243,8 @@ interface ActionUsageSummary {
844
1243
  /** Number of automations that include this action. */
845
1244
  automationsCount?: number;
846
1245
  }
1246
+ interface Empty {
1247
+ }
847
1248
  interface CopyAutomationRequest {
848
1249
  /**
849
1250
  * ID of the automation to copy.
@@ -859,6 +1260,467 @@ interface CopyAutomationResponse {
859
1260
  /** Copy of the automation. */
860
1261
  automation?: Automation;
861
1262
  }
1263
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
1264
+ /** Emitted on a meta site creation. */
1265
+ siteCreated?: SiteCreated;
1266
+ /** Emitted on a meta site transfer completion. */
1267
+ siteTransferred?: SiteTransferred;
1268
+ /** Emitted on a meta site deletion. */
1269
+ siteDeleted?: SiteDeleted;
1270
+ /** Emitted on a meta site restoration. */
1271
+ siteUndeleted?: SiteUndeleted;
1272
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
1273
+ sitePublished?: SitePublished;
1274
+ /** Emitted on a meta site unpublish. */
1275
+ siteUnpublished?: SiteUnpublished;
1276
+ /** Emitted when meta site is marked as template. */
1277
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
1278
+ /** Emitted when meta site is marked as a WixSite. */
1279
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
1280
+ /** Emitted when an application is provisioned (installed). */
1281
+ serviceProvisioned?: ServiceProvisioned;
1282
+ /** Emitted when an application is removed (uninstalled). */
1283
+ serviceRemoved?: ServiceRemoved;
1284
+ /** Emitted when meta site name (URL slug) is changed. */
1285
+ siteRenamedPayload?: SiteRenamed;
1286
+ /** Emitted when meta site was permanently deleted. */
1287
+ hardDeleted?: SiteHardDeleted;
1288
+ /** Emitted on a namespace change. */
1289
+ namespaceChanged?: NamespaceChanged;
1290
+ /** Emitted when Studio is attached. */
1291
+ studioAssigned?: StudioAssigned;
1292
+ /** Emitted when Studio is detached. */
1293
+ studioUnassigned?: StudioUnassigned;
1294
+ /**
1295
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
1296
+ * the actual URL.
1297
+ *
1298
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
1299
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
1300
+ */
1301
+ urlChanged?: SiteUrlChanged;
1302
+ /** Site is marked as PurgedExternally */
1303
+ sitePurgedExternally?: SitePurgedExternally;
1304
+ /** Emitted when Odeditor is attached. */
1305
+ odeditorAssigned?: OdeditorAssigned;
1306
+ /** Emitted when Odeditor is detached. */
1307
+ odeditorUnassigned?: OdeditorUnassigned;
1308
+ /** Emitted when Picasso is attached. */
1309
+ picassoAssigned?: PicassoAssigned;
1310
+ /** Emitted when Picasso is detached. */
1311
+ picassoUnassigned?: PicassoUnassigned;
1312
+ /**
1313
+ * A meta site id.
1314
+ * @format GUID
1315
+ */
1316
+ metaSiteId?: string;
1317
+ /** A meta site version. Monotonically increasing. */
1318
+ version?: string;
1319
+ /** A timestamp of the event. */
1320
+ timestamp?: string;
1321
+ /**
1322
+ * TODO(meta-site): Change validation once validations are disabled for consumers
1323
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
1324
+ * @maxSize 4000
1325
+ */
1326
+ assets?: Asset[];
1327
+ }
1328
+ /** @oneof */
1329
+ interface MetaSiteSpecialEventPayloadOneOf {
1330
+ /** Emitted on a meta site creation. */
1331
+ siteCreated?: SiteCreated;
1332
+ /** Emitted on a meta site transfer completion. */
1333
+ siteTransferred?: SiteTransferred;
1334
+ /** Emitted on a meta site deletion. */
1335
+ siteDeleted?: SiteDeleted;
1336
+ /** Emitted on a meta site restoration. */
1337
+ siteUndeleted?: SiteUndeleted;
1338
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
1339
+ sitePublished?: SitePublished;
1340
+ /** Emitted on a meta site unpublish. */
1341
+ siteUnpublished?: SiteUnpublished;
1342
+ /** Emitted when meta site is marked as template. */
1343
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
1344
+ /** Emitted when meta site is marked as a WixSite. */
1345
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
1346
+ /** Emitted when an application is provisioned (installed). */
1347
+ serviceProvisioned?: ServiceProvisioned;
1348
+ /** Emitted when an application is removed (uninstalled). */
1349
+ serviceRemoved?: ServiceRemoved;
1350
+ /** Emitted when meta site name (URL slug) is changed. */
1351
+ siteRenamedPayload?: SiteRenamed;
1352
+ /** Emitted when meta site was permanently deleted. */
1353
+ hardDeleted?: SiteHardDeleted;
1354
+ /** Emitted on a namespace change. */
1355
+ namespaceChanged?: NamespaceChanged;
1356
+ /** Emitted when Studio is attached. */
1357
+ studioAssigned?: StudioAssigned;
1358
+ /** Emitted when Studio is detached. */
1359
+ studioUnassigned?: StudioUnassigned;
1360
+ /**
1361
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
1362
+ * the actual URL.
1363
+ *
1364
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
1365
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
1366
+ */
1367
+ urlChanged?: SiteUrlChanged;
1368
+ /** Site is marked as PurgedExternally */
1369
+ sitePurgedExternally?: SitePurgedExternally;
1370
+ /** Emitted when Odeditor is attached. */
1371
+ odeditorAssigned?: OdeditorAssigned;
1372
+ /** Emitted when Odeditor is detached. */
1373
+ odeditorUnassigned?: OdeditorUnassigned;
1374
+ /** Emitted when Picasso is attached. */
1375
+ picassoAssigned?: PicassoAssigned;
1376
+ /** Emitted when Picasso is detached. */
1377
+ picassoUnassigned?: PicassoUnassigned;
1378
+ }
1379
+ interface Asset {
1380
+ /**
1381
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
1382
+ * @maxLength 36
1383
+ */
1384
+ appDefId?: string;
1385
+ /**
1386
+ * An instance id. For legacy reasons may be UUID or a string.
1387
+ * @maxLength 200
1388
+ */
1389
+ instanceId?: string;
1390
+ /** An application state. */
1391
+ state?: StateWithLiterals;
1392
+ }
1393
+ declare enum State {
1394
+ UNKNOWN = "UNKNOWN",
1395
+ ENABLED = "ENABLED",
1396
+ DISABLED = "DISABLED",
1397
+ PENDING = "PENDING",
1398
+ DEMO = "DEMO"
1399
+ }
1400
+ /** @enumType */
1401
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
1402
+ interface SiteCreated {
1403
+ /**
1404
+ * A template identifier (empty if not created from a template).
1405
+ * @maxLength 36
1406
+ */
1407
+ originTemplateId?: string;
1408
+ /**
1409
+ * An account id of the owner.
1410
+ * @format GUID
1411
+ */
1412
+ ownerId?: string;
1413
+ /** A context in which meta site was created. */
1414
+ context?: SiteCreatedContextWithLiterals;
1415
+ /**
1416
+ * A meta site id from which this site was created.
1417
+ *
1418
+ * In case of a creation from a template it's a template id.
1419
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
1420
+ * @format GUID
1421
+ */
1422
+ originMetaSiteId?: string | null;
1423
+ /**
1424
+ * A meta site name (URL slug).
1425
+ * @maxLength 20
1426
+ */
1427
+ siteName?: string;
1428
+ /** A namespace. */
1429
+ namespace?: NamespaceWithLiterals;
1430
+ }
1431
+ declare enum SiteCreatedContext {
1432
+ /** A valid option, we don't expose all reasons why site might be created. */
1433
+ OTHER = "OTHER",
1434
+ /** A meta site was created from template. */
1435
+ FROM_TEMPLATE = "FROM_TEMPLATE",
1436
+ /** A meta site was created by copying of the transfferred meta site. */
1437
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
1438
+ /** A copy of existing meta site. */
1439
+ DUPLICATE = "DUPLICATE",
1440
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
1441
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
1442
+ /** deprecated A meta site was created for Flash editor. */
1443
+ FLASH = "FLASH"
1444
+ }
1445
+ /** @enumType */
1446
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
1447
+ declare enum Namespace {
1448
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
1449
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
1450
+ WIX = "WIX",
1451
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1452
+ SHOUT_OUT = "SHOUT_OUT",
1453
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1454
+ ALBUMS = "ALBUMS",
1455
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1456
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
1457
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1458
+ HOTELS = "HOTELS",
1459
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1460
+ CLUBS = "CLUBS",
1461
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1462
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
1463
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1464
+ DEV_SITE = "DEV_SITE",
1465
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1466
+ LOGOS = "LOGOS",
1467
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1468
+ VIDEO_MAKER = "VIDEO_MAKER",
1469
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1470
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
1471
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1472
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
1473
+ /**
1474
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
1475
+ *
1476
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
1477
+ */
1478
+ HTML_DRAFT = "HTML_DRAFT",
1479
+ /**
1480
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
1481
+ * Will be accessible from Site List and will not have a website app.
1482
+ * Once the user attaches a site, the site will become a regular wixsite.
1483
+ */
1484
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
1485
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
1486
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
1487
+ /** It is to be used in the Business First efforts. */
1488
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
1489
+ /** Bookings business flow with no site. */
1490
+ ANYWHERE = "ANYWHERE",
1491
+ /** Namespace for Headless Backoffice with no editor */
1492
+ HEADLESS = "HEADLESS",
1493
+ /**
1494
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
1495
+ * The site will be used for account level CSM feature for enterprise
1496
+ */
1497
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
1498
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
1499
+ RISE = "RISE",
1500
+ /**
1501
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
1502
+ * There's a blank site behind the scene but it's blank).
1503
+ * The Mobile company will be the owner of this namespace.
1504
+ */
1505
+ BRANDED_FIRST = "BRANDED_FIRST",
1506
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
1507
+ NOWNIA = "NOWNIA",
1508
+ /**
1509
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
1510
+ * The Partners company owns this namespace.
1511
+ */
1512
+ UGC_TEMPLATE = "UGC_TEMPLATE",
1513
+ /** Codux Headless Sites */
1514
+ CODUX = "CODUX",
1515
+ /** Bobb - AI Design Creator. */
1516
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
1517
+ /**
1518
+ * Shared Blog Site is a unique single site across Enterprise account,
1519
+ * This site will hold all Blog posts related to the Marketing product.
1520
+ */
1521
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
1522
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1523
+ STANDALONE_FORMS = "STANDALONE_FORMS",
1524
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1525
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
1526
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
1527
+ MIMIR = "MIMIR",
1528
+ /** Wix Twins platform. */
1529
+ TWINS = "TWINS",
1530
+ /** Wix Nano. */
1531
+ NANO = "NANO"
1532
+ }
1533
+ /** @enumType */
1534
+ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO';
1535
+ /** Site transferred to another user. */
1536
+ interface SiteTransferred {
1537
+ /**
1538
+ * A previous owner id (user that transfers meta site).
1539
+ * @format GUID
1540
+ */
1541
+ oldOwnerId?: string;
1542
+ /**
1543
+ * A new owner id (user that accepts meta site).
1544
+ * @format GUID
1545
+ */
1546
+ newOwnerId?: string;
1547
+ }
1548
+ /** Soft deletion of the meta site. Could be restored. */
1549
+ interface SiteDeleted {
1550
+ /** A deletion context. */
1551
+ deleteContext?: DeleteContext;
1552
+ }
1553
+ interface DeleteContext {
1554
+ /** When the meta site was deleted. */
1555
+ dateDeleted?: Date | null;
1556
+ /** A status. */
1557
+ deleteStatus?: DeleteStatusWithLiterals;
1558
+ /**
1559
+ * A reason (flow).
1560
+ * @maxLength 255
1561
+ */
1562
+ deleteOrigin?: string;
1563
+ /**
1564
+ * A service that deleted it.
1565
+ * @maxLength 255
1566
+ */
1567
+ initiatorId?: string | null;
1568
+ }
1569
+ declare enum DeleteStatus {
1570
+ UNKNOWN = "UNKNOWN",
1571
+ TRASH = "TRASH",
1572
+ DELETED = "DELETED",
1573
+ PENDING_PURGE = "PENDING_PURGE",
1574
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
1575
+ }
1576
+ /** @enumType */
1577
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
1578
+ /** Restoration of the meta site. */
1579
+ interface SiteUndeleted {
1580
+ }
1581
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
1582
+ interface SitePublished {
1583
+ }
1584
+ interface SiteUnpublished {
1585
+ /**
1586
+ * A list of URLs previously associated with the meta site.
1587
+ * @maxLength 4000
1588
+ * @maxSize 10000
1589
+ */
1590
+ urls?: string[];
1591
+ }
1592
+ interface SiteMarkedAsTemplate {
1593
+ }
1594
+ interface SiteMarkedAsWixSite {
1595
+ }
1596
+ /**
1597
+ * Represents a service provisioned a site.
1598
+ *
1599
+ * Note on `origin_instance_id`:
1600
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
1601
+ * This is because of the following scenario:
1602
+ *
1603
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
1604
+ * such as a product catalog. When you create a site from this template, you inherit this
1605
+ * default product catalog. However, if the template's product catalog is modified,
1606
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
1607
+ * your site remains consistent with what you initially received and does not include any
1608
+ * changes made to the original template afterward.
1609
+ * To ensure this, the TPA on the template gets a new instance_id.
1610
+ */
1611
+ interface ServiceProvisioned {
1612
+ /**
1613
+ * Either UUID or EmbeddedServiceType.
1614
+ * @maxLength 36
1615
+ */
1616
+ appDefId?: string;
1617
+ /**
1618
+ * Not only UUID. Something here could be something weird.
1619
+ * @maxLength 36
1620
+ */
1621
+ instanceId?: string;
1622
+ /**
1623
+ * An instance id from which this instance is originated.
1624
+ * @maxLength 36
1625
+ */
1626
+ originInstanceId?: string;
1627
+ /**
1628
+ * A version.
1629
+ * @maxLength 500
1630
+ */
1631
+ version?: string | null;
1632
+ /**
1633
+ * The origin meta site id
1634
+ * @format GUID
1635
+ */
1636
+ originMetaSiteId?: string | null;
1637
+ }
1638
+ interface ServiceRemoved {
1639
+ /**
1640
+ * Either UUID or EmbeddedServiceType.
1641
+ * @maxLength 36
1642
+ */
1643
+ appDefId?: string;
1644
+ /**
1645
+ * Not only UUID. Something here could be something weird.
1646
+ * @maxLength 36
1647
+ */
1648
+ instanceId?: string;
1649
+ /**
1650
+ * A version.
1651
+ * @maxLength 500
1652
+ */
1653
+ version?: string | null;
1654
+ }
1655
+ /** Rename of the site. Meaning, free public url has been changed as well. */
1656
+ interface SiteRenamed {
1657
+ /**
1658
+ * A new meta site name (URL slug).
1659
+ * @maxLength 20
1660
+ */
1661
+ newSiteName?: string;
1662
+ /**
1663
+ * A previous meta site name (URL slug).
1664
+ * @maxLength 255
1665
+ */
1666
+ oldSiteName?: string;
1667
+ }
1668
+ /**
1669
+ * Hard deletion of the meta site.
1670
+ *
1671
+ * Could not be restored. Therefore it's desirable to cleanup data.
1672
+ */
1673
+ interface SiteHardDeleted {
1674
+ /** A deletion context. */
1675
+ deleteContext?: DeleteContext;
1676
+ }
1677
+ interface NamespaceChanged {
1678
+ /** A previous namespace. */
1679
+ oldNamespace?: NamespaceWithLiterals;
1680
+ /** A new namespace. */
1681
+ newNamespace?: NamespaceWithLiterals;
1682
+ }
1683
+ /** Assigned Studio editor */
1684
+ interface StudioAssigned {
1685
+ }
1686
+ /** Unassigned Studio editor */
1687
+ interface StudioUnassigned {
1688
+ }
1689
+ /**
1690
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
1691
+ *
1692
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
1693
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
1694
+ *
1695
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
1696
+ */
1697
+ interface SiteUrlChanged {
1698
+ }
1699
+ /**
1700
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
1701
+ * Consumed by other teams to remove relevant data.
1702
+ */
1703
+ interface SitePurgedExternally {
1704
+ /**
1705
+ * @maxLength 2048
1706
+ * @maxSize 100
1707
+ * @deprecated
1708
+ * @targetRemovalDate 2025-04-15
1709
+ */
1710
+ appDefId?: string[];
1711
+ }
1712
+ /** Assigned Odeditor */
1713
+ interface OdeditorAssigned {
1714
+ }
1715
+ /** Unassigned Odeditor */
1716
+ interface OdeditorUnassigned {
1717
+ }
1718
+ /** Assigned Picasso editor */
1719
+ interface PicassoAssigned {
1720
+ }
1721
+ /** Unassigned Picasso */
1722
+ interface PicassoUnassigned {
1723
+ }
862
1724
  interface CreateDraftAutomationRequest {
863
1725
  /** Draft automation to create. */
864
1726
  automation?: Automation;
@@ -1075,6 +1937,15 @@ interface ProviderConfigurationError {
1075
1937
  /** Title for the error. */
1076
1938
  title?: string;
1077
1939
  }
1940
+ declare enum ValidationErrorSeverity {
1941
+ UNKNOWN_VALIDATION_ERROR_SEVERITY = "UNKNOWN_VALIDATION_ERROR_SEVERITY",
1942
+ /** Warning. */
1943
+ WARNING = "WARNING",
1944
+ /** Error. */
1945
+ ERROR = "ERROR"
1946
+ }
1947
+ /** @enumType */
1948
+ type ValidationErrorSeverityWithLiterals = ValidationErrorSeverity | 'UNKNOWN_VALIDATION_ERROR_SEVERITY' | 'WARNING' | 'ERROR';
1078
1949
  declare enum Severity {
1079
1950
  UNKNOWN_SEVERITY = "UNKNOWN_SEVERITY",
1080
1951
  /** Low severity error - may affect automation execution. */
@@ -1084,6 +1955,29 @@ declare enum Severity {
1084
1955
  }
1085
1956
  /** @enumType */
1086
1957
  type SeverityWithLiterals = Severity | 'UNKNOWN_SEVERITY' | 'WARNING' | 'CRITICAL';
1958
+ interface ActionValidationInfo {
1959
+ /**
1960
+ * Action ID.
1961
+ * @format GUID
1962
+ */
1963
+ actionId?: string | null;
1964
+ /**
1965
+ * ID of the app that defined the action.
1966
+ * @format GUID
1967
+ */
1968
+ appId?: string;
1969
+ /**
1970
+ * Human-readable action identifier.
1971
+ * @minLength 1
1972
+ * @maxLength 100
1973
+ */
1974
+ actionKey?: string;
1975
+ /**
1976
+ * Action validation errors.
1977
+ * @maxSize 100
1978
+ */
1979
+ validationErrors?: ActionValidationError[];
1980
+ }
1087
1981
  interface ActionValidationError extends ActionValidationErrorErrorOneOf {
1088
1982
  /** Action configuration error. */
1089
1983
  configurationError?: ActionConfigurationError;
@@ -1155,6 +2049,39 @@ declare enum ActionErrorType {
1155
2049
  }
1156
2050
  /** @enumType */
1157
2051
  type ActionErrorTypeWithLiterals = ActionErrorType | 'UNKNOWN_ACTION_ERROR_TYPE' | 'NOT_FOUND' | 'APP_NOT_INSTALLED' | 'INVALID_ACTION_KEY' | 'INVALID_MAPPING' | 'MAPPING_TYPE_MISMATCH' | 'MAPPING_MISSING_REQUIRED_FIELD' | 'MAPPING_SCHEMA_MISMATCH' | 'MAPPING_VARIABLE_MISSING_FROM_SCHEMA' | 'SAMPLE_CODE_RUN_FAILED' | 'POST_ACTION_NOT_FOUND';
2052
+ interface AutomationValidationError extends AutomationValidationErrorErrorOneOf {
2053
+ /** Automation configuration error. */
2054
+ configurationError?: AutomationConfigurationError;
2055
+ /** Provider configuration error. */
2056
+ providerConfigurationError?: ProviderConfigurationError;
2057
+ /** Validation error type. */
2058
+ errorType?: AutomationValidationErrorValidationErrorTypeWithLiterals;
2059
+ /** Validation error severity */
2060
+ errorSeverity?: SeverityWithLiterals;
2061
+ }
2062
+ /** @oneof */
2063
+ interface AutomationValidationErrorErrorOneOf {
2064
+ /** Automation configuration error. */
2065
+ configurationError?: AutomationConfigurationError;
2066
+ /** Provider configuration error. */
2067
+ providerConfigurationError?: ProviderConfigurationError;
2068
+ }
2069
+ declare enum AutomationValidationErrorValidationErrorType {
2070
+ UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
2071
+ CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
2072
+ PROVIDER_ERROR = "PROVIDER_ERROR"
2073
+ }
2074
+ /** @enumType */
2075
+ type AutomationValidationErrorValidationErrorTypeWithLiterals = AutomationValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
2076
+ interface AutomationConfigurationError {
2077
+ /** Automation error type. */
2078
+ errorType?: AutomationErrorTypeWithLiterals;
2079
+ }
2080
+ declare enum AutomationErrorType {
2081
+ UNKNOWN_AUTOMATION_ERROR_TYPE = "UNKNOWN_AUTOMATION_ERROR_TYPE"
2082
+ }
2083
+ /** @enumType */
2084
+ type AutomationErrorTypeWithLiterals = AutomationErrorType | 'UNKNOWN_AUTOMATION_ERROR_TYPE';
1158
2085
  interface ValidateAutomationByIdRequest {
1159
2086
  /**
1160
2087
  * Automation ID.
@@ -1178,6 +2105,155 @@ interface ValidateAutomationByIdResponse {
1178
2105
  */
1179
2106
  actionValidationErrors?: ActionValidationError[];
1180
2107
  }
2108
+ interface GetAutomationActionSchemaRequest {
2109
+ /**
2110
+ * Automation ID.
2111
+ * @format GUID
2112
+ */
2113
+ automationId?: string;
2114
+ /**
2115
+ * Action ID.
2116
+ * @format GUID
2117
+ */
2118
+ actionId?: string;
2119
+ }
2120
+ interface GetAutomationActionSchemaResponse {
2121
+ /** The accumulated payload schema for an action. */
2122
+ schema?: Record<string, any> | null;
2123
+ }
2124
+ interface GetActionsQuotaInfoRequest {
2125
+ }
2126
+ interface GetActionsQuotaInfoResponse {
2127
+ /** Action quotas. */
2128
+ actionProviderQuotaInfo?: ActionProviderQuotaInfo[];
2129
+ }
2130
+ interface ActionProviderQuotaInfo {
2131
+ /**
2132
+ * ID of the app that defined the action.
2133
+ * @format GUID
2134
+ */
2135
+ appId?: string;
2136
+ /**
2137
+ * Action key.
2138
+ * @minLength 1
2139
+ * @maxLength 80
2140
+ */
2141
+ actionKey?: string;
2142
+ /** Action quota information. */
2143
+ actionQuotaInfo?: ActionQuotaInfo;
2144
+ }
2145
+ interface ActionQuotaInfo {
2146
+ /**
2147
+ * Whether the quotas for your action are enforced. If you mark this as `true` in the response body,
2148
+ * Wix displays the information in the quota object on the site dashboard. If you mark this as `false` for
2149
+ * a user, Wix does not display any quota info on the site dashboard for your service.
2150
+ */
2151
+ enforced?: boolean;
2152
+ /**
2153
+ * The plans your service provides, together with the quotas enforced by each plan. A site may be enrolled
2154
+ * in multiple plans. Plans and quotas can be related as follows:
2155
+ *
2156
+ * + A single plan has a single quota.
2157
+ * + A single plan has multiple quotas.
2158
+ * + Multiple plans are associated with multiple quotas.
2159
+ *
2160
+ * Plans and quotas that are related should be grouped together in a single `quotaInfo`
2161
+ * object.
2162
+ */
2163
+ quotaInfo?: QuotaInfo[];
2164
+ }
2165
+ interface QuotaInfo {
2166
+ /** List of plans associated with the site making the request. */
2167
+ plans?: Plan[];
2168
+ /**
2169
+ * List of quotas associated with the plans the site is enrolled in.
2170
+ * @minSize 1
2171
+ */
2172
+ quotas?: Quota[];
2173
+ /**
2174
+ * Details for an upgrade call-to-action button.
2175
+ * Displayed in the Wix user’s site dashboard together with the quota details.
2176
+ */
2177
+ upgradeCta?: UpgradeCTA;
2178
+ }
2179
+ interface Plan {
2180
+ /** Plan ID defined by the action provider. */
2181
+ id?: string;
2182
+ /** Plan name to display in the Wix user’s site dashboard. */
2183
+ name?: string;
2184
+ }
2185
+ interface Quota {
2186
+ /**
2187
+ * Name of the feature the quota is related to. For example, "Messages sent".
2188
+ * @minLength 1
2189
+ */
2190
+ featureName?: string;
2191
+ /**
2192
+ * Quota renewal date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
2193
+ * For example, 10 July 2020 at 15:00 is written as `2020-07-10 15:00:00.000`.
2194
+ */
2195
+ renewalDate?: Date | null;
2196
+ /** The user's current quota usage. */
2197
+ currentUsage?: string;
2198
+ /** Quota limit data. */
2199
+ limit?: string | null;
2200
+ /** Additional information about the quota. Displayed as a tooltip in the Wix user’s dashboard. */
2201
+ additionalInfo?: AdditionalInfo;
2202
+ }
2203
+ interface CTA {
2204
+ /**
2205
+ * Call-to-action redirect URL.
2206
+ * @minLength 1
2207
+ */
2208
+ url?: string;
2209
+ /**
2210
+ * Call-to-action label.
2211
+ * @minLength 1
2212
+ */
2213
+ label?: string;
2214
+ }
2215
+ interface AdditionalInfo {
2216
+ /**
2217
+ * Tooltip content.
2218
+ * @minLength 1
2219
+ */
2220
+ description?: string;
2221
+ /** Details for an options call-to-action link that appears in the tooltip. */
2222
+ cta?: CTA;
2223
+ }
2224
+ interface UpgradeCTA {
2225
+ /**
2226
+ * CTA button redirect URL.
2227
+ * @minLength 1
2228
+ */
2229
+ url?: string;
2230
+ /**
2231
+ * CTA button label.
2232
+ * @minLength 1
2233
+ */
2234
+ label?: string;
2235
+ }
2236
+ interface MigrateVeloActionAutomationsRequest {
2237
+ /** @format GUID */
2238
+ oldAppId?: string;
2239
+ /** @format GUID */
2240
+ newAppId?: string;
2241
+ /** @format GUID */
2242
+ newComponentId?: string;
2243
+ }
2244
+ interface MigrateVeloActionAutomationsResponse {
2245
+ }
2246
+ interface MergeOverridePreinstalledWithRuntimeVersionRequest {
2247
+ /**
2248
+ * ID of the override preinstalled automation to merge.
2249
+ * @format GUID
2250
+ */
2251
+ automationId?: string;
2252
+ }
2253
+ interface MergeOverridePreinstalledWithRuntimeVersionResponse {
2254
+ /** The merged automation after applying the latest runtime version of the preinstalled automation. */
2255
+ automation?: Automation;
2256
+ }
1181
2257
  interface GetAutomationRevisionRequest {
1182
2258
  /**
1183
2259
  * Automation ID.
@@ -1247,4 +2323,4 @@ declare function getAutomationRevision(): __PublicMethodMetaInfo<'GET', {
1247
2323
  automationId: string;
1248
2324
  }, GetAutomationRevisionRequest$1, GetAutomationRevisionRequest, GetAutomationRevisionResponse$1, GetAutomationRevisionResponse>;
1249
2325
 
1250
- export { type __PublicMethodMetaInfo, bulkCountAutomationsWithDrafts, bulkDeleteAutomations, copyAutomation, createAutomation, createDraftAutomation, deleteAutomation, deleteDraftAutomation, generatePreinstalledAutomation, getAggregatedUsageInfo, getAutomation, getAutomationRevision, getOrCreateDraftAutomation, publishDraftAutomation, queryAutomations, queryAutomationsWithDrafts, updateAutomation, updateDraftAutomation, validateAutomation, validateAutomationById };
2326
+ export { type ActionConfigurationError as ActionConfigurationErrorOriginal, ActionErrorType as ActionErrorTypeOriginal, type ActionErrorTypeWithLiterals as ActionErrorTypeWithLiteralsOriginal, type ActionEvent as ActionEventOriginal, type ActionInfoOneOf as ActionInfoOneOfOriginal, type Action as ActionOriginal, type ActionProviderQuotaInfo as ActionProviderQuotaInfoOriginal, type ActionQuotaInfo as ActionQuotaInfoOriginal, type ActionSettings as ActionSettingsOriginal, type ActionUsageSummary as ActionUsageSummaryOriginal, type ActionValidationErrorErrorOneOf as ActionValidationErrorErrorOneOfOriginal, type ActionValidationError as ActionValidationErrorOriginal, type ActionValidationInfo as ActionValidationInfoOriginal, type AdditionalInfo as AdditionalInfoOriginal, type AppDefinedAction as AppDefinedActionOriginal, type ApplicationError as ApplicationErrorOriginal, type ApplicationOrigin as ApplicationOriginOriginal, type Asset as AssetOriginal, type AuditInfoIdOneOf as AuditInfoIdOneOfOriginal, type AuditInfo as AuditInfoOriginal, type AutoArchivePolicy as AutoArchivePolicyOriginal, type AutomationConfigurationError as AutomationConfigurationErrorOriginal, type AutomationConfiguration as AutomationConfigurationOriginal, AutomationErrorType as AutomationErrorTypeOriginal, type AutomationErrorTypeWithLiterals as AutomationErrorTypeWithLiteralsOriginal, type AutomationOriginInfoOneOf as AutomationOriginInfoOneOfOriginal, type Automation as AutomationOriginal, type AutomationSettings as AutomationSettingsOriginal, type AutomationValidationErrorErrorOneOf as AutomationValidationErrorErrorOneOfOriginal, type AutomationValidationError as AutomationValidationErrorOriginal, AutomationValidationErrorValidationErrorType as AutomationValidationErrorValidationErrorTypeOriginal, type AutomationValidationErrorValidationErrorTypeWithLiterals as AutomationValidationErrorValidationErrorTypeWithLiteralsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCountAutomationsWithDraftsRequest as BulkCountAutomationsWithDraftsRequestOriginal, type BulkCountAutomationsWithDraftsResponse as BulkCountAutomationsWithDraftsResponseOriginal, type BulkDeleteAutomationsRequest as BulkDeleteAutomationsRequestOriginal, type BulkDeleteAutomationsResponse as BulkDeleteAutomationsResponseOriginal, type BulkDeleteResult as BulkDeleteResultOriginal, type CTA as CTAOriginal, type CodeConditionAction as CodeConditionActionOriginal, type CodeSnippet as CodeSnippetOriginal, type ConditionAction as ConditionActionOriginal, type ConditionExpressionGroup as ConditionExpressionGroupOriginal, type CopyAutomationRequest as CopyAutomationRequestOriginal, type CopyAutomationResponse as CopyAutomationResponseOriginal, type CreateAutomationRequest as CreateAutomationRequestOriginal, type CreateAutomationResponse as CreateAutomationResponseOriginal, type CreateDraftAutomationRequest as CreateDraftAutomationRequestOriginal, type CreateDraftAutomationResponse as CreateDraftAutomationResponseOriginal, type CreatePreinstalledAutomationRequest as CreatePreinstalledAutomationRequestOriginal, type CreatePreinstalledAutomationResponse as CreatePreinstalledAutomationResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DelayAction as DelayActionOriginal, type DeleteAutomationRequest as DeleteAutomationRequestOriginal, type DeleteAutomationResponse as DeleteAutomationResponseOriginal, type DeleteContext as DeleteContextOriginal, type DeleteDraftAutomationRequest as DeleteDraftAutomationRequestOriginal, type DeleteDraftAutomationResponse as DeleteDraftAutomationResponseOriginal, type DeletePreinstalledAutomationRequest as DeletePreinstalledAutomationRequestOriginal, type DeletePreinstalledAutomationResponse as DeletePreinstalledAutomationResponseOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeletedWithEntity as DeletedWithEntityOriginal, type Dimensions as DimensionsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, Domain as DomainOriginal, type DomainWithLiterals as DomainWithLiteralsOriginal, type DraftInfo as DraftInfoOriginal, type DraftPublished as DraftPublishedOriginal, type DraftsInfo as DraftsInfoOriginal, type Empty as EmptyOriginal, type Enrichment as EnrichmentOriginal, type Enrichments as EnrichmentsOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type Filter as FilterOriginal, type FilterValueSelection as FilterValueSelectionOriginal, type FilterableAppDefinedActions as FilterableAppDefinedActionsOriginal, type FutureDateActivationOffset as FutureDateActivationOffsetOriginal, type GeneratePreinstalledAutomationRequest as GeneratePreinstalledAutomationRequestOriginal, type GeneratePreinstalledAutomationResponse as GeneratePreinstalledAutomationResponseOriginal, type GetActionsQuotaInfoRequest as GetActionsQuotaInfoRequestOriginal, type GetActionsQuotaInfoResponse as GetActionsQuotaInfoResponseOriginal, type GetAggregatedUsageInfoRequest as GetAggregatedUsageInfoRequestOriginal, type GetAggregatedUsageInfoResponse as GetAggregatedUsageInfoResponseOriginal, type GetAutomationActionSchemaRequest as GetAutomationActionSchemaRequestOriginal, type GetAutomationActionSchemaResponse as GetAutomationActionSchemaResponseOriginal, type GetAutomationRequest as GetAutomationRequestOriginal, type GetAutomationResponse as GetAutomationResponseOriginal, type GetAutomationRevisionRequest as GetAutomationRevisionRequestOriginal, type GetAutomationRevisionResponse as GetAutomationRevisionResponseOriginal, type GetOrCreateDraftAutomationRequest as GetOrCreateDraftAutomationRequestOriginal, type GetOrCreateDraftAutomationResponse as GetOrCreateDraftAutomationResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, Language as LanguageOriginal, type LanguageWithLiterals as LanguageWithLiteralsOriginal, type MergeOverridePreinstalledWithRuntimeVersionRequest as MergeOverridePreinstalledWithRuntimeVersionRequestOriginal, type MergeOverridePreinstalledWithRuntimeVersionResponse as MergeOverridePreinstalledWithRuntimeVersionResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type MigrateVeloActionAutomationsRequest as MigrateVeloActionAutomationsRequestOriginal, type MigrateVeloActionAutomationsResponse as MigrateVeloActionAutomationsResponseOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type Note as NoteOriginal, type Notes as NotesOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type Offset as OffsetOriginal, Operator as OperatorOriginal, type OperatorWithLiterals as OperatorWithLiteralsOriginal, type OriginAutomationInfo as OriginAutomationInfoOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OutputAction as OutputActionOriginal, type Path as PathOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type Plan as PlanOriginal, type Position as PositionOriginal, type PreinstalledAutomationSpecInfo as PreinstalledAutomationSpecInfoOriginal, type PreinstalledOrigin as PreinstalledOriginOriginal, type ProviderConfigurationError as ProviderConfigurationErrorOriginal, type PublishDraftAutomationRequest as PublishDraftAutomationRequestOriginal, type PublishDraftAutomationResponse as PublishDraftAutomationResponseOriginal, type QueryAutomationsRequest as QueryAutomationsRequestOriginal, type QueryAutomationsResponse as QueryAutomationsResponseOriginal, type QueryAutomationsWithDraftsRequest as QueryAutomationsWithDraftsRequestOriginal, type QueryAutomationsWithDraftsResponse as QueryAutomationsWithDraftsResponseOriginal, type QueryPreinstalledAutomationsForAppRequest as QueryPreinstalledAutomationsForAppRequestOriginal, type QueryPreinstalledAutomationsForAppResponse as QueryPreinstalledAutomationsForAppResponseOriginal, type QueryPreinstalledAutomationsRequest as QueryPreinstalledAutomationsRequestOriginal, type QueryPreinstalledAutomationsResponse as QueryPreinstalledAutomationsResponseOriginal, type QuotaInfo as QuotaInfoOriginal, type Quota as QuotaOriginal, type RateLimitAction as RateLimitActionOriginal, type RateLimit as RateLimitOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetVariablesAction as SetVariablesActionOriginal, Severity as SeverityOriginal, type SeverityWithLiterals as SeverityWithLiteralsOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SplitAction as SplitActionOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, TimeUnit as TimeUnitOriginal, type TimeUnitWithLiterals as TimeUnitWithLiteralsOriginal, type TriggerConfigurationError as TriggerConfigurationErrorOriginal, TriggerErrorType as TriggerErrorTypeOriginal, type TriggerErrorTypeWithLiterals as TriggerErrorTypeWithLiteralsOriginal, type Trigger as TriggerOriginal, type TriggerUsageSummary as TriggerUsageSummaryOriginal, type TriggerValidationErrorErrorOneOf as TriggerValidationErrorErrorOneOfOriginal, type TriggerValidationError as TriggerValidationErrorOriginal, TriggerValidationErrorValidationErrorType as TriggerValidationErrorValidationErrorTypeOriginal, type TriggerValidationErrorValidationErrorTypeWithLiterals as TriggerValidationErrorValidationErrorTypeWithLiteralsOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdateAutomationRequest as UpdateAutomationRequestOriginal, type UpdateAutomationResponse as UpdateAutomationResponseOriginal, type UpdateDraftAutomationRequest as UpdateDraftAutomationRequestOriginal, type UpdateDraftAutomationResponse as UpdateDraftAutomationResponseOriginal, type UpdatePreinstalledAutomationRequest as UpdatePreinstalledAutomationRequestOriginal, type UpdatePreinstalledAutomationResponse as UpdatePreinstalledAutomationResponseOriginal, type UpdatedWithPreviousEntity as UpdatedWithPreviousEntityOriginal, type UpgradeCTA as UpgradeCTAOriginal, type ValidateAutomationByIdRequest as ValidateAutomationByIdRequestOriginal, type ValidateAutomationByIdResponse as ValidateAutomationByIdResponseOriginal, type ValidateAutomationRequest as ValidateAutomationRequestOriginal, type ValidateAutomationResponse as ValidateAutomationResponseOriginal, ValidationErrorSeverity as ValidationErrorSeverityOriginal, type ValidationErrorSeverityWithLiterals as ValidationErrorSeverityWithLiteralsOriginal, ValidationErrorType as ValidationErrorTypeOriginal, type ValidationErrorTypeWithLiterals as ValidationErrorTypeWithLiteralsOriginal, ValidationResultStatus as ValidationResultStatusOriginal, type ValidationResultStatusWithLiterals as ValidationResultStatusWithLiteralsOriginal, type ValidationSettings as ValidationSettingsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCountAutomationsWithDrafts, bulkDeleteAutomations, copyAutomation, createAutomation, createDraftAutomation, deleteAutomation, deleteDraftAutomation, generatePreinstalledAutomation, getAggregatedUsageInfo, getAutomation, getAutomationRevision, getOrCreateDraftAutomation, publishDraftAutomation, queryAutomations, queryAutomationsWithDrafts, updateAutomation, updateDraftAutomation, validateAutomation, validateAutomationById };