@wix/auto_sdk_standalone-forms_standalone-forms 1.0.0

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.
@@ -0,0 +1,1343 @@
1
+ import { GetOrCreateFormStandaloneMetaSiteRequest as GetOrCreateFormStandaloneMetaSiteRequest$1, GetOrCreateFormStandaloneMetaSiteResponse as GetOrCreateFormStandaloneMetaSiteResponse$1, CreateStandaloneFormRequest as CreateStandaloneFormRequest$1, CreateStandaloneFormResponse as CreateStandaloneFormResponse$1, GetStandaloneFormRequest as GetStandaloneFormRequest$1, GetStandaloneFormResponse as GetStandaloneFormResponse$1, DeleteStandaloneFormRequest as DeleteStandaloneFormRequest$1, DeleteStandaloneFormResponse as DeleteStandaloneFormResponse$1, RemoveStandaloneFormFromTrashBinRequest as RemoveStandaloneFormFromTrashBinRequest$1, RemoveStandaloneFormFromTrashBinResponse as RemoveStandaloneFormFromTrashBinResponse$1, RestoreStandaloneFormFromTrashBinRequest as RestoreStandaloneFormFromTrashBinRequest$1, RestoreStandaloneFormFromTrashBinResponse as RestoreStandaloneFormFromTrashBinResponse$1, GetDeletedStandaloneFormRequest as GetDeletedStandaloneFormRequest$1, GetDeletedStandaloneFormResponse as GetDeletedStandaloneFormResponse$1, ListDeletedStandaloneFormsRequest as ListDeletedStandaloneFormsRequest$1, ListDeletedStandaloneFormsResponse as ListDeletedStandaloneFormsResponse$1, QueryStandaloneFormsRequest as QueryStandaloneFormsRequest$1, QueryStandaloneFormsResponse as QueryStandaloneFormsResponse$1, GetSitePropertiesRequest as GetSitePropertiesRequest$1, GetSitePropertiesResponse as GetSitePropertiesResponse$1 } from './index.typings.js';
2
+ import '@wix/sdk-types';
3
+
4
+ interface StandaloneForm {
5
+ /**
6
+ * Standalone form ID. Automatically generated when the standalone form is created.
7
+ *
8
+ * Together with `accountSlug`, this ID forms part of the standalone form's public URL.
9
+ * @maxLength 36
10
+ * @readonly
11
+ */
12
+ id?: string | null;
13
+ /**
14
+ * ID of the form, managed through the Wix Forms API, that this record marks as standalone.
15
+ *
16
+ * A form doesn't itself indicate whether it's standalone. The existence of a standalone form
17
+ * record that references it is what makes the form standalone.
18
+ * @format GUID
19
+ */
20
+ formId?: string | null;
21
+ /**
22
+ * ID of the meta site that owns the standalone form.
23
+ *
24
+ * The meta site owns the form. Because this service doesn't use meta site tenancy, the owning
25
+ * meta site is stored explicitly in this field. Set from the calling context when the form is created.
26
+ * @format GUID
27
+ * @readonly
28
+ */
29
+ metaSiteId?: string | null;
30
+ /**
31
+ * Date and time the standalone form was created.
32
+ * @readonly
33
+ */
34
+ createdDate?: Date | null;
35
+ /**
36
+ * Date and time the standalone form was last updated.
37
+ * @readonly
38
+ */
39
+ updatedDate?: Date | null;
40
+ /**
41
+ * Account slug of the site owner, captured when the standalone form was created.
42
+ *
43
+ * Together with `id`, the slug forms part of the standalone form's public URL. May be empty
44
+ * if it couldn't be resolved at creation time.
45
+ * @maxLength 50
46
+ * @readonly
47
+ */
48
+ accountSlug?: string | null;
49
+ }
50
+ interface GetOrCreateFormStandaloneMetaSiteRequest {
51
+ }
52
+ interface GetOrCreateFormStandaloneMetaSiteResponse {
53
+ /**
54
+ * MetaSiteId
55
+ * @format GUID
56
+ */
57
+ metaSiteId?: string;
58
+ }
59
+ interface CreateStandaloneFormRequest {
60
+ /** Standalone form */
61
+ standaloneForm: StandaloneForm;
62
+ }
63
+ interface CreateStandaloneFormResponse {
64
+ /** Standalone form */
65
+ standaloneForm?: StandaloneForm;
66
+ }
67
+ interface GetStandaloneFormRequest {
68
+ /**
69
+ * Standalone form id
70
+ * @maxLength 36
71
+ */
72
+ standaloneFormId: string;
73
+ }
74
+ interface GetStandaloneFormResponse {
75
+ /** Standalone form */
76
+ standaloneForm?: StandaloneForm;
77
+ }
78
+ interface DeleteStandaloneFormRequest {
79
+ /**
80
+ * Standalone form id
81
+ * @maxLength 36
82
+ */
83
+ standaloneFormId: string;
84
+ /**
85
+ * Whether to permanently delete a standalone form bypassing the trash bin.
86
+ *
87
+ * Default: `false`
88
+ */
89
+ permanent?: boolean;
90
+ }
91
+ interface DeleteStandaloneFormResponse {
92
+ }
93
+ interface RemoveStandaloneFormFromTrashBinRequest {
94
+ /**
95
+ * Standalone form id
96
+ * @maxLength 36
97
+ */
98
+ standaloneFormId: string;
99
+ }
100
+ interface RemoveStandaloneFormFromTrashBinResponse {
101
+ }
102
+ interface RestoreStandaloneFormFromTrashBinRequest {
103
+ /**
104
+ * Standalone form id
105
+ * @maxLength 36
106
+ */
107
+ standaloneFormId: string;
108
+ }
109
+ interface RestoreStandaloneFormFromTrashBinResponse {
110
+ /** Standalone form */
111
+ standaloneForm?: StandaloneForm;
112
+ }
113
+ interface GetDeletedStandaloneFormRequest {
114
+ /**
115
+ * Standalone form id
116
+ * @maxLength 36
117
+ */
118
+ standaloneFormId: string;
119
+ }
120
+ interface GetDeletedStandaloneFormResponse {
121
+ /** Standalone form */
122
+ standaloneForm?: StandaloneForm;
123
+ }
124
+ interface ListDeletedStandaloneFormsRequest {
125
+ /**
126
+ * Standalone Form ids.
127
+ * @maxSize 100
128
+ * @maxLength 36
129
+ */
130
+ standaloneFormIds?: string[];
131
+ /** Cursor token pointing to a page of results. Not used in the first request. */
132
+ paging?: CursorPaging;
133
+ }
134
+ interface CursorPaging {
135
+ /**
136
+ * Number of items to load.
137
+ * @max 100
138
+ */
139
+ limit?: number | null;
140
+ /**
141
+ * Pointer to the next or previous page in the list of results.
142
+ *
143
+ * You can get the relevant cursor token
144
+ * from the `pagingMetadata` object in the previous call's response.
145
+ * Not relevant for the first request.
146
+ * @maxLength 16000
147
+ */
148
+ cursor?: string | null;
149
+ }
150
+ interface ListDeletedStandaloneFormsResponse {
151
+ /**
152
+ * The retrieved standalone forms
153
+ * @maxSize 100
154
+ */
155
+ standaloneForms?: StandaloneForm[];
156
+ /** Details on the paged set of results returned. */
157
+ pagingMetadata?: CursorPagingMetadata;
158
+ }
159
+ interface CursorPagingMetadata {
160
+ /** Number of items returned in the response. */
161
+ count?: number | null;
162
+ /** Offset that was requested. */
163
+ cursors?: Cursors;
164
+ /**
165
+ * Indicates if there are more results after the current page.
166
+ * If `true`, another page of results can be retrieved.
167
+ * If `false`, this is the last page.
168
+ */
169
+ hasNext?: boolean | null;
170
+ }
171
+ interface Cursors {
172
+ /**
173
+ * Cursor pointing to next page in the list of results.
174
+ * @maxLength 16000
175
+ */
176
+ next?: string | null;
177
+ /**
178
+ * Cursor pointing to previous page in the list of results.
179
+ * @maxLength 16000
180
+ */
181
+ prev?: string | null;
182
+ }
183
+ interface QueryStandaloneFormsRequest {
184
+ /** WQL expression. */
185
+ query: CursorQuery;
186
+ }
187
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
188
+ /** 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`. */
189
+ cursorPaging?: CursorPaging;
190
+ /**
191
+ * Filter object in the following format:
192
+ * `"filter" : {
193
+ * "fieldName1": "value1",
194
+ * "fieldName2":{"$operator":"value2"}
195
+ * }`
196
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
197
+ */
198
+ filter?: Record<string, any> | null;
199
+ /**
200
+ * Sort object in the following format:
201
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
202
+ * @maxSize 3
203
+ */
204
+ sort?: Sorting[];
205
+ }
206
+ /** @oneof */
207
+ interface CursorQueryPagingMethodOneOf {
208
+ /** 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`. */
209
+ cursorPaging?: CursorPaging;
210
+ }
211
+ interface Sorting {
212
+ /**
213
+ * Name of the field to sort by.
214
+ * @maxLength 512
215
+ */
216
+ fieldName?: string;
217
+ /** Sort order. */
218
+ order?: SortOrderWithLiterals;
219
+ }
220
+ declare enum SortOrder {
221
+ ASC = "ASC",
222
+ DESC = "DESC"
223
+ }
224
+ /** @enumType */
225
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
226
+ interface QueryStandaloneFormsResponse {
227
+ /**
228
+ * The retrieved standalone forms
229
+ * @maxSize 100
230
+ */
231
+ standaloneForms?: StandaloneForm[];
232
+ /** Details on the paged set of results returned. */
233
+ metadata?: CursorPagingMetadata;
234
+ }
235
+ interface GetSitePropertiesRequest {
236
+ }
237
+ interface GetSitePropertiesResponse {
238
+ /** Standalone MetaSite properties */
239
+ siteProperties?: StandaloneMetaSiteProperties;
240
+ }
241
+ interface StandaloneMetaSiteProperties {
242
+ /** Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
243
+ paymentCurrency?: string | null;
244
+ /**
245
+ * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
246
+ *
247
+ * Empty if the site's locale isn't set.
248
+ * @maxLength 2
249
+ */
250
+ localeLanguageCode?: string;
251
+ /**
252
+ * Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
253
+ *
254
+ * Empty if the site's locale isn't set.
255
+ * @maxLength 2
256
+ */
257
+ localeCountry?: string;
258
+ }
259
+ /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
260
+ interface SitePropertiesNotification {
261
+ /** The site ID for which this update notification applies. */
262
+ metasiteId?: string;
263
+ /** The actual update event. */
264
+ event?: SitePropertiesEvent;
265
+ /**
266
+ * A convenience set of mappings from the MetaSite ID to its constituent services.
267
+ * @maxSize 500
268
+ */
269
+ translations?: Translation[];
270
+ /** Context of the notification */
271
+ changeContext?: ChangeContext;
272
+ }
273
+ /** The actual update event for a particular notification. */
274
+ interface SitePropertiesEvent {
275
+ /** Version of the site's properties represented by this update. */
276
+ version?: number;
277
+ /** Set of properties that were updated - corresponds to the fields in "properties". */
278
+ fields?: string[];
279
+ /** Updated properties. */
280
+ properties?: Properties;
281
+ }
282
+ interface Properties {
283
+ /** Site categories. */
284
+ categories?: Categories;
285
+ /** Site locale. */
286
+ locale?: Locale;
287
+ /**
288
+ * Site language.
289
+ *
290
+ * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
291
+ */
292
+ language?: string | null;
293
+ /**
294
+ * Site currency used to bill customers.
295
+ *
296
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
297
+ */
298
+ paymentCurrency?: string | null;
299
+ /** Site time zone in IANA time zone database format. For example, `America/New_York`. */
300
+ timeZone?: string | null;
301
+ /** Email address. */
302
+ email?: string | null;
303
+ /** Phone number. */
304
+ phone?: string | null;
305
+ /** Fax number. */
306
+ fax?: string | null;
307
+ /** Address. */
308
+ address?: Address;
309
+ /** Site display name. */
310
+ siteDisplayName?: string | null;
311
+ /** Business name. */
312
+ businessName?: string | null;
313
+ /** Path to the site's logo in Wix Media (without Wix Media base URL). */
314
+ logo?: string | null;
315
+ /** Site description. */
316
+ description?: string | null;
317
+ /**
318
+ * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
319
+ *
320
+ * __Note:__ Not supported by Wix Bookings.
321
+ */
322
+ businessSchedule?: BusinessSchedule;
323
+ /** Supported languages of a site and the primary language. */
324
+ multilingual?: Multilingual;
325
+ /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
326
+ consentPolicy?: ConsentPolicy;
327
+ /**
328
+ * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
329
+ *
330
+ * Site business type.
331
+ */
332
+ businessConfig?: string | null;
333
+ /** External site URL that uses Wix as its headless business solution. */
334
+ externalSiteUrl?: string | null;
335
+ /** Track clicks analytics. */
336
+ trackClicksAnalytics?: boolean;
337
+ /**
338
+ * Company ID issued to the business by local authorities. Appears on invoices and price quotes.
339
+ * @maxLength 50
340
+ */
341
+ companyId?: string | null;
342
+ }
343
+ interface Categories {
344
+ /** Primary site category. */
345
+ primary?: string;
346
+ /**
347
+ * Secondary site category.
348
+ * @maxSize 50
349
+ */
350
+ secondary?: string[];
351
+ /** Business Term Id */
352
+ businessTermId?: string | null;
353
+ }
354
+ interface Locale {
355
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
356
+ languageCode?: string;
357
+ /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
358
+ country?: string;
359
+ }
360
+ interface Address {
361
+ /** Street name. */
362
+ street?: string;
363
+ /** City name. */
364
+ city?: string;
365
+ /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
366
+ country?: string;
367
+ /** State. */
368
+ state?: string;
369
+ /**
370
+ * Zip or postal code.
371
+ * @maxLength 20
372
+ */
373
+ zip?: string;
374
+ /** Extra information to be displayed in the address. */
375
+ hint?: AddressHint;
376
+ /** Whether this address represents a physical location. */
377
+ isPhysical?: boolean;
378
+ /** Google-formatted version of this address. */
379
+ googleFormattedAddress?: string;
380
+ /** Street number. */
381
+ streetNumber?: string;
382
+ /** Apartment number. */
383
+ apartmentNumber?: string;
384
+ /** Geographic coordinates of location. */
385
+ coordinates?: GeoCoordinates;
386
+ }
387
+ /**
388
+ * Extra information on displayed addresses.
389
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
390
+ * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
391
+ */
392
+ interface AddressHint {
393
+ /** Extra text displayed next to, or instead of, the actual address. */
394
+ text?: string;
395
+ /** Where the extra text should be displayed. */
396
+ placement?: PlacementTypeWithLiterals;
397
+ }
398
+ /** Where the extra text should be displayed: before, after or instead of the actual address. */
399
+ declare enum PlacementType {
400
+ BEFORE = "BEFORE",
401
+ AFTER = "AFTER",
402
+ REPLACE = "REPLACE"
403
+ }
404
+ /** @enumType */
405
+ type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
406
+ /** Geocoordinates for a particular address. */
407
+ interface GeoCoordinates {
408
+ /** Latitude of the location. Must be between -90 and 90. */
409
+ latitude?: number;
410
+ /** Longitude of the location. Must be between -180 and 180. */
411
+ longitude?: number;
412
+ }
413
+ /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
414
+ interface BusinessSchedule {
415
+ /**
416
+ * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
417
+ * @maxSize 100
418
+ */
419
+ periods?: TimePeriod[];
420
+ /**
421
+ * Exceptions to the business's regular hours. The business can be open or closed during the exception.
422
+ * @maxSize 100
423
+ */
424
+ specialHourPeriod?: SpecialHourPeriod[];
425
+ }
426
+ /** Weekly recurring time periods when the business is regularly open or the service is available. */
427
+ interface TimePeriod {
428
+ /** Day of the week the period starts on. */
429
+ openDay?: DayOfWeekWithLiterals;
430
+ /**
431
+ * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
432
+ * midnight at the end of the specified day.
433
+ */
434
+ openTime?: string;
435
+ /** Day of the week the period ends on. */
436
+ closeDay?: DayOfWeekWithLiterals;
437
+ /**
438
+ * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
439
+ * midnight at the end of the specified day.
440
+ *
441
+ * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
442
+ */
443
+ closeTime?: string;
444
+ }
445
+ /** Enumerates the days of the week. */
446
+ declare enum DayOfWeek {
447
+ MONDAY = "MONDAY",
448
+ TUESDAY = "TUESDAY",
449
+ WEDNESDAY = "WEDNESDAY",
450
+ THURSDAY = "THURSDAY",
451
+ FRIDAY = "FRIDAY",
452
+ SATURDAY = "SATURDAY",
453
+ SUNDAY = "SUNDAY"
454
+ }
455
+ /** @enumType */
456
+ type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
457
+ /** Exception to the business's regular hours. The business can be open or closed during the exception. */
458
+ interface SpecialHourPeriod {
459
+ /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
460
+ startDate?: string;
461
+ /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
462
+ endDate?: string;
463
+ /**
464
+ * Whether the business is closed (or the service is not available) during the exception.
465
+ *
466
+ * Default: `true`.
467
+ */
468
+ isClosed?: boolean;
469
+ /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
470
+ comment?: string;
471
+ }
472
+ interface Multilingual {
473
+ /**
474
+ * Supported languages list.
475
+ * @maxSize 200
476
+ */
477
+ supportedLanguages?: SupportedLanguage[];
478
+ /** Whether to redirect to user language. */
479
+ autoRedirect?: boolean;
480
+ }
481
+ interface SupportedLanguage {
482
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
483
+ languageCode?: string;
484
+ /** Locale. */
485
+ locale?: Locale;
486
+ /** Whether the supported language is the primary language for the site. */
487
+ isPrimary?: boolean;
488
+ /** Language icon. */
489
+ countryCode?: string;
490
+ /** How the language will be resolved. For internal use. */
491
+ resolutionMethod?: ResolutionMethodWithLiterals;
492
+ /** Whether the supported language is the primary language for site visitors. */
493
+ isVisitorPrimary?: boolean | null;
494
+ }
495
+ declare enum ResolutionMethod {
496
+ QUERY_PARAM = "QUERY_PARAM",
497
+ SUBDOMAIN = "SUBDOMAIN",
498
+ SUBDIRECTORY = "SUBDIRECTORY"
499
+ }
500
+ /** @enumType */
501
+ type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
502
+ interface ConsentPolicy {
503
+ /** Whether the site uses cookies that are essential to site operation. Always `true`. */
504
+ essential?: boolean | null;
505
+ /** Whether the site uses cookies that affect site performance and other functional measurements. */
506
+ functional?: boolean | null;
507
+ /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
508
+ analytics?: boolean | null;
509
+ /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
510
+ advertising?: boolean | null;
511
+ /** CCPA compliance flag. */
512
+ dataToThirdParty?: boolean | null;
513
+ }
514
+ /** A single mapping from the MetaSite ID to a particular service. */
515
+ interface Translation {
516
+ /** The service type. */
517
+ serviceType?: string;
518
+ /** The application definition ID; this only applies to services of type ThirdPartyApps. */
519
+ appDefId?: string;
520
+ /** The instance ID of the service. */
521
+ instanceId?: string;
522
+ }
523
+ interface ChangeContext extends ChangeContextPayloadOneOf {
524
+ /** Properties were updated. */
525
+ propertiesChange?: PropertiesChange;
526
+ /** Default properties were created on site creation. */
527
+ siteCreated?: V4SiteCreated;
528
+ /** Properties were cloned on site cloning. */
529
+ siteCloned?: SiteCloned;
530
+ }
531
+ /** @oneof */
532
+ interface ChangeContextPayloadOneOf {
533
+ /** Properties were updated. */
534
+ propertiesChange?: PropertiesChange;
535
+ /** Default properties were created on site creation. */
536
+ siteCreated?: V4SiteCreated;
537
+ /** Properties were cloned on site cloning. */
538
+ siteCloned?: SiteCloned;
539
+ }
540
+ interface PropertiesChange {
541
+ }
542
+ interface V4SiteCreated {
543
+ /** Origin template site id. */
544
+ originTemplateId?: string | null;
545
+ }
546
+ interface SiteCloned {
547
+ /** Origin site id. */
548
+ originMetaSiteId?: string;
549
+ }
550
+ interface Empty {
551
+ }
552
+ interface DomainEvent extends DomainEventBodyOneOf {
553
+ createdEvent?: EntityCreatedEvent;
554
+ updatedEvent?: EntityUpdatedEvent;
555
+ deletedEvent?: EntityDeletedEvent;
556
+ actionEvent?: ActionEvent;
557
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
558
+ id?: string;
559
+ /**
560
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
561
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
562
+ */
563
+ entityFqdn?: string;
564
+ /**
565
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
566
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
567
+ */
568
+ slug?: string;
569
+ /** ID of the entity associated with the event. */
570
+ entityId?: string;
571
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
572
+ eventTime?: Date | null;
573
+ /**
574
+ * Whether the event was triggered as a result of a privacy regulation application
575
+ * (for example, GDPR).
576
+ */
577
+ triggeredByAnonymizeRequest?: boolean | null;
578
+ /** If present, indicates the action that triggered the event. */
579
+ originatedFrom?: string | null;
580
+ /**
581
+ * 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.
582
+ * 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.
583
+ */
584
+ entityEventSequence?: string | null;
585
+ }
586
+ /** @oneof */
587
+ interface DomainEventBodyOneOf {
588
+ createdEvent?: EntityCreatedEvent;
589
+ updatedEvent?: EntityUpdatedEvent;
590
+ deletedEvent?: EntityDeletedEvent;
591
+ actionEvent?: ActionEvent;
592
+ }
593
+ interface EntityCreatedEvent {
594
+ entityAsJson?: string;
595
+ /**
596
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
597
+ * @internal
598
+ */
599
+ triggeredByUndelete?: boolean | null;
600
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
601
+ restoreInfo?: RestoreInfo;
602
+ /**
603
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
604
+ * @internal
605
+ */
606
+ additionalMetadataAsJson?: string | null;
607
+ }
608
+ interface RestoreInfo {
609
+ deletedDate?: Date | null;
610
+ }
611
+ interface EntityUpdatedEvent {
612
+ /**
613
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
614
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
615
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
616
+ */
617
+ currentEntityAsJson?: string;
618
+ /**
619
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
620
+ * wont populate it / have any reference to it in the API.
621
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
622
+ * the developer should send only the new (current) entity.
623
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
624
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
625
+ * @internal
626
+ * @deprecated
627
+ */
628
+ previousEntityAsJson?: string | null;
629
+ /**
630
+ * Map of fully qualified field paths to their previous values for fields that changed.
631
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
632
+ * @internal
633
+ */
634
+ modifiedFields?: Record<string, any>;
635
+ /**
636
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
637
+ * @internal
638
+ */
639
+ additionalMetadataAsJson?: string | null;
640
+ }
641
+ interface EntityDeletedEvent {
642
+ /**
643
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
644
+ * @internal
645
+ */
646
+ movedToTrash?: boolean | null;
647
+ /** Entity that was deleted. */
648
+ deletedEntityAsJson?: string | null;
649
+ /**
650
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
651
+ * @internal
652
+ */
653
+ additionalMetadataAsJson?: string | null;
654
+ }
655
+ interface ActionEvent {
656
+ bodyAsJson?: string;
657
+ }
658
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
659
+ /** Emitted on a meta site creation. */
660
+ siteCreated?: SiteCreated;
661
+ /** Emitted on a meta site transfer completion. */
662
+ siteTransferred?: SiteTransferred;
663
+ /** Emitted on a meta site deletion. */
664
+ siteDeleted?: SiteDeleted;
665
+ /** Emitted on a meta site restoration. */
666
+ siteUndeleted?: SiteUndeleted;
667
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
668
+ sitePublished?: SitePublished;
669
+ /** Emitted on a meta site unpublish. */
670
+ siteUnpublished?: SiteUnpublished;
671
+ /** Emitted when meta site is marked as template. */
672
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
673
+ /** Emitted when meta site is marked as a WixSite. */
674
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
675
+ /** Emitted when an application is provisioned (installed). */
676
+ serviceProvisioned?: ServiceProvisioned;
677
+ /** Emitted when an application is removed (uninstalled). */
678
+ serviceRemoved?: ServiceRemoved;
679
+ /** Emitted when meta site name (URL slug) is changed. */
680
+ siteRenamedPayload?: SiteRenamed;
681
+ /** Emitted when meta site was permanently deleted. */
682
+ hardDeleted?: SiteHardDeleted;
683
+ /** Emitted on a namespace change. */
684
+ namespaceChanged?: NamespaceChanged;
685
+ /** Emitted when Studio is attached. */
686
+ studioAssigned?: StudioAssigned;
687
+ /** Emitted when Studio is detached. */
688
+ studioUnassigned?: StudioUnassigned;
689
+ /**
690
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
691
+ * the actual URL.
692
+ *
693
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
694
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
695
+ */
696
+ urlChanged?: SiteUrlChanged;
697
+ /** Site is marked as PurgedExternally */
698
+ sitePurgedExternally?: SitePurgedExternally;
699
+ /** Emitted when Odeditor is attached. */
700
+ odeditorAssigned?: OdeditorAssigned;
701
+ /** Emitted when Odeditor is detached. */
702
+ odeditorUnassigned?: OdeditorUnassigned;
703
+ /** Emitted when Picasso is attached. */
704
+ picassoAssigned?: PicassoAssigned;
705
+ /** Emitted when Picasso is detached. */
706
+ picassoUnassigned?: PicassoUnassigned;
707
+ /** Emitted when Wixel is attached. */
708
+ wixelAssigned?: WixelAssigned;
709
+ /** Emitted when Wixel is detached. */
710
+ wixelUnassigned?: WixelUnassigned;
711
+ /** Emitted when StudioTwo is attached. */
712
+ studioTwoAssigned?: StudioTwoAssigned;
713
+ /** Emitted when StudioTwo is detached. */
714
+ studioTwoUnassigned?: StudioTwoUnassigned;
715
+ /** Emitted when media from user domain is enabled. */
716
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
717
+ /** Emitted when media from user domain is disabled. */
718
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
719
+ /** Emitted when Editorless is attached. */
720
+ editorlessAssigned?: EditorlessAssigned;
721
+ /** Emitted when Editorless is detached. */
722
+ editorlessUnassigned?: EditorlessUnassigned;
723
+ /**
724
+ * A meta site id.
725
+ * @format GUID
726
+ */
727
+ metaSiteId?: string;
728
+ /** A meta site version. Monotonically increasing. */
729
+ version?: string;
730
+ /** A timestamp of the event. */
731
+ timestamp?: string;
732
+ /**
733
+ * TODO(meta-site): Change validation once validations are disabled for consumers
734
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
735
+ * @maxSize 4000
736
+ */
737
+ assets?: Asset[];
738
+ }
739
+ /** @oneof */
740
+ interface MetaSiteSpecialEventPayloadOneOf {
741
+ /** Emitted on a meta site creation. */
742
+ siteCreated?: SiteCreated;
743
+ /** Emitted on a meta site transfer completion. */
744
+ siteTransferred?: SiteTransferred;
745
+ /** Emitted on a meta site deletion. */
746
+ siteDeleted?: SiteDeleted;
747
+ /** Emitted on a meta site restoration. */
748
+ siteUndeleted?: SiteUndeleted;
749
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
750
+ sitePublished?: SitePublished;
751
+ /** Emitted on a meta site unpublish. */
752
+ siteUnpublished?: SiteUnpublished;
753
+ /** Emitted when meta site is marked as template. */
754
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
755
+ /** Emitted when meta site is marked as a WixSite. */
756
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
757
+ /** Emitted when an application is provisioned (installed). */
758
+ serviceProvisioned?: ServiceProvisioned;
759
+ /** Emitted when an application is removed (uninstalled). */
760
+ serviceRemoved?: ServiceRemoved;
761
+ /** Emitted when meta site name (URL slug) is changed. */
762
+ siteRenamedPayload?: SiteRenamed;
763
+ /** Emitted when meta site was permanently deleted. */
764
+ hardDeleted?: SiteHardDeleted;
765
+ /** Emitted on a namespace change. */
766
+ namespaceChanged?: NamespaceChanged;
767
+ /** Emitted when Studio is attached. */
768
+ studioAssigned?: StudioAssigned;
769
+ /** Emitted when Studio is detached. */
770
+ studioUnassigned?: StudioUnassigned;
771
+ /**
772
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
773
+ * the actual URL.
774
+ *
775
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
776
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
777
+ */
778
+ urlChanged?: SiteUrlChanged;
779
+ /** Site is marked as PurgedExternally */
780
+ sitePurgedExternally?: SitePurgedExternally;
781
+ /** Emitted when Odeditor is attached. */
782
+ odeditorAssigned?: OdeditorAssigned;
783
+ /** Emitted when Odeditor is detached. */
784
+ odeditorUnassigned?: OdeditorUnassigned;
785
+ /** Emitted when Picasso is attached. */
786
+ picassoAssigned?: PicassoAssigned;
787
+ /** Emitted when Picasso is detached. */
788
+ picassoUnassigned?: PicassoUnassigned;
789
+ /** Emitted when Wixel is attached. */
790
+ wixelAssigned?: WixelAssigned;
791
+ /** Emitted when Wixel is detached. */
792
+ wixelUnassigned?: WixelUnassigned;
793
+ /** Emitted when StudioTwo is attached. */
794
+ studioTwoAssigned?: StudioTwoAssigned;
795
+ /** Emitted when StudioTwo is detached. */
796
+ studioTwoUnassigned?: StudioTwoUnassigned;
797
+ /** Emitted when media from user domain is enabled. */
798
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
799
+ /** Emitted when media from user domain is disabled. */
800
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
801
+ /** Emitted when Editorless is attached. */
802
+ editorlessAssigned?: EditorlessAssigned;
803
+ /** Emitted when Editorless is detached. */
804
+ editorlessUnassigned?: EditorlessUnassigned;
805
+ }
806
+ interface Asset {
807
+ /**
808
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
809
+ * @maxLength 36
810
+ */
811
+ appDefId?: string;
812
+ /**
813
+ * An instance id. For legacy reasons may be UUID or a string.
814
+ * @maxLength 200
815
+ */
816
+ instanceId?: string;
817
+ /** An application state. */
818
+ state?: StateWithLiterals;
819
+ }
820
+ declare enum State {
821
+ UNKNOWN = "UNKNOWN",
822
+ ENABLED = "ENABLED",
823
+ DISABLED = "DISABLED",
824
+ PENDING = "PENDING",
825
+ DEMO = "DEMO"
826
+ }
827
+ /** @enumType */
828
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
829
+ interface SiteCreated {
830
+ /**
831
+ * A template identifier (empty if not created from a template).
832
+ * @maxLength 36
833
+ */
834
+ originTemplateId?: string;
835
+ /**
836
+ * An account id of the owner.
837
+ * @format GUID
838
+ */
839
+ ownerId?: string;
840
+ /** A context in which meta site was created. */
841
+ context?: SiteCreatedContextWithLiterals;
842
+ /**
843
+ * A meta site id from which this site was created.
844
+ *
845
+ * In case of a creation from a template it's a template id.
846
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
847
+ * @format GUID
848
+ */
849
+ originMetaSiteId?: string | null;
850
+ /**
851
+ * A meta site name (URL slug).
852
+ * @maxLength 20
853
+ */
854
+ siteName?: string;
855
+ /** A namespace. */
856
+ namespace?: NamespaceWithLiterals;
857
+ }
858
+ declare enum SiteCreatedContext {
859
+ /** A valid option, we don't expose all reasons why site might be created. */
860
+ OTHER = "OTHER",
861
+ /** A meta site was created from template. */
862
+ FROM_TEMPLATE = "FROM_TEMPLATE",
863
+ /** A meta site was created by copying of the transfferred meta site. */
864
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
865
+ /** A copy of existing meta site. */
866
+ DUPLICATE = "DUPLICATE",
867
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
868
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
869
+ /** deprecated A meta site was created for Flash editor. */
870
+ FLASH = "FLASH"
871
+ }
872
+ /** @enumType */
873
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
874
+ declare enum Namespace {
875
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
876
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
877
+ WIX = "WIX",
878
+ /** 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. */
879
+ SHOUT_OUT = "SHOUT_OUT",
880
+ /** 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. */
881
+ ALBUMS = "ALBUMS",
882
+ /** 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. */
883
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
884
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
885
+ HOTELS = "HOTELS",
886
+ /** 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. */
887
+ CLUBS = "CLUBS",
888
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
889
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
890
+ /**
891
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
892
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
893
+ */
894
+ DEV_SITE = "DEV_SITE",
895
+ /** 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. */
896
+ LOGOS = "LOGOS",
897
+ /** 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. */
898
+ VIDEO_MAKER = "VIDEO_MAKER",
899
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
900
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
901
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
902
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
903
+ /**
904
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
905
+ *
906
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
907
+ */
908
+ HTML_DRAFT = "HTML_DRAFT",
909
+ /**
910
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
911
+ * Will be accessible from Site List and will not have a website app.
912
+ * Once the user attaches a site, the site will become a regular wixsite.
913
+ */
914
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
915
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
916
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
917
+ /** It is to be used in the Business First efforts. */
918
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
919
+ /** Bookings business flow with no site. */
920
+ ANYWHERE = "ANYWHERE",
921
+ /** Namespace for Headless Backoffice with no editor */
922
+ HEADLESS = "HEADLESS",
923
+ /**
924
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
925
+ * The site will be used for account level CSM feature for enterprise
926
+ */
927
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
928
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
929
+ RISE = "RISE",
930
+ /**
931
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
932
+ * There's a blank site behind the scene but it's blank).
933
+ * The Mobile company will be the owner of this namespace.
934
+ */
935
+ BRANDED_FIRST = "BRANDED_FIRST",
936
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
937
+ NOWNIA = "NOWNIA",
938
+ /**
939
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
940
+ * The Partners company owns this namespace.
941
+ */
942
+ UGC_TEMPLATE = "UGC_TEMPLATE",
943
+ /** Codux Headless Sites */
944
+ CODUX = "CODUX",
945
+ /** Bobb - AI Design Creator. */
946
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
947
+ /**
948
+ * Shared Blog Site is a unique single site across Enterprise account,
949
+ * This site will hold all Blog posts related to the Marketing product.
950
+ */
951
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
952
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
953
+ STANDALONE_FORMS = "STANDALONE_FORMS",
954
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
955
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
956
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
957
+ MIMIR = "MIMIR",
958
+ /** Wix Twins platform. */
959
+ TWINS = "TWINS",
960
+ /** Wix Nano. */
961
+ NANO = "NANO",
962
+ /** Base44 headless sites. */
963
+ BASE44 = "BASE44",
964
+ /** Wix Channels Sites */
965
+ CHANNELS = "CHANNELS",
966
+ /** Nautilus platform. */
967
+ NAUTILUS = "NAUTILUS",
968
+ /**
969
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
970
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
971
+ */
972
+ SYMPHONY = "SYMPHONY",
973
+ /** Nautilus platform app. */
974
+ NAUTILUS_APPS = "NAUTILUS_APPS",
975
+ /**
976
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
977
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
978
+ */
979
+ VIBU = "VIBU",
980
+ /**
981
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
982
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
983
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
984
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
985
+ */
986
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
987
+ /**
988
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
989
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
990
+ */
991
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
992
+ }
993
+ /** @enumType */
994
+ 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' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
995
+ /** Site transferred to another user. */
996
+ interface SiteTransferred {
997
+ /**
998
+ * A previous owner id (user that transfers meta site).
999
+ * @format GUID
1000
+ */
1001
+ oldOwnerId?: string;
1002
+ /**
1003
+ * A new owner id (user that accepts meta site).
1004
+ * @format GUID
1005
+ */
1006
+ newOwnerId?: string;
1007
+ }
1008
+ /** Soft deletion of the meta site. Could be restored. */
1009
+ interface SiteDeleted {
1010
+ /** A deletion context. */
1011
+ deleteContext?: DeleteContext;
1012
+ }
1013
+ interface DeleteContext {
1014
+ /** When the meta site was deleted. */
1015
+ dateDeleted?: Date | null;
1016
+ /** A status. */
1017
+ deleteStatus?: DeleteStatusWithLiterals;
1018
+ /**
1019
+ * A reason (flow).
1020
+ * @maxLength 255
1021
+ */
1022
+ deleteOrigin?: string;
1023
+ /**
1024
+ * A service that deleted it.
1025
+ * @maxLength 255
1026
+ */
1027
+ initiatorId?: string | null;
1028
+ }
1029
+ declare enum DeleteStatus {
1030
+ UNKNOWN = "UNKNOWN",
1031
+ TRASH = "TRASH",
1032
+ DELETED = "DELETED",
1033
+ PENDING_PURGE = "PENDING_PURGE",
1034
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
1035
+ }
1036
+ /** @enumType */
1037
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
1038
+ /** Restoration of the meta site. */
1039
+ interface SiteUndeleted {
1040
+ }
1041
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
1042
+ interface SitePublished {
1043
+ }
1044
+ interface SiteUnpublished {
1045
+ /**
1046
+ * A list of URLs previously associated with the meta site.
1047
+ * @maxLength 4000
1048
+ * @maxSize 10000
1049
+ */
1050
+ urls?: string[];
1051
+ }
1052
+ interface SiteMarkedAsTemplate {
1053
+ }
1054
+ interface SiteMarkedAsWixSite {
1055
+ }
1056
+ /**
1057
+ * Represents a service provisioned a site.
1058
+ *
1059
+ * Note on `origin_instance_id`:
1060
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
1061
+ * This is because of the following scenario:
1062
+ *
1063
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
1064
+ * such as a product catalog. When you create a site from this template, you inherit this
1065
+ * default product catalog. However, if the template's product catalog is modified,
1066
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
1067
+ * your site remains consistent with what you initially received and does not include any
1068
+ * changes made to the original template afterward.
1069
+ * To ensure this, the TPA on the template gets a new instance_id.
1070
+ */
1071
+ interface ServiceProvisioned {
1072
+ /**
1073
+ * Either UUID or EmbeddedServiceType.
1074
+ * @maxLength 36
1075
+ */
1076
+ appDefId?: string;
1077
+ /**
1078
+ * Not only UUID. Something here could be something weird.
1079
+ * @maxLength 36
1080
+ */
1081
+ instanceId?: string;
1082
+ /**
1083
+ * An instance id from which this instance is originated.
1084
+ * @maxLength 36
1085
+ */
1086
+ originInstanceId?: string;
1087
+ /**
1088
+ * A version.
1089
+ * @maxLength 500
1090
+ */
1091
+ version?: string | null;
1092
+ /**
1093
+ * The origin meta site id
1094
+ * @format GUID
1095
+ */
1096
+ originMetaSiteId?: string | null;
1097
+ }
1098
+ interface ServiceRemoved {
1099
+ /**
1100
+ * Either UUID or EmbeddedServiceType.
1101
+ * @maxLength 36
1102
+ */
1103
+ appDefId?: string;
1104
+ /**
1105
+ * Not only UUID. Something here could be something weird.
1106
+ * @maxLength 36
1107
+ */
1108
+ instanceId?: string;
1109
+ /**
1110
+ * A version.
1111
+ * @maxLength 500
1112
+ */
1113
+ version?: string | null;
1114
+ }
1115
+ /** Rename of the site. Meaning, free public url has been changed as well. */
1116
+ interface SiteRenamed {
1117
+ /**
1118
+ * A new meta site name (URL slug).
1119
+ * @maxLength 20
1120
+ */
1121
+ newSiteName?: string;
1122
+ /**
1123
+ * A previous meta site name (URL slug).
1124
+ * @maxLength 255
1125
+ */
1126
+ oldSiteName?: string;
1127
+ }
1128
+ /**
1129
+ * Hard deletion of the meta site.
1130
+ *
1131
+ * Could not be restored. Therefore it's desirable to cleanup data.
1132
+ */
1133
+ interface SiteHardDeleted {
1134
+ /** A deletion context. */
1135
+ deleteContext?: DeleteContext;
1136
+ }
1137
+ interface NamespaceChanged {
1138
+ /** A previous namespace. */
1139
+ oldNamespace?: NamespaceWithLiterals;
1140
+ /** A new namespace. */
1141
+ newNamespace?: NamespaceWithLiterals;
1142
+ }
1143
+ /** Assigned Studio editor */
1144
+ interface StudioAssigned {
1145
+ }
1146
+ /** Unassigned Studio editor */
1147
+ interface StudioUnassigned {
1148
+ }
1149
+ /**
1150
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
1151
+ *
1152
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
1153
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
1154
+ *
1155
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
1156
+ */
1157
+ interface SiteUrlChanged {
1158
+ }
1159
+ /**
1160
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
1161
+ * Consumed by other teams to remove relevant data.
1162
+ */
1163
+ interface SitePurgedExternally {
1164
+ /**
1165
+ * @maxLength 2048
1166
+ * @maxSize 100
1167
+ * @deprecated
1168
+ * @targetRemovalDate 2025-04-15
1169
+ */
1170
+ appDefId?: string[];
1171
+ }
1172
+ /** Assigned Odeditor */
1173
+ interface OdeditorAssigned {
1174
+ }
1175
+ /** Unassigned Odeditor */
1176
+ interface OdeditorUnassigned {
1177
+ }
1178
+ /** Assigned Picasso editor */
1179
+ interface PicassoAssigned {
1180
+ }
1181
+ /** Unassigned Picasso */
1182
+ interface PicassoUnassigned {
1183
+ }
1184
+ /** Assigned Wixel */
1185
+ interface WixelAssigned {
1186
+ }
1187
+ /** Unassigned Wixel */
1188
+ interface WixelUnassigned {
1189
+ }
1190
+ /** Assigned StudioTwo */
1191
+ interface StudioTwoAssigned {
1192
+ }
1193
+ /** Unassigned StudioTwo */
1194
+ interface StudioTwoUnassigned {
1195
+ }
1196
+ /** Media from user domain is enabled. */
1197
+ interface UserDomainMediaEnabled {
1198
+ }
1199
+ /** Media from user domain is disabled. */
1200
+ interface UserDomainMediaDisabled {
1201
+ }
1202
+ /** Assigned Editorless */
1203
+ interface EditorlessAssigned {
1204
+ }
1205
+ /** Unassigned Editorless */
1206
+ interface EditorlessUnassigned {
1207
+ }
1208
+ interface MessageEnvelope {
1209
+ /**
1210
+ * App instance ID.
1211
+ * @format GUID
1212
+ */
1213
+ instanceId?: string | null;
1214
+ /**
1215
+ * Event type.
1216
+ * @maxLength 150
1217
+ */
1218
+ eventType?: string;
1219
+ /** The identification type and identity data. */
1220
+ identity?: IdentificationData;
1221
+ /** Stringify payload. */
1222
+ data?: string;
1223
+ /** Details related to the account */
1224
+ accountInfo?: AccountInfo;
1225
+ }
1226
+ interface IdentificationData extends IdentificationDataIdOneOf {
1227
+ /**
1228
+ * ID of a site visitor that has not logged in to the site.
1229
+ * @format GUID
1230
+ */
1231
+ anonymousVisitorId?: string;
1232
+ /**
1233
+ * ID of a site visitor that has logged in to the site.
1234
+ * @format GUID
1235
+ */
1236
+ memberId?: string;
1237
+ /**
1238
+ * ID of a Wix user (site owner, contributor, etc.).
1239
+ * @format GUID
1240
+ */
1241
+ wixUserId?: string;
1242
+ /**
1243
+ * ID of an app.
1244
+ * @format GUID
1245
+ */
1246
+ appId?: string;
1247
+ /** @readonly */
1248
+ identityType?: WebhookIdentityTypeWithLiterals;
1249
+ }
1250
+ /** @oneof */
1251
+ interface IdentificationDataIdOneOf {
1252
+ /**
1253
+ * ID of a site visitor that has not logged in to the site.
1254
+ * @format GUID
1255
+ */
1256
+ anonymousVisitorId?: string;
1257
+ /**
1258
+ * ID of a site visitor that has logged in to the site.
1259
+ * @format GUID
1260
+ */
1261
+ memberId?: string;
1262
+ /**
1263
+ * ID of a Wix user (site owner, contributor, etc.).
1264
+ * @format GUID
1265
+ */
1266
+ wixUserId?: string;
1267
+ /**
1268
+ * ID of an app.
1269
+ * @format GUID
1270
+ */
1271
+ appId?: string;
1272
+ }
1273
+ declare enum WebhookIdentityType {
1274
+ UNKNOWN = "UNKNOWN",
1275
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1276
+ MEMBER = "MEMBER",
1277
+ WIX_USER = "WIX_USER",
1278
+ APP = "APP"
1279
+ }
1280
+ /** @enumType */
1281
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1282
+ interface AccountInfo {
1283
+ /**
1284
+ * ID of the Wix account associated with the event.
1285
+ * @format GUID
1286
+ */
1287
+ accountId?: string | null;
1288
+ /**
1289
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
1290
+ * @format GUID
1291
+ */
1292
+ parentAccountId?: string | null;
1293
+ /**
1294
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
1295
+ * @format GUID
1296
+ */
1297
+ siteId?: string | null;
1298
+ }
1299
+ /** @docsIgnore */
1300
+ type CreateStandaloneFormApplicationErrors = {
1301
+ code?: 'FAILED_PRECONDITION';
1302
+ description?: string;
1303
+ data?: Record<string, any>;
1304
+ };
1305
+ /** @docsIgnore */
1306
+ type GetSitePropertiesApplicationErrors = {
1307
+ code?: 'SITE_PROPERTIES_NOT_FOUND';
1308
+ description?: string;
1309
+ data?: Record<string, any>;
1310
+ };
1311
+
1312
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1313
+ getUrl: (context: any) => string;
1314
+ httpMethod: K;
1315
+ path: string;
1316
+ pathParams: M;
1317
+ __requestType: T;
1318
+ __originalRequestType: S;
1319
+ __responseType: Q;
1320
+ __originalResponseType: R;
1321
+ };
1322
+ declare function getOrCreateFormStandaloneMetaSite(): __PublicMethodMetaInfo<'GET', {}, GetOrCreateFormStandaloneMetaSiteRequest$1, GetOrCreateFormStandaloneMetaSiteRequest, GetOrCreateFormStandaloneMetaSiteResponse$1, GetOrCreateFormStandaloneMetaSiteResponse>;
1323
+ declare function createStandaloneForm(): __PublicMethodMetaInfo<'POST', {}, CreateStandaloneFormRequest$1, CreateStandaloneFormRequest, CreateStandaloneFormResponse$1, CreateStandaloneFormResponse>;
1324
+ declare function getStandaloneForm(): __PublicMethodMetaInfo<'GET', {
1325
+ standaloneFormId: string;
1326
+ }, GetStandaloneFormRequest$1, GetStandaloneFormRequest, GetStandaloneFormResponse$1, GetStandaloneFormResponse>;
1327
+ declare function deleteStandaloneForm(): __PublicMethodMetaInfo<'DELETE', {
1328
+ standaloneFormId: string;
1329
+ }, DeleteStandaloneFormRequest$1, DeleteStandaloneFormRequest, DeleteStandaloneFormResponse$1, DeleteStandaloneFormResponse>;
1330
+ declare function removeStandaloneFormFromTrashBin(): __PublicMethodMetaInfo<'DELETE', {
1331
+ standaloneFormId: string;
1332
+ }, RemoveStandaloneFormFromTrashBinRequest$1, RemoveStandaloneFormFromTrashBinRequest, RemoveStandaloneFormFromTrashBinResponse$1, RemoveStandaloneFormFromTrashBinResponse>;
1333
+ declare function restoreStandaloneFormFromTrashBin(): __PublicMethodMetaInfo<'POST', {
1334
+ standaloneFormId: string;
1335
+ }, RestoreStandaloneFormFromTrashBinRequest$1, RestoreStandaloneFormFromTrashBinRequest, RestoreStandaloneFormFromTrashBinResponse$1, RestoreStandaloneFormFromTrashBinResponse>;
1336
+ declare function getDeletedStandaloneForm(): __PublicMethodMetaInfo<'GET', {
1337
+ standaloneFormId: string;
1338
+ }, GetDeletedStandaloneFormRequest$1, GetDeletedStandaloneFormRequest, GetDeletedStandaloneFormResponse$1, GetDeletedStandaloneFormResponse>;
1339
+ declare function listDeletedStandaloneForms(): __PublicMethodMetaInfo<'GET', {}, ListDeletedStandaloneFormsRequest$1, ListDeletedStandaloneFormsRequest, ListDeletedStandaloneFormsResponse$1, ListDeletedStandaloneFormsResponse>;
1340
+ declare function queryStandaloneForms(): __PublicMethodMetaInfo<'POST', {}, QueryStandaloneFormsRequest$1, QueryStandaloneFormsRequest, QueryStandaloneFormsResponse$1, QueryStandaloneFormsResponse>;
1341
+ declare function getSiteProperties(): __PublicMethodMetaInfo<'GET', {}, GetSitePropertiesRequest$1, GetSitePropertiesRequest, GetSitePropertiesResponse$1, GetSitePropertiesResponse>;
1342
+
1343
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressHint as AddressHintOriginal, type Address as AddressOriginal, type Asset as AssetOriginal, type BusinessSchedule as BusinessScheduleOriginal, type Categories as CategoriesOriginal, type ChangeContext as ChangeContextOriginal, type ChangeContextPayloadOneOf as ChangeContextPayloadOneOfOriginal, type ConsentPolicy as ConsentPolicyOriginal, type CreateStandaloneFormApplicationErrors as CreateStandaloneFormApplicationErrorsOriginal, type CreateStandaloneFormRequest as CreateStandaloneFormRequestOriginal, type CreateStandaloneFormResponse as CreateStandaloneFormResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, DayOfWeek as DayOfWeekOriginal, type DayOfWeekWithLiterals as DayOfWeekWithLiteralsOriginal, type DeleteContext as DeleteContextOriginal, type DeleteStandaloneFormRequest as DeleteStandaloneFormRequestOriginal, type DeleteStandaloneFormResponse as DeleteStandaloneFormResponseOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type GeoCoordinates as GeoCoordinatesOriginal, type GetDeletedStandaloneFormRequest as GetDeletedStandaloneFormRequestOriginal, type GetDeletedStandaloneFormResponse as GetDeletedStandaloneFormResponseOriginal, type GetOrCreateFormStandaloneMetaSiteRequest as GetOrCreateFormStandaloneMetaSiteRequestOriginal, type GetOrCreateFormStandaloneMetaSiteResponse as GetOrCreateFormStandaloneMetaSiteResponseOriginal, type GetSitePropertiesApplicationErrors as GetSitePropertiesApplicationErrorsOriginal, type GetSitePropertiesRequest as GetSitePropertiesRequestOriginal, type GetSitePropertiesResponse as GetSitePropertiesResponseOriginal, type GetStandaloneFormRequest as GetStandaloneFormRequestOriginal, type GetStandaloneFormResponse as GetStandaloneFormResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ListDeletedStandaloneFormsRequest as ListDeletedStandaloneFormsRequestOriginal, type ListDeletedStandaloneFormsResponse as ListDeletedStandaloneFormsResponseOriginal, type Locale as LocaleOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type Multilingual as MultilingualOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, PlacementType as PlacementTypeOriginal, type PlacementTypeWithLiterals as PlacementTypeWithLiteralsOriginal, type PropertiesChange as PropertiesChangeOriginal, type Properties as PropertiesOriginal, type QueryStandaloneFormsRequest as QueryStandaloneFormsRequestOriginal, type QueryStandaloneFormsResponse as QueryStandaloneFormsResponseOriginal, type RemoveStandaloneFormFromTrashBinRequest as RemoveStandaloneFormFromTrashBinRequestOriginal, type RemoveStandaloneFormFromTrashBinResponse as RemoveStandaloneFormFromTrashBinResponseOriginal, ResolutionMethod as ResolutionMethodOriginal, type ResolutionMethodWithLiterals as ResolutionMethodWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RestoreStandaloneFormFromTrashBinRequest as RestoreStandaloneFormFromTrashBinRequestOriginal, type RestoreStandaloneFormFromTrashBinResponse as RestoreStandaloneFormFromTrashBinResponseOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SiteCloned as SiteClonedOriginal, 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 SitePropertiesEvent as SitePropertiesEventOriginal, type SitePropertiesNotification as SitePropertiesNotificationOriginal, 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 SpecialHourPeriod as SpecialHourPeriodOriginal, type StandaloneForm as StandaloneFormOriginal, type StandaloneMetaSiteProperties as StandaloneMetaSitePropertiesOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type SupportedLanguage as SupportedLanguageOriginal, type TimePeriod as TimePeriodOriginal, type Translation as TranslationOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V4SiteCreated as V4SiteCreatedOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, createStandaloneForm, deleteStandaloneForm, getDeletedStandaloneForm, getOrCreateFormStandaloneMetaSite, getSiteProperties, getStandaloneForm, listDeletedStandaloneForms, queryStandaloneForms, removeStandaloneFormFromTrashBin, restoreStandaloneFormFromTrashBin };