@wix/auto_sdk_members_user-member 1.0.19 → 1.0.21

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.
Files changed (123) hide show
  1. package/build/cjs/index.d.ts +25 -1
  2. package/build/cjs/index.js +239 -15
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +829 -1
  5. package/build/cjs/index.typings.js +227 -15
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +226 -1
  8. package/build/cjs/meta.js +97 -15
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/{internal/cjs/src/members-usermembers-v1-user-member-user-member.public.d.ts → es/index.d.mts} +9 -7
  11. package/build/es/index.mjs +210 -0
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/{internal/cjs/src/members-usermembers-v1-user-member-user-member.universal.d.ts → es/index.typings.d.mts} +64 -65
  14. package/build/es/index.typings.mjs +198 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/es/meta.d.mts +226 -0
  17. package/build/es/meta.mjs +73 -0
  18. package/build/es/meta.mjs.map +1 -0
  19. package/build/internal/cjs/index.d.ts +25 -1
  20. package/build/internal/cjs/index.js +239 -15
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +829 -1
  23. package/build/internal/cjs/index.typings.js +227 -15
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +226 -1
  26. package/build/internal/cjs/meta.js +97 -15
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/{es/src/members-usermembers-v1-user-member-user-member.public.d.ts → internal/es/index.d.mts} +9 -7
  29. package/build/internal/es/index.mjs +210 -0
  30. package/build/internal/es/index.mjs.map +1 -0
  31. package/build/{cjs/src/members-usermembers-v1-user-member-user-member.universal.d.ts → internal/es/index.typings.d.mts} +64 -65
  32. package/build/internal/es/index.typings.mjs +198 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -0
  34. package/build/internal/es/meta.d.mts +226 -0
  35. package/build/internal/es/meta.mjs +73 -0
  36. package/build/internal/es/meta.mjs.map +1 -0
  37. package/package.json +10 -9
  38. package/build/cjs/src/members-usermembers-v1-user-member-user-member.context.d.ts +0 -5
  39. package/build/cjs/src/members-usermembers-v1-user-member-user-member.context.js +0 -16
  40. package/build/cjs/src/members-usermembers-v1-user-member-user-member.context.js.map +0 -1
  41. package/build/cjs/src/members-usermembers-v1-user-member-user-member.http.d.ts +0 -15
  42. package/build/cjs/src/members-usermembers-v1-user-member-user-member.http.js +0 -66
  43. package/build/cjs/src/members-usermembers-v1-user-member-user-member.http.js.map +0 -1
  44. package/build/cjs/src/members-usermembers-v1-user-member-user-member.meta.d.ts +0 -13
  45. package/build/cjs/src/members-usermembers-v1-user-member-user-member.meta.js +0 -47
  46. package/build/cjs/src/members-usermembers-v1-user-member-user-member.meta.js.map +0 -1
  47. package/build/cjs/src/members-usermembers-v1-user-member-user-member.public.d.ts +0 -23
  48. package/build/cjs/src/members-usermembers-v1-user-member-user-member.public.js +0 -21
  49. package/build/cjs/src/members-usermembers-v1-user-member-user-member.public.js.map +0 -1
  50. package/build/cjs/src/members-usermembers-v1-user-member-user-member.types.d.ts +0 -733
  51. package/build/cjs/src/members-usermembers-v1-user-member-user-member.types.js +0 -156
  52. package/build/cjs/src/members-usermembers-v1-user-member-user-member.types.js.map +0 -1
  53. package/build/cjs/src/members-usermembers-v1-user-member-user-member.universal.js +0 -249
  54. package/build/cjs/src/members-usermembers-v1-user-member-user-member.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/src/members-usermembers-v1-user-member-user-member.context.d.ts +0 -5
  65. package/build/es/src/members-usermembers-v1-user-member-user-member.context.js +0 -5
  66. package/build/es/src/members-usermembers-v1-user-member-user-member.context.js.map +0 -1
  67. package/build/es/src/members-usermembers-v1-user-member-user-member.http.d.ts +0 -15
  68. package/build/es/src/members-usermembers-v1-user-member-user-member.http.js +0 -62
  69. package/build/es/src/members-usermembers-v1-user-member-user-member.http.js.map +0 -1
  70. package/build/es/src/members-usermembers-v1-user-member-user-member.meta.d.ts +0 -13
  71. package/build/es/src/members-usermembers-v1-user-member-user-member.meta.js +0 -20
  72. package/build/es/src/members-usermembers-v1-user-member-user-member.meta.js.map +0 -1
  73. package/build/es/src/members-usermembers-v1-user-member-user-member.public.js +0 -9
  74. package/build/es/src/members-usermembers-v1-user-member-user-member.public.js.map +0 -1
  75. package/build/es/src/members-usermembers-v1-user-member-user-member.types.d.ts +0 -733
  76. package/build/es/src/members-usermembers-v1-user-member-user-member.types.js +0 -153
  77. package/build/es/src/members-usermembers-v1-user-member-user-member.types.js.map +0 -1
  78. package/build/es/src/members-usermembers-v1-user-member-user-member.universal.d.ts +0 -830
  79. package/build/es/src/members-usermembers-v1-user-member-user-member.universal.js +0 -222
  80. package/build/es/src/members-usermembers-v1-user-member-user-member.universal.js.map +0 -1
  81. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.context.d.ts +0 -5
  82. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.context.js +0 -16
  83. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.context.js.map +0 -1
  84. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.http.d.ts +0 -15
  85. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.http.js +0 -66
  86. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.http.js.map +0 -1
  87. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.meta.d.ts +0 -13
  88. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.meta.js +0 -47
  89. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.meta.js.map +0 -1
  90. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.public.js +0 -21
  91. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.public.js.map +0 -1
  92. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.types.d.ts +0 -733
  93. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.types.js +0 -156
  94. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.types.js.map +0 -1
  95. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.universal.js +0 -249
  96. package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.universal.js.map +0 -1
  97. package/build/internal/es/index.d.ts +0 -1
  98. package/build/internal/es/index.js +0 -2
  99. package/build/internal/es/index.js.map +0 -1
  100. package/build/internal/es/index.typings.d.ts +0 -1
  101. package/build/internal/es/index.typings.js +0 -2
  102. package/build/internal/es/index.typings.js.map +0 -1
  103. package/build/internal/es/meta.d.ts +0 -1
  104. package/build/internal/es/meta.js +0 -2
  105. package/build/internal/es/meta.js.map +0 -1
  106. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.context.d.ts +0 -5
  107. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.context.js +0 -5
  108. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.context.js.map +0 -1
  109. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.http.d.ts +0 -15
  110. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.http.js +0 -62
  111. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.http.js.map +0 -1
  112. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.meta.d.ts +0 -13
  113. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.meta.js +0 -20
  114. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.meta.js.map +0 -1
  115. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.public.d.ts +0 -23
  116. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.public.js +0 -9
  117. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.public.js.map +0 -1
  118. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.types.d.ts +0 -733
  119. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.types.js +0 -153
  120. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.types.js.map +0 -1
  121. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.universal.d.ts +0 -830
  122. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.universal.js +0 -222
  123. package/build/internal/es/src/members-usermembers-v1-user-member-user-member.universal.js.map +0 -1
@@ -1,733 +0,0 @@
1
- export interface UserMember {
2
- /**
3
- * Profile ID.
4
- * @format GUID
5
- * @readonly
6
- */
7
- memberId?: string | null;
8
- /**
9
- * User ID.
10
- * @format GUID
11
- * @readonly
12
- */
13
- userId?: string | null;
14
- /**
15
- * Contact ID.
16
- * @format GUID
17
- * @readonly
18
- */
19
- contactId?: string | null;
20
- /**
21
- * Instance ID of the installed [Wix Members Area app](https://www.wix.com/app-market/web-solution/members-area) on the Wix site.
22
- * @format GUID
23
- * @readonly
24
- */
25
- siteMembersInstanceId?: string | null;
26
- /**
27
- * Metasite ID.
28
- * @format GUID
29
- * @readonly
30
- */
31
- metaSiteId?: string | null;
32
- /** User member profile picture. */
33
- photo?: Image;
34
- /**
35
- * User member nickname.
36
- * @readonly
37
- */
38
- nickname?: string | null;
39
- /**
40
- * User member profile privacy status.
41
- * @readonly
42
- */
43
- privacyStatus?: PrivacyStatusStatusWithLiterals;
44
- /**
45
- * Date and time the user member was created.
46
- * @readonly
47
- */
48
- createdDate?: Date | null;
49
- /**
50
- * Date and time the user member was updated.
51
- * @readonly
52
- */
53
- updatedDate?: Date | null;
54
- /**
55
- * User member site access status.
56
- * @readonly
57
- */
58
- status?: StatusWithLiterals;
59
- /**
60
- * User member activity status.
61
- * @readonly
62
- */
63
- activityStatus?: ActivityStatusStatusWithLiterals;
64
- }
65
- export interface Image {
66
- /**
67
- * Wix Media image ID,
68
- * set when the member selects an image from Wix Media.
69
- */
70
- id?: string;
71
- /** Image URL. */
72
- url?: string;
73
- /** Original image width. */
74
- height?: number;
75
- /** Original image height. */
76
- width?: number;
77
- /**
78
- * X-axis offset.
79
- *
80
- * Default: `0`.
81
- */
82
- offsetX?: number | null;
83
- /**
84
- * Y-axis offset.
85
- *
86
- * Default: `0`.
87
- */
88
- offsetY?: number | null;
89
- }
90
- export declare enum PrivacyStatusStatus {
91
- /** Unknown status. This value isn't used. */
92
- UNKNOWN = "UNKNOWN",
93
- /** User member is hidden from everyone who visits the site. The member is returned only to Wix users and apps with the appropriate permissions. */
94
- PRIVATE = "PRIVATE",
95
- /** User member is visible to everyone. */
96
- PUBLIC = "PUBLIC"
97
- }
98
- /** @enumType */
99
- export type PrivacyStatusStatusWithLiterals = PrivacyStatusStatus | 'UNKNOWN' | 'PRIVATE' | 'PUBLIC';
100
- export declare enum Status {
101
- /** Unknown status. This value isn't used. */
102
- UNKNOWN = "UNKNOWN",
103
- /** User member is created and is waiting for the approval. */
104
- PENDING = "PENDING",
105
- /** User member is approved and can log in to the site. */
106
- APPROVED = "APPROVED",
107
- /** User member is approved and can't log in to the site. */
108
- BLOCKED = "BLOCKED",
109
- /** User member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and can't log in to the site. */
110
- OFFLINE = "OFFLINE"
111
- }
112
- /** @enumType */
113
- export type StatusWithLiterals = Status | 'UNKNOWN' | 'PENDING' | 'APPROVED' | 'BLOCKED' | 'OFFLINE';
114
- export declare enum ActivityStatusStatus {
115
- /** Unknown status. This value isn't used. */
116
- UNKNOWN = "UNKNOWN",
117
- /** User member can participate in site activities, such as writing blog posts and forum comments. */
118
- ACTIVE = "ACTIVE",
119
- /** User member can't participate in site activities, such as writing blog posts and forum comments. */
120
- MUTED = "MUTED"
121
- }
122
- /** @enumType */
123
- export type ActivityStatusStatusWithLiterals = ActivityStatusStatus | 'UNKNOWN' | 'ACTIVE' | 'MUTED';
124
- export interface QueryUserMembersRequest {
125
- /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
126
- query?: CursorQuery;
127
- }
128
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
129
- /** 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`. */
130
- cursorPaging?: CursorPaging;
131
- /**
132
- * Filter object in the following format:
133
- * `"filter" : {
134
- * "fieldName1": "value1",
135
- * "fieldName2":{"$operator":"value2"}
136
- * }`
137
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
138
- */
139
- filter?: Record<string, any> | null;
140
- /**
141
- * Sort object in the following format:
142
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
143
- */
144
- sort?: Sorting[];
145
- }
146
- /** @oneof */
147
- export interface CursorQueryPagingMethodOneOf {
148
- /** 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`. */
149
- cursorPaging?: CursorPaging;
150
- }
151
- export interface Sorting {
152
- /** Name of the field to sort by. */
153
- fieldName?: string;
154
- /** Sort order. */
155
- order?: SortOrderWithLiterals;
156
- }
157
- export declare enum SortOrder {
158
- /** Sorting is in ascending order. */
159
- ASC = "ASC",
160
- /** Sorting is in descending order. */
161
- DESC = "DESC"
162
- }
163
- /** @enumType */
164
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
165
- export interface CursorPaging {
166
- /**
167
- * Number of items to load.
168
- * @max 100
169
- */
170
- limit?: number | null;
171
- /**
172
- * Pointer to the next or previous page in the list of results.
173
- *
174
- * You can get the relevant cursor token
175
- * from the `pagingMetadata` object in the previous call's response.
176
- * Not relevant for the first request.
177
- */
178
- cursor?: string | null;
179
- }
180
- export interface QueryUserMembersResponse {
181
- /** Retrieved user members. */
182
- userMembers?: UserMember[];
183
- /** Metadata for the paginated results. */
184
- metadata?: CursorPagingMetadata;
185
- }
186
- export interface CursorPagingMetadata {
187
- /** Number of items returned in current page. */
188
- count?: number | null;
189
- /** Cursor strings that point to the next page, previous page, or both. */
190
- cursors?: Cursors;
191
- /**
192
- * Whether there are more pages to retrieve following the current page.
193
- *
194
- * + `true`: Another page of results can be retrieved.
195
- * + `false`: This is the last page.
196
- */
197
- hasNext?: boolean | null;
198
- }
199
- export interface Cursors {
200
- /**
201
- * Cursor string pointing to the next page in the list of results.
202
- * @maxLength 16000
203
- */
204
- next?: string | null;
205
- /**
206
- * Cursor pointing to the previous page in the list of results.
207
- * @maxLength 16000
208
- */
209
- prev?: string | null;
210
- }
211
- export interface DomainEvent extends DomainEventBodyOneOf {
212
- createdEvent?: EntityCreatedEvent;
213
- updatedEvent?: EntityUpdatedEvent;
214
- deletedEvent?: EntityDeletedEvent;
215
- actionEvent?: ActionEvent;
216
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
217
- id?: string;
218
- /**
219
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
220
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
221
- */
222
- entityFqdn?: string;
223
- /**
224
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
225
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
226
- */
227
- slug?: string;
228
- /** ID of the entity associated with the event. */
229
- entityId?: string;
230
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
231
- eventTime?: Date | null;
232
- /**
233
- * Whether the event was triggered as a result of a privacy regulation application
234
- * (for example, GDPR).
235
- */
236
- triggeredByAnonymizeRequest?: boolean | null;
237
- /** If present, indicates the action that triggered the event. */
238
- originatedFrom?: string | null;
239
- /**
240
- * 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.
241
- * 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.
242
- */
243
- entityEventSequence?: string | null;
244
- }
245
- /** @oneof */
246
- export interface DomainEventBodyOneOf {
247
- createdEvent?: EntityCreatedEvent;
248
- updatedEvent?: EntityUpdatedEvent;
249
- deletedEvent?: EntityDeletedEvent;
250
- actionEvent?: ActionEvent;
251
- }
252
- export interface EntityCreatedEvent {
253
- entityAsJson?: string;
254
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
255
- restoreInfo?: RestoreInfo;
256
- }
257
- export interface RestoreInfo {
258
- deletedDate?: Date | null;
259
- }
260
- export interface EntityUpdatedEvent {
261
- /**
262
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
263
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
264
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
265
- */
266
- currentEntityAsJson?: string;
267
- }
268
- export interface EntityDeletedEvent {
269
- /** Entity that was deleted. */
270
- deletedEntityAsJson?: string | null;
271
- }
272
- export interface ActionEvent {
273
- bodyAsJson?: string;
274
- }
275
- export interface Empty {
276
- }
277
- export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
278
- /** Emitted on a meta site creation. */
279
- siteCreated?: SiteCreated;
280
- /** Emitted on a meta site transfer completion. */
281
- siteTransferred?: SiteTransferred;
282
- /** Emitted on a meta site deletion. */
283
- siteDeleted?: SiteDeleted;
284
- /** Emitted on a meta site restoration. */
285
- siteUndeleted?: SiteUndeleted;
286
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
287
- sitePublished?: SitePublished;
288
- /** Emitted on a meta site unpublish. */
289
- siteUnpublished?: SiteUnpublished;
290
- /** Emitted when meta site is marked as template. */
291
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
292
- /** Emitted when meta site is marked as a WixSite. */
293
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
294
- /** Emitted when an application is provisioned (installed). */
295
- serviceProvisioned?: ServiceProvisioned;
296
- /** Emitted when an application is removed (uninstalled). */
297
- serviceRemoved?: ServiceRemoved;
298
- /** Emitted when meta site name (URL slug) is changed. */
299
- siteRenamedPayload?: SiteRenamed;
300
- /** Emitted when meta site was permanently deleted. */
301
- hardDeleted?: SiteHardDeleted;
302
- /** Emitted on a namespace change. */
303
- namespaceChanged?: NamespaceChanged;
304
- /** Emitted when Studio is attached. */
305
- studioAssigned?: StudioAssigned;
306
- /** Emitted when Studio is detached. */
307
- studioUnassigned?: StudioUnassigned;
308
- /**
309
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
310
- * the actual URL.
311
- *
312
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
313
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
314
- */
315
- urlChanged?: SiteUrlChanged;
316
- /** Site is marked as PurgedExternally */
317
- sitePurgedExternally?: SitePurgedExternally;
318
- /** Emitted when Odeditor is attached. */
319
- odeditorAssigned?: OdeditorAssigned;
320
- /** Emitted when Odeditor is detached. */
321
- odeditorUnassigned?: OdeditorUnassigned;
322
- /** Emitted when Picasso is attached. */
323
- picassoAssigned?: PicassoAssigned;
324
- /** Emitted when Picasso is detached. */
325
- picassoUnassigned?: PicassoUnassigned;
326
- /**
327
- * A meta site id.
328
- * @format GUID
329
- */
330
- metaSiteId?: string;
331
- /** A meta site version. Monotonically increasing. */
332
- version?: string;
333
- /** A timestamp of the event. */
334
- timestamp?: string;
335
- /**
336
- * TODO(meta-site): Change validation once validations are disabled for consumers
337
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
338
- * @maxSize 4000
339
- */
340
- assets?: Asset[];
341
- }
342
- /** @oneof */
343
- export interface MetaSiteSpecialEventPayloadOneOf {
344
- /** Emitted on a meta site creation. */
345
- siteCreated?: SiteCreated;
346
- /** Emitted on a meta site transfer completion. */
347
- siteTransferred?: SiteTransferred;
348
- /** Emitted on a meta site deletion. */
349
- siteDeleted?: SiteDeleted;
350
- /** Emitted on a meta site restoration. */
351
- siteUndeleted?: SiteUndeleted;
352
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
353
- sitePublished?: SitePublished;
354
- /** Emitted on a meta site unpublish. */
355
- siteUnpublished?: SiteUnpublished;
356
- /** Emitted when meta site is marked as template. */
357
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
358
- /** Emitted when meta site is marked as a WixSite. */
359
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
360
- /** Emitted when an application is provisioned (installed). */
361
- serviceProvisioned?: ServiceProvisioned;
362
- /** Emitted when an application is removed (uninstalled). */
363
- serviceRemoved?: ServiceRemoved;
364
- /** Emitted when meta site name (URL slug) is changed. */
365
- siteRenamedPayload?: SiteRenamed;
366
- /** Emitted when meta site was permanently deleted. */
367
- hardDeleted?: SiteHardDeleted;
368
- /** Emitted on a namespace change. */
369
- namespaceChanged?: NamespaceChanged;
370
- /** Emitted when Studio is attached. */
371
- studioAssigned?: StudioAssigned;
372
- /** Emitted when Studio is detached. */
373
- studioUnassigned?: StudioUnassigned;
374
- /**
375
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
376
- * the actual URL.
377
- *
378
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
379
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
380
- */
381
- urlChanged?: SiteUrlChanged;
382
- /** Site is marked as PurgedExternally */
383
- sitePurgedExternally?: SitePurgedExternally;
384
- /** Emitted when Odeditor is attached. */
385
- odeditorAssigned?: OdeditorAssigned;
386
- /** Emitted when Odeditor is detached. */
387
- odeditorUnassigned?: OdeditorUnassigned;
388
- /** Emitted when Picasso is attached. */
389
- picassoAssigned?: PicassoAssigned;
390
- /** Emitted when Picasso is detached. */
391
- picassoUnassigned?: PicassoUnassigned;
392
- }
393
- export interface Asset {
394
- /**
395
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
396
- * @maxLength 36
397
- */
398
- appDefId?: string;
399
- /**
400
- * An instance id. For legacy reasons may be UUID or a string.
401
- * @maxLength 200
402
- */
403
- instanceId?: string;
404
- /** An application state. */
405
- state?: StateWithLiterals;
406
- }
407
- export declare enum State {
408
- UNKNOWN = "UNKNOWN",
409
- ENABLED = "ENABLED",
410
- DISABLED = "DISABLED",
411
- PENDING = "PENDING",
412
- DEMO = "DEMO"
413
- }
414
- /** @enumType */
415
- export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
416
- export interface SiteCreated {
417
- /**
418
- * A template identifier (empty if not created from a template).
419
- * @maxLength 36
420
- */
421
- originTemplateId?: string;
422
- /**
423
- * An account id of the owner.
424
- * @format GUID
425
- */
426
- ownerId?: string;
427
- /** A context in which meta site was created. */
428
- context?: SiteCreatedContextWithLiterals;
429
- /**
430
- * A meta site id from which this site was created.
431
- *
432
- * In case of a creation from a template it's a template id.
433
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
434
- * @format GUID
435
- */
436
- originMetaSiteId?: string | null;
437
- /**
438
- * A meta site name (URL slug).
439
- * @maxLength 20
440
- */
441
- siteName?: string;
442
- /** A namespace. */
443
- namespace?: NamespaceWithLiterals;
444
- }
445
- export declare enum SiteCreatedContext {
446
- /** A valid option, we don't expose all reasons why site might be created. */
447
- OTHER = "OTHER",
448
- /** A meta site was created from template. */
449
- FROM_TEMPLATE = "FROM_TEMPLATE",
450
- /** A meta site was created by copying of the transfferred meta site. */
451
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
452
- /** A copy of existing meta site. */
453
- DUPLICATE = "DUPLICATE",
454
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
455
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
456
- /** deprecated A meta site was created for Flash editor. */
457
- FLASH = "FLASH"
458
- }
459
- /** @enumType */
460
- export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
461
- export declare enum Namespace {
462
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
463
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
464
- WIX = "WIX",
465
- /** 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. */
466
- SHOUT_OUT = "SHOUT_OUT",
467
- /** 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. */
468
- ALBUMS = "ALBUMS",
469
- /** 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. */
470
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
471
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
472
- HOTELS = "HOTELS",
473
- /** 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. */
474
- CLUBS = "CLUBS",
475
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
476
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
477
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
478
- DEV_SITE = "DEV_SITE",
479
- /** 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. */
480
- LOGOS = "LOGOS",
481
- /** 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. */
482
- VIDEO_MAKER = "VIDEO_MAKER",
483
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
484
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
485
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
486
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
487
- /**
488
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
489
- *
490
- * Meta site with this namespace will *not* be shown in a user's site list by default.
491
- */
492
- HTML_DRAFT = "HTML_DRAFT",
493
- /**
494
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
495
- * Will be accessible from Site List and will not have a website app.
496
- * Once the user attaches a site, the site will become a regular wixsite.
497
- */
498
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
499
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
500
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
501
- /** It is to be used in the Business First efforts. */
502
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
503
- /** Bookings business flow with no site. */
504
- ANYWHERE = "ANYWHERE",
505
- /** Namespace for Headless Backoffice with no editor */
506
- HEADLESS = "HEADLESS",
507
- /**
508
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
509
- * The site will be used for account level CSM feature for enterprise
510
- */
511
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
512
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
513
- RISE = "RISE",
514
- /**
515
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
516
- * There's a blank site behind the scene but it's blank).
517
- * The Mobile company will be the owner of this namespace.
518
- */
519
- BRANDED_FIRST = "BRANDED_FIRST",
520
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
521
- NOWNIA = "NOWNIA",
522
- /**
523
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
524
- * The Partners company owns this namespace.
525
- */
526
- UGC_TEMPLATE = "UGC_TEMPLATE",
527
- /** Codux Headless Sites */
528
- CODUX = "CODUX",
529
- /** Bobb - AI Design Creator. */
530
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
531
- /**
532
- * Shared Blog Site is a unique single site across Enterprise account,
533
- * This site will hold all Blog posts related to the Marketing product.
534
- */
535
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
536
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
537
- STANDALONE_FORMS = "STANDALONE_FORMS",
538
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
539
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
540
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
541
- MIMIR = "MIMIR"
542
- }
543
- /** @enumType */
544
- export 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';
545
- /** Site transferred to another user. */
546
- export interface SiteTransferred {
547
- /**
548
- * A previous owner id (user that transfers meta site).
549
- * @format GUID
550
- */
551
- oldOwnerId?: string;
552
- /**
553
- * A new owner id (user that accepts meta site).
554
- * @format GUID
555
- */
556
- newOwnerId?: string;
557
- }
558
- /** Soft deletion of the meta site. Could be restored. */
559
- export interface SiteDeleted {
560
- /** A deletion context. */
561
- deleteContext?: DeleteContext;
562
- }
563
- export interface DeleteContext {
564
- /** When the meta site was deleted. */
565
- dateDeleted?: Date | null;
566
- /** A status. */
567
- deleteStatus?: DeleteStatusWithLiterals;
568
- /**
569
- * A reason (flow).
570
- * @maxLength 255
571
- */
572
- deleteOrigin?: string;
573
- /**
574
- * A service that deleted it.
575
- * @maxLength 255
576
- */
577
- initiatorId?: string | null;
578
- }
579
- export declare enum DeleteStatus {
580
- UNKNOWN = "UNKNOWN",
581
- TRASH = "TRASH",
582
- DELETED = "DELETED",
583
- PENDING_PURGE = "PENDING_PURGE",
584
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
585
- }
586
- /** @enumType */
587
- export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
588
- /** Restoration of the meta site. */
589
- export interface SiteUndeleted {
590
- }
591
- /** First publish of a meta site. Or subsequent publish after unpublish. */
592
- export interface SitePublished {
593
- }
594
- export interface SiteUnpublished {
595
- /**
596
- * A list of URLs previously associated with the meta site.
597
- * @maxLength 4000
598
- * @maxSize 10000
599
- */
600
- urls?: string[];
601
- }
602
- export interface SiteMarkedAsTemplate {
603
- }
604
- export interface SiteMarkedAsWixSite {
605
- }
606
- /**
607
- * Represents a service provisioned a site.
608
- *
609
- * Note on `origin_instance_id`:
610
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
611
- * This is because of the following scenario:
612
- *
613
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
614
- * such as a product catalog. When you create a site from this template, you inherit this
615
- * default product catalog. However, if the template's product catalog is modified,
616
- * your site will retain the catalog as it was at the time of site creation. This ensures that
617
- * your site remains consistent with what you initially received and does not include any
618
- * changes made to the original template afterward.
619
- * To ensure this, the TPA on the template gets a new instance_id.
620
- */
621
- export interface ServiceProvisioned {
622
- /**
623
- * Either UUID or EmbeddedServiceType.
624
- * @maxLength 36
625
- */
626
- appDefId?: string;
627
- /**
628
- * Not only UUID. Something here could be something weird.
629
- * @maxLength 36
630
- */
631
- instanceId?: string;
632
- /**
633
- * An instance id from which this instance is originated.
634
- * @maxLength 36
635
- */
636
- originInstanceId?: string;
637
- /**
638
- * A version.
639
- * @maxLength 500
640
- */
641
- version?: string | null;
642
- /**
643
- * The origin meta site id
644
- * @format GUID
645
- */
646
- originMetaSiteId?: string | null;
647
- }
648
- export interface ServiceRemoved {
649
- /**
650
- * Either UUID or EmbeddedServiceType.
651
- * @maxLength 36
652
- */
653
- appDefId?: string;
654
- /**
655
- * Not only UUID. Something here could be something weird.
656
- * @maxLength 36
657
- */
658
- instanceId?: string;
659
- /**
660
- * A version.
661
- * @maxLength 500
662
- */
663
- version?: string | null;
664
- }
665
- /** Rename of the site. Meaning, free public url has been changed as well. */
666
- export interface SiteRenamed {
667
- /**
668
- * A new meta site name (URL slug).
669
- * @maxLength 20
670
- */
671
- newSiteName?: string;
672
- /**
673
- * A previous meta site name (URL slug).
674
- * @maxLength 255
675
- */
676
- oldSiteName?: string;
677
- }
678
- /**
679
- * Hard deletion of the meta site.
680
- *
681
- * Could not be restored. Therefore it's desirable to cleanup data.
682
- */
683
- export interface SiteHardDeleted {
684
- /** A deletion context. */
685
- deleteContext?: DeleteContext;
686
- }
687
- export interface NamespaceChanged {
688
- /** A previous namespace. */
689
- oldNamespace?: NamespaceWithLiterals;
690
- /** A new namespace. */
691
- newNamespace?: NamespaceWithLiterals;
692
- }
693
- /** Assigned Studio editor */
694
- export interface StudioAssigned {
695
- }
696
- /** Unassigned Studio editor */
697
- export interface StudioUnassigned {
698
- }
699
- /**
700
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
701
- *
702
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
703
- * with sites and its urls, you need to listen to another topic/event. Read about it:
704
- *
705
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
706
- */
707
- export interface SiteUrlChanged {
708
- }
709
- /**
710
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
711
- * Consumed by other teams to remove relevant data.
712
- */
713
- export interface SitePurgedExternally {
714
- /**
715
- * @maxLength 2048
716
- * @maxSize 100
717
- * @deprecated
718
- * @targetRemovalDate 2025-04-15
719
- */
720
- appDefId?: string[];
721
- }
722
- /** Assigned Odeditor */
723
- export interface OdeditorAssigned {
724
- }
725
- /** Unassigned Odeditor */
726
- export interface OdeditorUnassigned {
727
- }
728
- /** Assigned Picasso editor */
729
- export interface PicassoAssigned {
730
- }
731
- /** Unassigned Picasso */
732
- export interface PicassoUnassigned {
733
- }