@wix/auto_sdk_members_members 1.0.55 → 1.0.57

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 (130) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/members-v1-member-members.context.d.ts +46 -0
  11. package/build/cjs/src/members-v1-member-members.context.js +59 -0
  12. package/build/cjs/src/members-v1-member-members.context.js.map +1 -0
  13. package/build/cjs/src/members-v1-member-members.http.d.ts +229 -0
  14. package/build/cjs/src/members-v1-member-members.http.js +959 -0
  15. package/build/cjs/src/members-v1-member-members.http.js.map +1 -0
  16. package/build/cjs/src/members-v1-member-members.meta.d.ts +60 -0
  17. package/build/cjs/src/members-v1-member-members.meta.js +484 -0
  18. package/build/cjs/src/members-v1-member-members.meta.js.map +1 -0
  19. package/build/{index.d.ts → cjs/src/members-v1-member-members.public.d.ts} +33 -70
  20. package/build/cjs/src/members-v1-member-members.public.js +198 -0
  21. package/build/cjs/src/members-v1-member-members.public.js.map +1 -0
  22. package/build/{internal/members-v1-member-members.universal-CzPn3y3P.d.mts → cjs/src/members-v1-member-members.types.d.ts} +216 -407
  23. package/build/cjs/src/members-v1-member-members.types.js +174 -0
  24. package/build/cjs/src/members-v1-member-members.types.js.map +1 -0
  25. package/build/cjs/src/members-v1-member-members.universal.d.ts +2473 -0
  26. package/build/cjs/src/members-v1-member-members.universal.js +1387 -0
  27. package/build/cjs/src/members-v1-member-members.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/members-v1-member-members.context.d.ts +46 -0
  39. package/build/es/src/members-v1-member-members.context.js +46 -0
  40. package/build/es/src/members-v1-member-members.context.js.map +1 -0
  41. package/build/es/src/members-v1-member-members.http.d.ts +229 -0
  42. package/build/es/src/members-v1-member-members.http.js +932 -0
  43. package/build/es/src/members-v1-member-members.http.js.map +1 -0
  44. package/build/es/src/members-v1-member-members.meta.d.ts +60 -0
  45. package/build/es/src/members-v1-member-members.meta.js +434 -0
  46. package/build/es/src/members-v1-member-members.meta.js.map +1 -0
  47. package/build/{internal/index.d.ts → es/src/members-v1-member-members.public.d.ts} +33 -70
  48. package/build/es/src/members-v1-member-members.public.js +161 -0
  49. package/build/es/src/members-v1-member-members.public.js.map +1 -0
  50. package/build/{internal/members-v1-member-members.universal-CzPn3y3P.d.ts → es/src/members-v1-member-members.types.d.ts} +216 -407
  51. package/build/es/src/members-v1-member-members.types.js +171 -0
  52. package/build/es/src/members-v1-member-members.types.js.map +1 -0
  53. package/build/es/src/members-v1-member-members.universal.d.ts +2473 -0
  54. package/build/es/src/members-v1-member-members.universal.js +1337 -0
  55. package/build/es/src/members-v1-member-members.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/members-v1-member-members.context.d.ts +46 -0
  66. package/build/internal/cjs/src/members-v1-member-members.context.js +59 -0
  67. package/build/internal/cjs/src/members-v1-member-members.context.js.map +1 -0
  68. package/build/internal/cjs/src/members-v1-member-members.http.d.ts +229 -0
  69. package/build/internal/cjs/src/members-v1-member-members.http.js +959 -0
  70. package/build/internal/cjs/src/members-v1-member-members.http.js.map +1 -0
  71. package/build/internal/cjs/src/members-v1-member-members.meta.d.ts +60 -0
  72. package/build/internal/cjs/src/members-v1-member-members.meta.js +484 -0
  73. package/build/internal/cjs/src/members-v1-member-members.meta.js.map +1 -0
  74. package/build/{index.d.mts → internal/cjs/src/members-v1-member-members.public.d.ts} +33 -70
  75. package/build/internal/cjs/src/members-v1-member-members.public.js +198 -0
  76. package/build/internal/cjs/src/members-v1-member-members.public.js.map +1 -0
  77. package/build/{members-v1-member-members.universal-CzPn3y3P.d.mts → internal/cjs/src/members-v1-member-members.types.d.ts} +216 -407
  78. package/build/internal/cjs/src/members-v1-member-members.types.js +174 -0
  79. package/build/internal/cjs/src/members-v1-member-members.types.js.map +1 -0
  80. package/build/internal/cjs/src/members-v1-member-members.universal.d.ts +2473 -0
  81. package/build/internal/cjs/src/members-v1-member-members.universal.js +1387 -0
  82. package/build/internal/cjs/src/members-v1-member-members.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/members-v1-member-members.context.d.ts +46 -0
  93. package/build/internal/es/src/members-v1-member-members.context.js +46 -0
  94. package/build/internal/es/src/members-v1-member-members.context.js.map +1 -0
  95. package/build/internal/es/src/members-v1-member-members.http.d.ts +229 -0
  96. package/build/internal/es/src/members-v1-member-members.http.js +932 -0
  97. package/build/internal/es/src/members-v1-member-members.http.js.map +1 -0
  98. package/build/internal/es/src/members-v1-member-members.meta.d.ts +60 -0
  99. package/build/internal/es/src/members-v1-member-members.meta.js +434 -0
  100. package/build/internal/es/src/members-v1-member-members.meta.js.map +1 -0
  101. package/build/internal/{index.d.mts → es/src/members-v1-member-members.public.d.ts} +33 -70
  102. package/build/internal/es/src/members-v1-member-members.public.js +161 -0
  103. package/build/internal/es/src/members-v1-member-members.public.js.map +1 -0
  104. package/build/{members-v1-member-members.universal-CzPn3y3P.d.ts → internal/es/src/members-v1-member-members.types.d.ts} +216 -407
  105. package/build/internal/es/src/members-v1-member-members.types.js +171 -0
  106. package/build/internal/es/src/members-v1-member-members.types.js.map +1 -0
  107. package/build/internal/es/src/members-v1-member-members.universal.d.ts +2473 -0
  108. package/build/internal/es/src/members-v1-member-members.universal.js +1337 -0
  109. package/build/internal/es/src/members-v1-member-members.universal.js.map +1 -0
  110. package/package.json +13 -14
  111. package/build/index.js +0 -1800
  112. package/build/index.js.map +0 -1
  113. package/build/index.mjs +0 -1740
  114. package/build/index.mjs.map +0 -1
  115. package/build/internal/index.js +0 -1800
  116. package/build/internal/index.js.map +0 -1
  117. package/build/internal/index.mjs +0 -1740
  118. package/build/internal/index.mjs.map +0 -1
  119. package/build/internal/meta.d.mts +0 -698
  120. package/build/internal/meta.d.ts +0 -698
  121. package/build/internal/meta.js +0 -1239
  122. package/build/internal/meta.js.map +0 -1
  123. package/build/internal/meta.mjs +0 -1189
  124. package/build/internal/meta.mjs.map +0 -1
  125. package/build/meta.d.mts +0 -698
  126. package/build/meta.d.ts +0 -698
  127. package/build/meta.js +0 -1239
  128. package/build/meta.js.map +0 -1
  129. package/build/meta.mjs +0 -1189
  130. package/build/meta.mjs.map +0 -1
@@ -0,0 +1,2473 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+ export interface Member {
3
+ /**
4
+ * Member ID.
5
+ * @format GUID
6
+ * @readonly
7
+ */
8
+ _id?: string | null;
9
+ /**
10
+ * Email used by a member to log in to the site.
11
+ * @format EMAIL
12
+ */
13
+ loginEmail?: string | null;
14
+ /**
15
+ * Whether the email used by a member has been verified.
16
+ * @readonly
17
+ */
18
+ loginEmailVerified?: boolean | null;
19
+ /**
20
+ * Member site access status.
21
+ * @readonly
22
+ */
23
+ status?: Status;
24
+ /**
25
+ * Contact ID.
26
+ * @format GUID
27
+ * @readonly
28
+ */
29
+ contactId?: string | null;
30
+ /**
31
+ * Member's contact information. Contact information is stored in the
32
+ * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).
33
+ *
34
+ * The full set of contact data can be accessed and managed with the
35
+ * Contacts API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction)).
36
+ */
37
+ contact?: Contact;
38
+ /** Profile display details. */
39
+ profile?: Profile;
40
+ /** Member privacy status. */
41
+ privacyStatus?: PrivacyStatusStatus;
42
+ /**
43
+ * Member activity status.
44
+ * @readonly
45
+ */
46
+ activityStatus?: ActivityStatusStatus;
47
+ /**
48
+ * Date and time when the member was created.
49
+ * @readonly
50
+ */
51
+ _createdDate?: Date | null;
52
+ /**
53
+ * Date and time when the member was updated.
54
+ * @readonly
55
+ */
56
+ _updatedDate?: Date | null;
57
+ /**
58
+ * Date and time when the member last logged in to the site.
59
+ * @readonly
60
+ */
61
+ lastLoginDate?: Date | null;
62
+ }
63
+ export declare enum Status {
64
+ /** Insufficient permissions to get the status. */
65
+ UNKNOWN = "UNKNOWN",
66
+ /** Member is created and is waiting for approval by a Wix user. */
67
+ PENDING = "PENDING",
68
+ /** Member can log in to the site. */
69
+ APPROVED = "APPROVED",
70
+ /** Member is blocked and can't log in to the site. */
71
+ BLOCKED = "BLOCKED",
72
+ /** 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. */
73
+ OFFLINE = "OFFLINE"
74
+ }
75
+ /** Contact info associated with the member. */
76
+ export interface Contact {
77
+ /** Contact's first name. */
78
+ firstName?: string | null;
79
+ /** Contact's last name. */
80
+ lastName?: string | null;
81
+ /** List of phone numbers. */
82
+ phones?: string[] | null;
83
+ /**
84
+ * List of email addresses.
85
+ * @format EMAIL
86
+ */
87
+ emails?: string[] | null;
88
+ /** List of street addresses. */
89
+ addresses?: Address[];
90
+ /**
91
+ * Contact's birthdate, formatted as `"YYYY-MM-DD"`.
92
+ *
93
+ * Example: `"2020-03-15"` for March 15, 2020.
94
+ * @maxLength 100
95
+ */
96
+ birthdate?: string | null;
97
+ /**
98
+ * Contact's company name.
99
+ * @maxLength 100
100
+ */
101
+ company?: string | null;
102
+ /**
103
+ * Contact's job title.
104
+ * @maxLength 100
105
+ */
106
+ jobTitle?: string | null;
107
+ /**
108
+ * Custom fields are structured as key:value pairs where each key is the field `name`, and each value is the field's `value` for the member.
109
+ *
110
+ * > **Notes:**
111
+ * > - Only custom fields added to the member profile in the dashboard are available through the Members API. Empty fields are not returned.
112
+ * > - When updating a member, `name` is ignored.
113
+ */
114
+ customFields?: Record<string, CustomField>;
115
+ }
116
+ /** Street address. */
117
+ export interface Address extends AddressStreetOneOf {
118
+ /** Street address object, with number and name in separate fields. */
119
+ streetAddress?: StreetAddress;
120
+ /**
121
+ * Main address line, usually street and number, as free text.
122
+ * @maxLength 200
123
+ */
124
+ addressLine?: string | null;
125
+ /**
126
+ * Street address ID.
127
+ * @format GUID
128
+ * @readonly
129
+ */
130
+ _id?: string | null;
131
+ /**
132
+ * Free text providing more detailed address information,
133
+ * such as apartment, suite, or floor.
134
+ */
135
+ addressLine2?: string | null;
136
+ /** City name. */
137
+ city?: string | null;
138
+ /**
139
+ * Code for a subdivision (such as state, prefecture, or province) in an
140
+ * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
141
+ */
142
+ subdivision?: string | null;
143
+ /**
144
+ * 2-letter country code in an
145
+ * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
146
+ */
147
+ country?: string | null;
148
+ /** Postal code. */
149
+ postalCode?: string | null;
150
+ }
151
+ /** @oneof */
152
+ export interface AddressStreetOneOf {
153
+ /** Street address object, with number and name in separate fields. */
154
+ streetAddress?: StreetAddress;
155
+ /**
156
+ * Main address line, usually street and number, as free text.
157
+ * @maxLength 200
158
+ */
159
+ addressLine?: string | null;
160
+ }
161
+ export interface StreetAddress {
162
+ /**
163
+ * Street number.
164
+ * @maxLength 100
165
+ */
166
+ number?: string;
167
+ /**
168
+ * Street name.
169
+ * @maxLength 200
170
+ */
171
+ name?: string;
172
+ }
173
+ export interface CustomField {
174
+ /** Custom field name. */
175
+ name?: string | null;
176
+ /** Custom field value. */
177
+ value?: any;
178
+ }
179
+ /** Member Profile */
180
+ export interface Profile {
181
+ /**
182
+ * Name that identifies the member to other members.
183
+ * Displayed on the member's profile page
184
+ * and interactions in the forum or blog.
185
+ */
186
+ nickname?: string | null;
187
+ /**
188
+ * Slug that determines the member's profile page URL.
189
+ * @readonly
190
+ */
191
+ slug?: string | null;
192
+ /** Member's profile photo. */
193
+ photo?: Image;
194
+ /**
195
+ * Member's cover photo,
196
+ * used as a background picture in a member's profile page.
197
+ *
198
+ * Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.
199
+ * When left empty, the values default to `0`.
200
+ */
201
+ cover?: Image;
202
+ /**
203
+ * Member title.
204
+ *
205
+ * Currently available through the API only.
206
+ */
207
+ title?: string | null;
208
+ }
209
+ export interface Image {
210
+ /**
211
+ * Wix Media image ID,
212
+ * set when the member selects an image from Wix Media.
213
+ */
214
+ _id?: string;
215
+ /** Image URL. */
216
+ url?: string;
217
+ /** Original image width. */
218
+ height?: number;
219
+ /** Original image height. */
220
+ width?: number;
221
+ /**
222
+ * X-axis offset.
223
+ *
224
+ * Default: `0`.
225
+ */
226
+ offsetX?: number | null;
227
+ /**
228
+ * Y-axis offset.
229
+ *
230
+ * Default: `0`.
231
+ */
232
+ offsetY?: number | null;
233
+ }
234
+ export declare enum PrivacyStatusStatus {
235
+ /** Insufficient permissions to get the status. */
236
+ UNKNOWN = "UNKNOWN",
237
+ /** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
238
+ PRIVATE = "PRIVATE",
239
+ /** Member is visible to everyone. */
240
+ PUBLIC = "PUBLIC"
241
+ }
242
+ export declare enum ActivityStatusStatus {
243
+ /** Insufficient permissions to get the status. */
244
+ UNKNOWN = "UNKNOWN",
245
+ /** Member can write forum posts and blog comments. */
246
+ ACTIVE = "ACTIVE",
247
+ /** Member can't write forum posts or blog comments. */
248
+ MUTED = "MUTED"
249
+ }
250
+ export interface ExtendedFields {
251
+ /**
252
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
253
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
254
+ *
255
+ * You can only access fields for which you have the appropriate permissions.
256
+ *
257
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
258
+ */
259
+ namespaces?: Record<string, Record<string, any>>;
260
+ }
261
+ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
262
+ /**
263
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
264
+ * @format GUID
265
+ */
266
+ metaSiteId?: string;
267
+ /**
268
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
269
+ * @format GUID
270
+ */
271
+ siteId?: string;
272
+ /** Invalidate by App */
273
+ app?: App;
274
+ /** Invalidate by page id */
275
+ page?: Page;
276
+ /** Invalidate by URI path */
277
+ uri?: URI;
278
+ /** Invalidate by file (for media files such as PDFs) */
279
+ file?: File;
280
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
281
+ customTag?: CustomTag;
282
+ /**
283
+ * tell us why you're invalidating the cache. You don't need to add your app name
284
+ * @maxLength 256
285
+ */
286
+ reason?: string | null;
287
+ /** Is local DS */
288
+ localDc?: boolean;
289
+ hardPurge?: boolean;
290
+ }
291
+ /** @oneof */
292
+ export interface InvalidateCacheGetByOneOf {
293
+ /**
294
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
295
+ * @format GUID
296
+ */
297
+ metaSiteId?: string;
298
+ /**
299
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
300
+ * @format GUID
301
+ */
302
+ siteId?: string;
303
+ /** Invalidate by App */
304
+ app?: App;
305
+ /** Invalidate by page id */
306
+ page?: Page;
307
+ /** Invalidate by URI path */
308
+ uri?: URI;
309
+ /** Invalidate by file (for media files such as PDFs) */
310
+ file?: File;
311
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
312
+ customTag?: CustomTag;
313
+ }
314
+ export interface App {
315
+ /**
316
+ * The AppDefId
317
+ * @minLength 1
318
+ */
319
+ appDefId?: string;
320
+ /**
321
+ * The instance Id
322
+ * @format GUID
323
+ */
324
+ instanceId?: string;
325
+ }
326
+ export interface Page {
327
+ /**
328
+ * the msid the page is on
329
+ * @format GUID
330
+ */
331
+ metaSiteId?: string;
332
+ /**
333
+ * Invalidate by Page ID
334
+ * @minLength 1
335
+ */
336
+ pageId?: string;
337
+ }
338
+ export interface URI {
339
+ /**
340
+ * the msid the URI is on
341
+ * @format GUID
342
+ */
343
+ metaSiteId?: string;
344
+ /**
345
+ * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
346
+ * @minLength 1
347
+ */
348
+ uriPath?: string;
349
+ }
350
+ export interface File {
351
+ /**
352
+ * the msid the file is related to
353
+ * @format GUID
354
+ */
355
+ metaSiteId?: string;
356
+ /**
357
+ * Invalidate by filename (for media files such as PDFs)
358
+ * @minLength 1
359
+ * @maxLength 256
360
+ */
361
+ fileName?: string;
362
+ }
363
+ export interface CustomTag {
364
+ /**
365
+ * the msid the tag is related to
366
+ * @format GUID
367
+ */
368
+ metaSiteId?: string;
369
+ /**
370
+ * Tag to invalidate by
371
+ * @minLength 1
372
+ * @maxLength 256
373
+ */
374
+ tag?: string;
375
+ }
376
+ export interface UpdateMySlugRequest {
377
+ /**
378
+ * New slug.
379
+ * @maxLength 255
380
+ */
381
+ slug: string;
382
+ }
383
+ export interface UpdateMySlugResponse {
384
+ /** Updated member. */
385
+ member?: Member;
386
+ }
387
+ export interface SlugAlreadyExistsPayload {
388
+ slug?: string;
389
+ }
390
+ export interface UpdateMemberSlugRequest {
391
+ /**
392
+ * Member ID.
393
+ * @format GUID
394
+ */
395
+ _id: string;
396
+ /**
397
+ * New slug.
398
+ * @maxLength 255
399
+ */
400
+ slug: string;
401
+ }
402
+ export interface UpdateMemberSlugResponse {
403
+ /** Updated member. */
404
+ member?: Member;
405
+ }
406
+ export interface JoinCommunityRequest {
407
+ }
408
+ /** Member profile. */
409
+ export interface JoinCommunityResponse {
410
+ /** The updated member. */
411
+ member?: Member;
412
+ }
413
+ export interface MemberJoinedCommunity {
414
+ /**
415
+ * ID of the member who joined the community.
416
+ * @format GUID
417
+ * @readonly
418
+ */
419
+ memberId?: string;
420
+ }
421
+ export interface LeaveCommunityRequest {
422
+ }
423
+ /** Member profile. */
424
+ export interface LeaveCommunityResponse {
425
+ /** The updated member. */
426
+ member?: Member;
427
+ }
428
+ export interface MemberLeftCommunity {
429
+ /**
430
+ * ID of the site member who left the community.
431
+ * @format GUID
432
+ * @readonly
433
+ */
434
+ memberId?: string;
435
+ }
436
+ export interface GetMyMemberRequest {
437
+ /**
438
+ * Predefined set of fields to return.
439
+ *
440
+ * Default: `"PUBLIC"`.
441
+ * @maxSize 3
442
+ */
443
+ fieldsets?: Set[];
444
+ }
445
+ export declare enum Set {
446
+ /**
447
+ * Includes `id`, `contactId`, `createdDate`, `updatedDate` and the `profile` object.
448
+ * `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
449
+ */
450
+ PUBLIC = "PUBLIC",
451
+ /** Includes `id`, `loginEmail`, `status`, `contactId`, `createdDate`, `updatedDate`, `privacyStatus`, `activityStatus` and the `profile` object. */
452
+ EXTENDED = "EXTENDED",
453
+ /** Includes all fields. */
454
+ FULL = "FULL"
455
+ }
456
+ /** Member profile. */
457
+ export interface GetMyMemberResponse {
458
+ /** The retrieved member. */
459
+ member?: Member;
460
+ }
461
+ export interface GetMemberRequest {
462
+ /**
463
+ * Member ID.
464
+ * @format GUID
465
+ */
466
+ _id: string;
467
+ /**
468
+ * Predefined set of fields to return.
469
+ *
470
+ * Defaults to `"PUBLIC"`.
471
+ * @maxSize 3
472
+ */
473
+ fieldsets?: Set[];
474
+ }
475
+ export interface GetMemberResponse {
476
+ /** The requested member. */
477
+ member?: Member;
478
+ }
479
+ export interface MemberToMemberBlockedPayload {
480
+ /**
481
+ * Member ID.
482
+ * @format GUID
483
+ */
484
+ memberId?: string;
485
+ }
486
+ export interface ListMembersRequest {
487
+ paging?: Paging;
488
+ /**
489
+ * Predefined sets of fields to return.
490
+ *
491
+ * Default: `"PUBLIC"`.
492
+ * @maxSize 3
493
+ */
494
+ fieldsets?: Set[];
495
+ sorting?: Sorting[];
496
+ }
497
+ export interface Paging {
498
+ /** Number of items to load. */
499
+ limit?: number | null;
500
+ /** Number of items to skip in the current sort order. */
501
+ offset?: number | null;
502
+ }
503
+ export interface Sorting {
504
+ /**
505
+ * Name of the field to sort by.
506
+ * @maxLength 512
507
+ */
508
+ fieldName?: string;
509
+ /** Sort order. */
510
+ order?: SortOrder;
511
+ }
512
+ export declare enum SortOrder {
513
+ ASC = "ASC",
514
+ DESC = "DESC"
515
+ }
516
+ export interface CursorPaging {
517
+ /**
518
+ * Maximum number of items to return in the results.
519
+ * @max 100
520
+ */
521
+ limit?: number | null;
522
+ /**
523
+ * Pointer to the next or previous page in the list of results.
524
+ *
525
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
526
+ * Not relevant for the first request.
527
+ * @maxLength 16000
528
+ */
529
+ cursor?: string | null;
530
+ }
531
+ export interface ListMembersResponse {
532
+ /** List of members. */
533
+ members?: Member[];
534
+ /** Metadata for the paginated results. */
535
+ metadata?: PagingMetadata;
536
+ }
537
+ export interface PagingMetadata {
538
+ /** Number of items returned in the response. */
539
+ count?: number | null;
540
+ /** Offset that was requested. */
541
+ offset?: number | null;
542
+ /** Total number of items that match the query. */
543
+ total?: number | null;
544
+ /** Flag that indicates the server failed to calculate the `total` field. */
545
+ tooManyToCount?: boolean | null;
546
+ }
547
+ export interface CursorPagingMetadata {
548
+ /** Number of items returned in the response. */
549
+ count?: number | null;
550
+ /** Cursor strings that point to the next page, previous page, or both. */
551
+ cursors?: Cursors;
552
+ /**
553
+ * Whether there are more pages to retrieve following the current page.
554
+ *
555
+ * + `true`: Another page of results can be retrieved.
556
+ * + `false`: This is the last page.
557
+ */
558
+ hasNext?: boolean | null;
559
+ }
560
+ export interface Cursors {
561
+ /**
562
+ * Cursor string pointing to the next page in the list of results.
563
+ * @maxLength 16000
564
+ */
565
+ next?: string | null;
566
+ /**
567
+ * Cursor pointing to the previous page in the list of results.
568
+ * @maxLength 16000
569
+ */
570
+ prev?: string | null;
571
+ }
572
+ export interface QueryMembersRequest {
573
+ /** Query options. */
574
+ query?: Query;
575
+ /**
576
+ * Predefined sets of fields to return.
577
+ *
578
+ * Default: `"PUBLIC"`.
579
+ * @maxSize 3
580
+ */
581
+ fieldsets?: Set[];
582
+ /** Plain text search. */
583
+ search?: Search;
584
+ }
585
+ export interface Query {
586
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
587
+ filter?: any;
588
+ /** Limit number of results */
589
+ paging?: Paging;
590
+ /** Sort the results */
591
+ sorting?: Sorting[];
592
+ }
593
+ /** Free text to match in searchable fields */
594
+ export interface Search {
595
+ /**
596
+ * Search term or expression.
597
+ * @minLength 1
598
+ * @maxLength 100
599
+ */
600
+ expression?: string | null;
601
+ /**
602
+ * Currently supported fields for search:
603
+ *
604
+ * - `loginEmail`
605
+ * - `contact.firstName`
606
+ * - `contact.lastName`
607
+ * - `profile.title`
608
+ * - `profile.nickname`
609
+ * - `profile.slug`
610
+ *
611
+ * Default: `profile.nickname`.
612
+ * @maxSize 4
613
+ */
614
+ fields?: string[];
615
+ }
616
+ export interface QueryMembersResponse {
617
+ /** List of members that met the query filter criteria. */
618
+ members?: Member[];
619
+ /** Metadata for the paginated results. */
620
+ metadata?: PagingMetadata;
621
+ }
622
+ export interface MuteMemberRequest {
623
+ /**
624
+ * ID of the member to mute.
625
+ * @format GUID
626
+ */
627
+ _id: string;
628
+ }
629
+ export interface MuteMemberResponse {
630
+ /** Muted member. */
631
+ member?: Member;
632
+ }
633
+ export interface MemberMuted {
634
+ /**
635
+ * ID of the member who got muted.
636
+ * @format GUID
637
+ * @readonly
638
+ */
639
+ memberId?: string;
640
+ }
641
+ export interface UnmuteMemberRequest {
642
+ /**
643
+ * ID of the member to unmute.
644
+ * @format GUID
645
+ */
646
+ _id: string;
647
+ }
648
+ export interface UnmuteMemberResponse {
649
+ /** Unmuted member. */
650
+ member?: Member;
651
+ }
652
+ export interface MemberUnmuted {
653
+ /**
654
+ * ID of the member who got unmuted.
655
+ * @format GUID
656
+ * @readonly
657
+ */
658
+ memberId?: string;
659
+ }
660
+ export interface ApproveMemberRequest {
661
+ /**
662
+ * ID of the member to approve.
663
+ * @format GUID
664
+ */
665
+ _id: string;
666
+ }
667
+ export interface ApproveMemberResponse {
668
+ /** Approved member. */
669
+ member?: Member;
670
+ }
671
+ export interface MemberApproved {
672
+ /**
673
+ * ID of the member who got approved.
674
+ * @format GUID
675
+ * @readonly
676
+ */
677
+ memberId?: string;
678
+ }
679
+ export interface BlockMemberRequest {
680
+ /**
681
+ * ID of a member to block.
682
+ * @format GUID
683
+ */
684
+ _id: string;
685
+ }
686
+ export interface BlockMemberResponse {
687
+ /** Blocked member. */
688
+ member?: Member;
689
+ }
690
+ export interface MemberBlocked {
691
+ /**
692
+ * ID of the member who got blocked.
693
+ * @format GUID
694
+ * @readonly
695
+ */
696
+ memberId?: string;
697
+ }
698
+ export interface MemberSelfBlockForbiddenPayload {
699
+ /**
700
+ * Target's member ID.
701
+ * @format GUID
702
+ */
703
+ memberId?: string;
704
+ }
705
+ export interface OwnerMemberBlockForbiddenPayload {
706
+ /**
707
+ * Owner's member ID.
708
+ * @format GUID
709
+ */
710
+ memberId?: string;
711
+ }
712
+ export interface ActiveSubscriptionMemberBlockForbiddenPayload {
713
+ /**
714
+ * Active subscription member ID.
715
+ * @format GUID
716
+ */
717
+ memberId?: string;
718
+ }
719
+ export interface DisconnectMemberRequest {
720
+ /**
721
+ * ID of a member to disconnect.
722
+ * @format GUID
723
+ */
724
+ _id: string;
725
+ }
726
+ export interface DisconnectMemberResponse {
727
+ /** Disconnected member. */
728
+ member?: Member;
729
+ }
730
+ export interface DeleteMemberRequest {
731
+ /**
732
+ * ID of a member to delete.
733
+ * @format GUID
734
+ */
735
+ _id: string;
736
+ }
737
+ export interface DeleteMemberResponse {
738
+ }
739
+ export interface ContentReassignmentRequested {
740
+ fromMember?: Member;
741
+ toMember?: Member;
742
+ }
743
+ export interface ContentDeletionRequested {
744
+ member?: Member;
745
+ }
746
+ export interface OwnerOrContributorDeleteForbiddenPayload {
747
+ /**
748
+ * Owner's or contributor's member ID.
749
+ * @format GUID
750
+ */
751
+ memberId?: string;
752
+ }
753
+ export interface ActiveSubscriptionMemberDeleteForbiddenPayload {
754
+ /**
755
+ * Active subscription member ID.
756
+ * @format GUID
757
+ */
758
+ memberId?: string;
759
+ }
760
+ export interface DeleteMyMemberRequest {
761
+ /**
762
+ * ID of a member receiving the deleted member's content.
763
+ * @format GUID
764
+ */
765
+ contentAssigneeId?: string | null;
766
+ }
767
+ export interface DeleteMyMemberResponse {
768
+ }
769
+ export interface BulkDeleteMembersRequest {
770
+ /**
771
+ * IDs of members to be deleted.
772
+ * @minSize 1
773
+ * @maxSize 100
774
+ * @format GUID
775
+ */
776
+ memberIds: string[];
777
+ }
778
+ export interface BulkDeleteMembersResponse {
779
+ /** Result. */
780
+ results?: BulkMemberResult[];
781
+ /** Bulk action result metadata. */
782
+ bulkActionMetadata?: BulkActionMetadata;
783
+ }
784
+ export interface ItemMetadata {
785
+ /**
786
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
787
+ * @maxLength 255
788
+ */
789
+ _id?: string | null;
790
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
791
+ originalIndex?: number;
792
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
793
+ success?: boolean;
794
+ /** Details about the error in case of failure. */
795
+ error?: ApplicationError;
796
+ }
797
+ export interface ApplicationError {
798
+ /** Error code. */
799
+ code?: string;
800
+ /** Description of the error. */
801
+ description?: string;
802
+ /** Data related to the error. */
803
+ data?: Record<string, any> | null;
804
+ }
805
+ export interface BulkMemberResult {
806
+ itemMetadata?: ItemMetadata;
807
+ }
808
+ export interface BulkActionMetadata {
809
+ /** Number of items that were successfully processed. */
810
+ totalSuccesses?: number;
811
+ /** Number of items that couldn't be processed. */
812
+ totalFailures?: number;
813
+ /** Number of failures without details because detailed failure threshold was exceeded. */
814
+ undetailedFailures?: number;
815
+ }
816
+ export interface BulkDeleteMembersByFilterRequest {
817
+ /** Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details. */
818
+ filter: any;
819
+ /**
820
+ * ID of a member receiving the deleted member's content.
821
+ * @format GUID
822
+ */
823
+ contentAssigneeId?: string | null;
824
+ /** Plain text search. */
825
+ search?: Search;
826
+ }
827
+ export interface BulkDeleteMembersByFilterResponse {
828
+ /**
829
+ * Job ID.
830
+ * Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
831
+ */
832
+ jobId?: string;
833
+ }
834
+ export interface BulkApproveMembersRequest {
835
+ /** Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details. */
836
+ filter: any;
837
+ }
838
+ export interface BulkApproveMembersResponse {
839
+ /**
840
+ * Job ID.
841
+ * Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
842
+ */
843
+ jobId?: string;
844
+ }
845
+ export interface BulkBlockMembersRequest {
846
+ /** Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details. */
847
+ filter: any;
848
+ }
849
+ export interface BulkBlockMembersResponse {
850
+ /**
851
+ * Job ID.
852
+ * Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
853
+ */
854
+ jobId?: string;
855
+ }
856
+ export interface CreateMemberRequest {
857
+ /** Member to create. */
858
+ member?: Member;
859
+ }
860
+ export interface CreateMemberResponse {
861
+ /** New member. */
862
+ member?: Member;
863
+ }
864
+ export interface UpdateMemberRequest {
865
+ /** Member info to update. */
866
+ member?: Member;
867
+ }
868
+ export interface UpdateMemberResponse {
869
+ /** Updated member. */
870
+ member?: Member;
871
+ }
872
+ export interface InvalidCustomFieldUrlPayload {
873
+ /** Custom field key and invalid URL. */
874
+ fields?: Record<string, string>;
875
+ }
876
+ export interface DeleteMemberPhonesRequest {
877
+ /**
878
+ * ID of the member whose phone numbers will be deleted.
879
+ * @format GUID
880
+ */
881
+ _id: string;
882
+ }
883
+ export interface DeleteMemberPhonesResponse {
884
+ /** Updated member. */
885
+ member?: Member;
886
+ }
887
+ export interface DeleteMemberEmailsRequest {
888
+ /**
889
+ * ID of the member whose email addresses will be deleted.
890
+ * @format GUID
891
+ */
892
+ _id: string;
893
+ }
894
+ export interface DeleteMemberEmailsResponse {
895
+ /** Updated member. */
896
+ member?: Member;
897
+ }
898
+ export interface DeleteMemberAddressesRequest {
899
+ /**
900
+ * ID of the member whose street addresses will be deleted.
901
+ * @format GUID
902
+ */
903
+ _id: string;
904
+ }
905
+ export interface DeleteMemberAddressesResponse {
906
+ /** Updated member. */
907
+ member?: Member;
908
+ }
909
+ export interface Empty {
910
+ }
911
+ export interface DomainEvent extends DomainEventBodyOneOf {
912
+ createdEvent?: EntityCreatedEvent;
913
+ updatedEvent?: EntityUpdatedEvent;
914
+ deletedEvent?: EntityDeletedEvent;
915
+ actionEvent?: ActionEvent;
916
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
917
+ _id?: string;
918
+ /**
919
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
920
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
921
+ */
922
+ entityFqdn?: string;
923
+ /**
924
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
925
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
926
+ */
927
+ slug?: string;
928
+ /** ID of the entity associated with the event. */
929
+ entityId?: string;
930
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
931
+ eventTime?: Date | null;
932
+ /**
933
+ * Whether the event was triggered as a result of a privacy regulation application
934
+ * (for example, GDPR).
935
+ */
936
+ triggeredByAnonymizeRequest?: boolean | null;
937
+ /** If present, indicates the action that triggered the event. */
938
+ originatedFrom?: string | null;
939
+ /**
940
+ * 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.
941
+ * 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.
942
+ */
943
+ entityEventSequence?: string | null;
944
+ }
945
+ /** @oneof */
946
+ export interface DomainEventBodyOneOf {
947
+ createdEvent?: EntityCreatedEvent;
948
+ updatedEvent?: EntityUpdatedEvent;
949
+ deletedEvent?: EntityDeletedEvent;
950
+ actionEvent?: ActionEvent;
951
+ }
952
+ export interface EntityCreatedEvent {
953
+ entity?: string;
954
+ }
955
+ export interface RestoreInfo {
956
+ deletedDate?: Date | null;
957
+ }
958
+ export interface EntityUpdatedEvent {
959
+ /**
960
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
961
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
962
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
963
+ */
964
+ currentEntity?: string;
965
+ }
966
+ export interface EntityDeletedEvent {
967
+ /** Entity that was deleted. */
968
+ deletedEntity?: string | null;
969
+ }
970
+ export interface ActionEvent {
971
+ body?: string;
972
+ }
973
+ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
974
+ /** Emitted on a meta site creation. */
975
+ siteCreated?: SiteCreated;
976
+ /** Emitted on a meta site transfer completion. */
977
+ siteTransferred?: SiteTransferred;
978
+ /** Emitted on a meta site deletion. */
979
+ siteDeleted?: SiteDeleted;
980
+ /** Emitted on a meta site restoration. */
981
+ siteUndeleted?: SiteUndeleted;
982
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
983
+ sitePublished?: SitePublished;
984
+ /** Emitted on a meta site unpublish. */
985
+ siteUnpublished?: SiteUnpublished;
986
+ /** Emitted when meta site is marked as template. */
987
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
988
+ /** Emitted when meta site is marked as a WixSite. */
989
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
990
+ /** Emitted when an application is provisioned (installed). */
991
+ serviceProvisioned?: ServiceProvisioned;
992
+ /** Emitted when an application is removed (uninstalled). */
993
+ serviceRemoved?: ServiceRemoved;
994
+ /** Emitted when meta site name (URL slug) is changed. */
995
+ siteRenamedPayload?: SiteRenamed;
996
+ /** Emitted when meta site was permanently deleted. */
997
+ hardDeleted?: SiteHardDeleted;
998
+ /** Emitted on a namespace change. */
999
+ namespaceChanged?: NamespaceChanged;
1000
+ /** Emitted when Studio is attached. */
1001
+ studioAssigned?: StudioAssigned;
1002
+ /** Emitted when Studio is detached. */
1003
+ studioUnassigned?: StudioUnassigned;
1004
+ /**
1005
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
1006
+ * the actual URL.
1007
+ *
1008
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
1009
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
1010
+ */
1011
+ urlChanged?: SiteUrlChanged;
1012
+ /** Site is marked as PurgedExternally */
1013
+ sitePurgedExternally?: SitePurgedExternally;
1014
+ /** Emitted when Odeditor is attached. */
1015
+ odeditorAssigned?: OdeditorAssigned;
1016
+ /** Emitted when Odeditor is detached. */
1017
+ odeditorUnassigned?: OdeditorUnassigned;
1018
+ /** Emitted when Picasso is attached. */
1019
+ picassoAssigned?: PicassoAssigned;
1020
+ /** Emitted when Picasso is detached. */
1021
+ picassoUnassigned?: PicassoUnassigned;
1022
+ /**
1023
+ * A meta site id.
1024
+ * @format GUID
1025
+ */
1026
+ metaSiteId?: string;
1027
+ /** A meta site version. Monotonically increasing. */
1028
+ version?: string;
1029
+ /** A timestamp of the event. */
1030
+ timestamp?: string;
1031
+ /**
1032
+ * TODO(meta-site): Change validation once validations are disabled for consumers
1033
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
1034
+ * @maxSize 4000
1035
+ */
1036
+ assets?: Asset[];
1037
+ }
1038
+ /** @oneof */
1039
+ export interface MetaSiteSpecialEventPayloadOneOf {
1040
+ /** Emitted on a meta site creation. */
1041
+ siteCreated?: SiteCreated;
1042
+ /** Emitted on a meta site transfer completion. */
1043
+ siteTransferred?: SiteTransferred;
1044
+ /** Emitted on a meta site deletion. */
1045
+ siteDeleted?: SiteDeleted;
1046
+ /** Emitted on a meta site restoration. */
1047
+ siteUndeleted?: SiteUndeleted;
1048
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
1049
+ sitePublished?: SitePublished;
1050
+ /** Emitted on a meta site unpublish. */
1051
+ siteUnpublished?: SiteUnpublished;
1052
+ /** Emitted when meta site is marked as template. */
1053
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
1054
+ /** Emitted when meta site is marked as a WixSite. */
1055
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
1056
+ /** Emitted when an application is provisioned (installed). */
1057
+ serviceProvisioned?: ServiceProvisioned;
1058
+ /** Emitted when an application is removed (uninstalled). */
1059
+ serviceRemoved?: ServiceRemoved;
1060
+ /** Emitted when meta site name (URL slug) is changed. */
1061
+ siteRenamedPayload?: SiteRenamed;
1062
+ /** Emitted when meta site was permanently deleted. */
1063
+ hardDeleted?: SiteHardDeleted;
1064
+ /** Emitted on a namespace change. */
1065
+ namespaceChanged?: NamespaceChanged;
1066
+ /** Emitted when Studio is attached. */
1067
+ studioAssigned?: StudioAssigned;
1068
+ /** Emitted when Studio is detached. */
1069
+ studioUnassigned?: StudioUnassigned;
1070
+ /**
1071
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
1072
+ * the actual URL.
1073
+ *
1074
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
1075
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
1076
+ */
1077
+ urlChanged?: SiteUrlChanged;
1078
+ /** Site is marked as PurgedExternally */
1079
+ sitePurgedExternally?: SitePurgedExternally;
1080
+ /** Emitted when Odeditor is attached. */
1081
+ odeditorAssigned?: OdeditorAssigned;
1082
+ /** Emitted when Odeditor is detached. */
1083
+ odeditorUnassigned?: OdeditorUnassigned;
1084
+ /** Emitted when Picasso is attached. */
1085
+ picassoAssigned?: PicassoAssigned;
1086
+ /** Emitted when Picasso is detached. */
1087
+ picassoUnassigned?: PicassoUnassigned;
1088
+ }
1089
+ export interface Asset {
1090
+ /**
1091
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
1092
+ * @maxLength 36
1093
+ */
1094
+ appDefId?: string;
1095
+ /**
1096
+ * An instance id. For legacy reasons may be UUID or a string.
1097
+ * @maxLength 200
1098
+ */
1099
+ instanceId?: string;
1100
+ /** An application state. */
1101
+ state?: State;
1102
+ }
1103
+ export declare enum State {
1104
+ UNKNOWN = "UNKNOWN",
1105
+ ENABLED = "ENABLED",
1106
+ DISABLED = "DISABLED",
1107
+ PENDING = "PENDING",
1108
+ DEMO = "DEMO"
1109
+ }
1110
+ export interface SiteCreated {
1111
+ /**
1112
+ * A template identifier (empty if not created from a template).
1113
+ * @maxLength 36
1114
+ */
1115
+ originTemplateId?: string;
1116
+ /**
1117
+ * An account id of the owner.
1118
+ * @format GUID
1119
+ */
1120
+ ownerId?: string;
1121
+ /** A context in which meta site was created. */
1122
+ context?: SiteCreatedContext;
1123
+ /**
1124
+ * A meta site id from which this site was created.
1125
+ *
1126
+ * In case of a creation from a template it's a template id.
1127
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
1128
+ * @format GUID
1129
+ */
1130
+ originMetaSiteId?: string | null;
1131
+ /**
1132
+ * A meta site name (URL slug).
1133
+ * @maxLength 20
1134
+ */
1135
+ siteName?: string;
1136
+ /** A namespace. */
1137
+ namespace?: Namespace;
1138
+ }
1139
+ export declare enum SiteCreatedContext {
1140
+ /** A valid option, we don't expose all reasons why site might be created. */
1141
+ OTHER = "OTHER",
1142
+ /** A meta site was created from template. */
1143
+ FROM_TEMPLATE = "FROM_TEMPLATE",
1144
+ /** A meta site was created by copying of the transfferred meta site. */
1145
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
1146
+ /** A copy of existing meta site. */
1147
+ DUPLICATE = "DUPLICATE",
1148
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
1149
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
1150
+ /** deprecated A meta site was created for Flash editor. */
1151
+ FLASH = "FLASH"
1152
+ }
1153
+ export declare enum Namespace {
1154
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
1155
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
1156
+ WIX = "WIX",
1157
+ /** 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. */
1158
+ SHOUT_OUT = "SHOUT_OUT",
1159
+ /** 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. */
1160
+ ALBUMS = "ALBUMS",
1161
+ /** 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. */
1162
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
1163
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1164
+ HOTELS = "HOTELS",
1165
+ /** 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. */
1166
+ CLUBS = "CLUBS",
1167
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1168
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
1169
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1170
+ DEV_SITE = "DEV_SITE",
1171
+ /** 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. */
1172
+ LOGOS = "LOGOS",
1173
+ /** 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. */
1174
+ VIDEO_MAKER = "VIDEO_MAKER",
1175
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1176
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
1177
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1178
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
1179
+ /**
1180
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
1181
+ *
1182
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
1183
+ */
1184
+ HTML_DRAFT = "HTML_DRAFT",
1185
+ /**
1186
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
1187
+ * Will be accessible from Site List and will not have a website app.
1188
+ * Once the user attaches a site, the site will become a regular wixsite.
1189
+ */
1190
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
1191
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
1192
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
1193
+ /** It is to be used in the Business First efforts. */
1194
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
1195
+ /** Bookings business flow with no site. */
1196
+ ANYWHERE = "ANYWHERE",
1197
+ /** Namespace for Headless Backoffice with no editor */
1198
+ HEADLESS = "HEADLESS",
1199
+ /**
1200
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
1201
+ * The site will be used for account level CSM feature for enterprise
1202
+ */
1203
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
1204
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
1205
+ RISE = "RISE",
1206
+ /**
1207
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
1208
+ * There's a blank site behind the scene but it's blank).
1209
+ * The Mobile company will be the owner of this namespace.
1210
+ */
1211
+ BRANDED_FIRST = "BRANDED_FIRST",
1212
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
1213
+ NOWNIA = "NOWNIA",
1214
+ /**
1215
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
1216
+ * The Partners company owns this namespace.
1217
+ */
1218
+ UGC_TEMPLATE = "UGC_TEMPLATE",
1219
+ /** Codux Headless Sites */
1220
+ CODUX = "CODUX",
1221
+ /** Bobb - AI Design Creator. */
1222
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
1223
+ /**
1224
+ * Shared Blog Site is a unique single site across Enterprise account,
1225
+ * This site will hold all Blog posts related to the Marketing product.
1226
+ */
1227
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
1228
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1229
+ STANDALONE_FORMS = "STANDALONE_FORMS",
1230
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1231
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
1232
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
1233
+ MIMIR = "MIMIR"
1234
+ }
1235
+ /** Site transferred to another user. */
1236
+ export interface SiteTransferred {
1237
+ /**
1238
+ * A previous owner id (user that transfers meta site).
1239
+ * @format GUID
1240
+ */
1241
+ oldOwnerId?: string;
1242
+ /**
1243
+ * A new owner id (user that accepts meta site).
1244
+ * @format GUID
1245
+ */
1246
+ newOwnerId?: string;
1247
+ }
1248
+ /** Soft deletion of the meta site. Could be restored. */
1249
+ export interface SiteDeleted {
1250
+ /** A deletion context. */
1251
+ deleteContext?: DeleteContext;
1252
+ }
1253
+ export interface DeleteContext {
1254
+ /** When the meta site was deleted. */
1255
+ dateDeleted?: Date | null;
1256
+ /** A status. */
1257
+ deleteStatus?: DeleteStatus;
1258
+ /**
1259
+ * A reason (flow).
1260
+ * @maxLength 255
1261
+ */
1262
+ deleteOrigin?: string;
1263
+ /**
1264
+ * A service that deleted it.
1265
+ * @maxLength 255
1266
+ */
1267
+ initiatorId?: string | null;
1268
+ }
1269
+ export declare enum DeleteStatus {
1270
+ UNKNOWN = "UNKNOWN",
1271
+ TRASH = "TRASH",
1272
+ DELETED = "DELETED",
1273
+ PENDING_PURGE = "PENDING_PURGE",
1274
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
1275
+ }
1276
+ /** Restoration of the meta site. */
1277
+ export interface SiteUndeleted {
1278
+ }
1279
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
1280
+ export interface SitePublished {
1281
+ }
1282
+ export interface SiteUnpublished {
1283
+ /**
1284
+ * A list of URLs previously associated with the meta site.
1285
+ * @maxLength 4000
1286
+ * @maxSize 10000
1287
+ */
1288
+ urls?: string[];
1289
+ }
1290
+ export interface SiteMarkedAsTemplate {
1291
+ }
1292
+ export interface SiteMarkedAsWixSite {
1293
+ }
1294
+ /**
1295
+ * Represents a service provisioned a site.
1296
+ *
1297
+ * Note on `origin_instance_id`:
1298
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
1299
+ * This is because of the following scenario:
1300
+ *
1301
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
1302
+ * such as a product catalog. When you create a site from this template, you inherit this
1303
+ * default product catalog. However, if the template's product catalog is modified,
1304
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
1305
+ * your site remains consistent with what you initially received and does not include any
1306
+ * changes made to the original template afterward.
1307
+ * To ensure this, the TPA on the template gets a new instance_id.
1308
+ */
1309
+ export interface ServiceProvisioned {
1310
+ /**
1311
+ * Either UUID or EmbeddedServiceType.
1312
+ * @maxLength 36
1313
+ */
1314
+ appDefId?: string;
1315
+ /**
1316
+ * Not only UUID. Something here could be something weird.
1317
+ * @maxLength 36
1318
+ */
1319
+ instanceId?: string;
1320
+ /**
1321
+ * An instance id from which this instance is originated.
1322
+ * @maxLength 36
1323
+ */
1324
+ originInstanceId?: string;
1325
+ /**
1326
+ * A version.
1327
+ * @maxLength 500
1328
+ */
1329
+ version?: string | null;
1330
+ /**
1331
+ * The origin meta site id
1332
+ * @format GUID
1333
+ */
1334
+ originMetaSiteId?: string | null;
1335
+ }
1336
+ export interface ServiceRemoved {
1337
+ /**
1338
+ * Either UUID or EmbeddedServiceType.
1339
+ * @maxLength 36
1340
+ */
1341
+ appDefId?: string;
1342
+ /**
1343
+ * Not only UUID. Something here could be something weird.
1344
+ * @maxLength 36
1345
+ */
1346
+ instanceId?: string;
1347
+ /**
1348
+ * A version.
1349
+ * @maxLength 500
1350
+ */
1351
+ version?: string | null;
1352
+ }
1353
+ /** Rename of the site. Meaning, free public url has been changed as well. */
1354
+ export interface SiteRenamed {
1355
+ /**
1356
+ * A new meta site name (URL slug).
1357
+ * @maxLength 20
1358
+ */
1359
+ newSiteName?: string;
1360
+ /**
1361
+ * A previous meta site name (URL slug).
1362
+ * @maxLength 255
1363
+ */
1364
+ oldSiteName?: string;
1365
+ }
1366
+ /**
1367
+ * Hard deletion of the meta site.
1368
+ *
1369
+ * Could not be restored. Therefore it's desirable to cleanup data.
1370
+ */
1371
+ export interface SiteHardDeleted {
1372
+ /** A deletion context. */
1373
+ deleteContext?: DeleteContext;
1374
+ }
1375
+ export interface NamespaceChanged {
1376
+ /** A previous namespace. */
1377
+ oldNamespace?: Namespace;
1378
+ /** A new namespace. */
1379
+ newNamespace?: Namespace;
1380
+ }
1381
+ /** Assigned Studio editor */
1382
+ export interface StudioAssigned {
1383
+ }
1384
+ /** Unassigned Studio editor */
1385
+ export interface StudioUnassigned {
1386
+ }
1387
+ /**
1388
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
1389
+ *
1390
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
1391
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
1392
+ *
1393
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
1394
+ */
1395
+ export interface SiteUrlChanged {
1396
+ }
1397
+ /**
1398
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
1399
+ * Consumed by other teams to remove relevant data.
1400
+ */
1401
+ export interface SitePurgedExternally {
1402
+ /**
1403
+ * @maxLength 2048
1404
+ * @maxSize 100
1405
+ * @deprecated
1406
+ * @targetRemovalDate 2025-04-15
1407
+ */
1408
+ appDefId?: string[];
1409
+ }
1410
+ /** Assigned Odeditor */
1411
+ export interface OdeditorAssigned {
1412
+ }
1413
+ /** Unassigned Odeditor */
1414
+ export interface OdeditorUnassigned {
1415
+ }
1416
+ /** Assigned Picasso editor */
1417
+ export interface PicassoAssigned {
1418
+ }
1419
+ /** Unassigned Picasso */
1420
+ export interface PicassoUnassigned {
1421
+ }
1422
+ export interface MemberOwnershipTransferred {
1423
+ fromMember?: Member;
1424
+ toMember?: Member;
1425
+ }
1426
+ export interface MemberIdChanged {
1427
+ /** @format GUID */
1428
+ fromId?: string;
1429
+ /** @format GUID */
1430
+ toId?: string;
1431
+ }
1432
+ export interface MessageEnvelope {
1433
+ /**
1434
+ * App instance ID.
1435
+ * @format GUID
1436
+ */
1437
+ instanceId?: string | null;
1438
+ /**
1439
+ * Event type.
1440
+ * @maxLength 150
1441
+ */
1442
+ eventType?: string;
1443
+ /** The identification type and identity data. */
1444
+ identity?: IdentificationData;
1445
+ /** Stringify payload. */
1446
+ data?: string;
1447
+ }
1448
+ export interface IdentificationData extends IdentificationDataIdOneOf {
1449
+ /**
1450
+ * ID of a site visitor that has not logged in to the site.
1451
+ * @format GUID
1452
+ */
1453
+ anonymousVisitorId?: string;
1454
+ /**
1455
+ * ID of a site visitor that has logged in to the site.
1456
+ * @format GUID
1457
+ */
1458
+ memberId?: string;
1459
+ /**
1460
+ * ID of a Wix user (site owner, contributor, etc.).
1461
+ * @format GUID
1462
+ */
1463
+ wixUserId?: string;
1464
+ /**
1465
+ * ID of an app.
1466
+ * @format GUID
1467
+ */
1468
+ appId?: string;
1469
+ /** @readonly */
1470
+ identityType?: WebhookIdentityType;
1471
+ }
1472
+ /** @oneof */
1473
+ export interface IdentificationDataIdOneOf {
1474
+ /**
1475
+ * ID of a site visitor that has not logged in to the site.
1476
+ * @format GUID
1477
+ */
1478
+ anonymousVisitorId?: string;
1479
+ /**
1480
+ * ID of a site visitor that has logged in to the site.
1481
+ * @format GUID
1482
+ */
1483
+ memberId?: string;
1484
+ /**
1485
+ * ID of a Wix user (site owner, contributor, etc.).
1486
+ * @format GUID
1487
+ */
1488
+ wixUserId?: string;
1489
+ /**
1490
+ * ID of an app.
1491
+ * @format GUID
1492
+ */
1493
+ appId?: string;
1494
+ }
1495
+ export declare enum WebhookIdentityType {
1496
+ UNKNOWN = "UNKNOWN",
1497
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1498
+ MEMBER = "MEMBER",
1499
+ WIX_USER = "WIX_USER",
1500
+ APP = "APP"
1501
+ }
1502
+ export interface BaseEventMetadata {
1503
+ /**
1504
+ * App instance ID.
1505
+ * @format GUID
1506
+ */
1507
+ instanceId?: string | null;
1508
+ /**
1509
+ * Event type.
1510
+ * @maxLength 150
1511
+ */
1512
+ eventType?: string;
1513
+ /** The identification type and identity data. */
1514
+ identity?: IdentificationData;
1515
+ }
1516
+ export interface EventMetadata extends BaseEventMetadata {
1517
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1518
+ _id?: string;
1519
+ /**
1520
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1521
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1522
+ */
1523
+ entityFqdn?: string;
1524
+ /**
1525
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1526
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1527
+ */
1528
+ slug?: string;
1529
+ /** ID of the entity associated with the event. */
1530
+ entityId?: string;
1531
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1532
+ eventTime?: Date | null;
1533
+ /**
1534
+ * Whether the event was triggered as a result of a privacy regulation application
1535
+ * (for example, GDPR).
1536
+ */
1537
+ triggeredByAnonymizeRequest?: boolean | null;
1538
+ /** If present, indicates the action that triggered the event. */
1539
+ originatedFrom?: string | null;
1540
+ /**
1541
+ * 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.
1542
+ * 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.
1543
+ */
1544
+ entityEventSequence?: string | null;
1545
+ }
1546
+ export interface MemberCreatedEnvelope {
1547
+ entity: Member;
1548
+ metadata: EventMetadata;
1549
+ }
1550
+ /**
1551
+ * Triggered when a member is created.
1552
+ *
1553
+ * The site owner can configure the site to automatically approve members or require manual approval.
1554
+ *
1555
+ * A member who has been approved either automatically or manually has a `status` of `"APPROVED"`. A created member waiting for approval has a `status` of `"PENDING"`. A `"PENDING"` member can't log in to the site.
1556
+ * @permissionScope Manage Stores
1557
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1558
+ * @permissionScope Manage Members
1559
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1560
+ * @permissionScope Manage Bookings Services and Settings
1561
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1562
+ * @permissionScope Manage Events
1563
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1564
+ * @permissionScope Manage Challenges
1565
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1566
+ * @permissionScope Manage Portfolio
1567
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1568
+ * @permissionScope Access Verticals by Automations
1569
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1570
+ * @permissionScope Read Members and Contacts - all read permissions
1571
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1572
+ * @permissionScope Manage Restaurants - all permissions
1573
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1574
+ * @permissionScope Read Members
1575
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1576
+ * @permissionScope Set Up Automations
1577
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1578
+ * @permissionScope Manage Members and Contacts - all permissions
1579
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1580
+ * @permissionId MEMBERS.MEMBER_READ
1581
+ * @webhook
1582
+ * @eventType wix.members.v1.member_created
1583
+ * @serviceIdentifier com.wixpress.members.api.Members
1584
+ * @slug created
1585
+ */
1586
+ export declare function onMemberCreated(handler: (event: MemberCreatedEnvelope) => void | Promise<void>): void;
1587
+ export interface MemberDeletedEnvelope {
1588
+ metadata: EventMetadata;
1589
+ }
1590
+ /**
1591
+ * Triggered when a member is deleted.
1592
+ * @permissionScope Manage Stores
1593
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1594
+ * @permissionScope Manage Members
1595
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1596
+ * @permissionScope Manage Bookings Services and Settings
1597
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1598
+ * @permissionScope Manage Events
1599
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1600
+ * @permissionScope Manage Challenges
1601
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1602
+ * @permissionScope Manage Portfolio
1603
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1604
+ * @permissionScope Access Verticals by Automations
1605
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1606
+ * @permissionScope Read Members and Contacts - all read permissions
1607
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1608
+ * @permissionScope Manage Restaurants - all permissions
1609
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1610
+ * @permissionScope Read Members
1611
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1612
+ * @permissionScope Set Up Automations
1613
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1614
+ * @permissionScope Manage Members and Contacts - all permissions
1615
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1616
+ * @permissionId MEMBERS.MEMBER_READ
1617
+ * @webhook
1618
+ * @eventType wix.members.v1.member_deleted
1619
+ * @serviceIdentifier com.wixpress.members.api.Members
1620
+ * @slug deleted
1621
+ */
1622
+ export declare function onMemberDeleted(handler: (event: MemberDeletedEnvelope) => void | Promise<void>): void;
1623
+ export interface MemberUpdatedEnvelope {
1624
+ entity: Member;
1625
+ metadata: EventMetadata;
1626
+ }
1627
+ /** @permissionScope Manage Stores
1628
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1629
+ * @permissionScope Manage Members
1630
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1631
+ * @permissionScope Manage Bookings Services and Settings
1632
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1633
+ * @permissionScope Manage Events
1634
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1635
+ * @permissionScope Manage Challenges
1636
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1637
+ * @permissionScope Manage Portfolio
1638
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1639
+ * @permissionScope Access Verticals by Automations
1640
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1641
+ * @permissionScope Read Members and Contacts - all read permissions
1642
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1643
+ * @permissionScope Manage Restaurants - all permissions
1644
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1645
+ * @permissionScope Read Members
1646
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1647
+ * @permissionScope Set Up Automations
1648
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1649
+ * @permissionScope Manage Members and Contacts - all permissions
1650
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1651
+ * @permissionId MEMBERS.MEMBER_READ
1652
+ * @webhook
1653
+ * @eventType wix.members.v1.member_updated
1654
+ * @serviceIdentifier com.wixpress.members.api.Members
1655
+ * @slug updated
1656
+ */
1657
+ export declare function onMemberUpdated(handler: (event: MemberUpdatedEnvelope) => void | Promise<void>): void;
1658
+ type MemberNonNullablePaths = `status` | `contact.phones` | `contact.emails` | `contact.addresses` | `contact.addresses.${number}.streetAddress.number` | `contact.addresses.${number}.streetAddress.name` | `profile.photo._id` | `profile.photo.url` | `profile.photo.height` | `profile.photo.width` | `privacyStatus` | `activityStatus`;
1659
+ /**
1660
+ * Updates the currently logged in member's slug.
1661
+ *
1662
+ * The `slug` is the end of a member's URL that refers to a specific logged-in member. For example, if a member's URL is `https://example.com/member/{my-member-slug}`, the slug is `my-member-slug`. The slug is case-sensitive and is generally derived from the member's `nickname`; otherwise, it's derived from the `loginEmail`.
1663
+ *
1664
+ * > **Note:**
1665
+ * > Only logged-in members can call this method without elevated permissions.
1666
+ * > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
1667
+ * @param slug - New slug.
1668
+ * @public
1669
+ * @requiredField slug
1670
+ * @permissionId MEMBERS.MEMBER_UPDATE
1671
+ * @permissionScope Manage Stores
1672
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1673
+ * @permissionScope Manage Members
1674
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1675
+ * @permissionScope Manage Bookings Services and Settings
1676
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1677
+ * @permissionScope Manage Events
1678
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1679
+ * @permissionScope Manage Challenges
1680
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1681
+ * @permissionScope Manage Portfolio
1682
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1683
+ * @permissionScope Access Verticals by Automations
1684
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1685
+ * @permissionScope Manage Restaurants - all permissions
1686
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1687
+ * @permissionScope Set Up Automations
1688
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1689
+ * @applicableIdentity APP
1690
+ * @applicableIdentity MEMBER
1691
+ * @fqn com.wixpress.members.api.Members.UpdateMySlug
1692
+ */
1693
+ export declare function updateCurrentMemberSlug(slug: string): Promise<NonNullablePaths<UpdateMySlugResponse, {
1694
+ [P in MemberNonNullablePaths]: `member.${P}`;
1695
+ }[MemberNonNullablePaths]>>;
1696
+ /**
1697
+ * Updates a member's slug.
1698
+ * @param _id - Member ID.
1699
+ * @param slug - New slug.
1700
+ * @public
1701
+ * @requiredField _id
1702
+ * @requiredField slug
1703
+ * @permissionId MEMBERS.MEMBER_UPDATE
1704
+ * @permissionScope Manage Stores
1705
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1706
+ * @permissionScope Manage Members
1707
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1708
+ * @permissionScope Manage Bookings Services and Settings
1709
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1710
+ * @permissionScope Manage Events
1711
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1712
+ * @permissionScope Manage Challenges
1713
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1714
+ * @permissionScope Manage Portfolio
1715
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1716
+ * @permissionScope Access Verticals by Automations
1717
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1718
+ * @permissionScope Manage Restaurants - all permissions
1719
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1720
+ * @permissionScope Set Up Automations
1721
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1722
+ * @applicableIdentity APP
1723
+ * @applicableIdentity MEMBER
1724
+ * @fqn com.wixpress.members.api.Members.UpdateMemberSlug
1725
+ */
1726
+ export declare function updateMemberSlug(_id: string, slug: string): Promise<NonNullablePaths<UpdateMemberSlugResponse, {
1727
+ [P in MemberNonNullablePaths]: `member.${P}`;
1728
+ }[MemberNonNullablePaths]>>;
1729
+ /**
1730
+ * Joins the current member to the site community and sets their profile to public.
1731
+ *
1732
+ * When a member's profile is public, they have access to the site's
1733
+ * [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
1734
+ * features, such as chat, forum, and followers,
1735
+ * and their profile is visible to other members and site visitors.
1736
+ *
1737
+ * > **Note:**
1738
+ * > Only logged-in members can call this method without elevated permissions.
1739
+ * > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
1740
+ * @public
1741
+ * @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY
1742
+ * @permissionScope Manage Members
1743
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1744
+ * @applicableIdentity APP
1745
+ * @applicableIdentity MEMBER
1746
+ * @returns Member profile.
1747
+ * @fqn com.wixpress.members.api.Members.JoinCommunity
1748
+ */
1749
+ export declare function joinCommunity(): Promise<NonNullablePaths<JoinCommunityResponse, {
1750
+ [P in MemberNonNullablePaths]: `member.${P}`;
1751
+ }[MemberNonNullablePaths]>>;
1752
+ /**
1753
+ * Removes the current member from the site community and sets their profile to private.
1754
+ *
1755
+ * When a member's profile is private,
1756
+ * they do not have access to the site's
1757
+ * [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
1758
+ * features, such as chat, forum, and followers,
1759
+ * and their profile is hidden from other members and site visitors.
1760
+ *
1761
+ * > **Notes:**
1762
+ * > + If a member leaves the site's community, their content, such as forum posts and blog comments, remain publicly visible.
1763
+ *
1764
+ * > + Only logged-in members can call this method without elevated permissions.
1765
+ * > + To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
1766
+ * @public
1767
+ * @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY
1768
+ * @permissionScope Manage Members
1769
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1770
+ * @applicableIdentity APP
1771
+ * @applicableIdentity MEMBER
1772
+ * @returns Member profile.
1773
+ * @fqn com.wixpress.members.api.Members.LeaveCommunity
1774
+ */
1775
+ export declare function leaveCommunity(): Promise<NonNullablePaths<LeaveCommunityResponse, {
1776
+ [P in MemberNonNullablePaths]: `member.${P}`;
1777
+ }[MemberNonNullablePaths]>>;
1778
+ /**
1779
+ * Retrieves the current member.
1780
+ *
1781
+ * >**Note:**
1782
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
1783
+ * @public
1784
+ * @permissionId MEMBERS.MEMBER_READ
1785
+ * @permissionScope Manage Stores
1786
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1787
+ * @permissionScope Manage Members
1788
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1789
+ * @permissionScope Manage Bookings Services and Settings
1790
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1791
+ * @permissionScope Manage Events
1792
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1793
+ * @permissionScope Manage Challenges
1794
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1795
+ * @permissionScope Manage Portfolio
1796
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1797
+ * @permissionScope Access Verticals by Automations
1798
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1799
+ * @permissionScope Read Members and Contacts - all read permissions
1800
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1801
+ * @permissionScope Manage Restaurants - all permissions
1802
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1803
+ * @permissionScope Read Members
1804
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1805
+ * @permissionScope Set Up Automations
1806
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1807
+ * @permissionScope Manage Members and Contacts - all permissions
1808
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1809
+ * @applicableIdentity APP
1810
+ * @applicableIdentity VISITOR
1811
+ * @returns Member profile.
1812
+ * @fqn com.wixpress.members.api.Members.GetMyMember
1813
+ */
1814
+ export declare function getCurrentMember(options?: GetCurrentMemberOptions): Promise<NonNullablePaths<GetMyMemberResponse, {
1815
+ [P in MemberNonNullablePaths]: `member.${P}`;
1816
+ }[MemberNonNullablePaths]>>;
1817
+ export interface GetCurrentMemberOptions {
1818
+ /**
1819
+ * Predefined set of fields to return.
1820
+ *
1821
+ * Default: `"PUBLIC"`.
1822
+ * @maxSize 3
1823
+ */
1824
+ fieldsets?: Set[];
1825
+ }
1826
+ /**
1827
+ * Retrieves a member by ID.
1828
+ *
1829
+ * >**Note:** The returned Member object contains only the fields that were explicitly added to the Member object. Custom Contact fields are **not** automatically added to the Member object. They must be [added to the Member object by the site owner](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).
1830
+ *
1831
+ * @param _id - Member ID.
1832
+ * @public
1833
+ * @requiredField _id
1834
+ * @param options - Fieldset options.
1835
+ * @permissionId MEMBERS.MEMBER_READ
1836
+ * @permissionScope Manage Stores
1837
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1838
+ * @permissionScope Manage Members
1839
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1840
+ * @permissionScope Manage Bookings Services and Settings
1841
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1842
+ * @permissionScope Manage Events
1843
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1844
+ * @permissionScope Manage Challenges
1845
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1846
+ * @permissionScope Manage Portfolio
1847
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1848
+ * @permissionScope Access Verticals by Automations
1849
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1850
+ * @permissionScope Read Members and Contacts - all read permissions
1851
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1852
+ * @permissionScope Manage Restaurants - all permissions
1853
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1854
+ * @permissionScope Read Members
1855
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1856
+ * @permissionScope Set Up Automations
1857
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1858
+ * @permissionScope Manage Members and Contacts - all permissions
1859
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1860
+ * @applicableIdentity APP
1861
+ * @applicableIdentity VISITOR
1862
+ * @returns The requested member.
1863
+ * @fqn com.wixpress.members.api.Members.GetMember
1864
+ */
1865
+ export declare function getMember(_id: string, options?: GetMemberOptions): Promise<NonNullablePaths<Member, MemberNonNullablePaths>>;
1866
+ export interface GetMemberOptions {
1867
+ /**
1868
+ * Predefined set of fields to return.
1869
+ *
1870
+ * Defaults to `"PUBLIC"`.
1871
+ * @maxSize 3
1872
+ */
1873
+ fieldsets?: Set[];
1874
+ }
1875
+ /**
1876
+ * Lists site members, given the provided paging and fieldsets.
1877
+ * @public
1878
+ * @param options - Options for paging, sorting, and specifying fields to return.
1879
+ * @permissionId MEMBERS.MEMBER_READ
1880
+ * @permissionScope Manage Stores
1881
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1882
+ * @permissionScope Manage Members
1883
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1884
+ * @permissionScope Manage Bookings Services and Settings
1885
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1886
+ * @permissionScope Manage Events
1887
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1888
+ * @permissionScope Manage Challenges
1889
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1890
+ * @permissionScope Manage Portfolio
1891
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1892
+ * @permissionScope Access Verticals by Automations
1893
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1894
+ * @permissionScope Read Members and Contacts - all read permissions
1895
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1896
+ * @permissionScope Manage Restaurants - all permissions
1897
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1898
+ * @permissionScope Read Members
1899
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1900
+ * @permissionScope Set Up Automations
1901
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1902
+ * @permissionScope Manage Members and Contacts - all permissions
1903
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1904
+ * @applicableIdentity APP
1905
+ * @applicableIdentity VISITOR
1906
+ * @fqn com.wixpress.members.api.Members.ListMembers
1907
+ */
1908
+ export declare function listMembers(options?: ListMembersOptions): Promise<NonNullablePaths<ListMembersResponse, {
1909
+ [P in MemberNonNullablePaths]: `members.${number}.${P}`;
1910
+ }[MemberNonNullablePaths]>>;
1911
+ export interface ListMembersOptions {
1912
+ /** Paging options. */
1913
+ paging?: Paging;
1914
+ /**
1915
+ * Predefined sets of fields to return.
1916
+ *
1917
+ * Default: `"PUBLIC"`.
1918
+ * @maxSize 3
1919
+ */
1920
+ fieldsets?: Set[];
1921
+ /** Sorting options. */
1922
+ sorting?: Sorting[];
1923
+ }
1924
+ /**
1925
+ * Retrieves a list of up to 100 members, given the specified filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object.
1926
+ *
1927
+ * The returned object contains the query definition which is typically used to run the query using the `find()` method.
1928
+ *
1929
+ * You can refine the query by chaining `MembersQueryBuilder` methods onto the query. `MembersQueryBuilder` methods enable you to sort, filter, and control the results that `queryMembers()` returns. The methods that are chained to `queryMembers()` are applied in the order they are called.
1930
+ *
1931
+ * `queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override:
1932
+ * - `skip`: `0`
1933
+ * - `limit`: `50`
1934
+ *
1935
+ * Currently supported fields for sorting:
1936
+ * - `profile.nickname`
1937
+ * - `contact.firstName`
1938
+ * - `contact.lastName`
1939
+ * - `createdDate`
1940
+ * - `lastLoginDate`
1941
+ *
1942
+ * The following `MembersQueryBuilder` methods are supported for the `queryMembers()` method. For a full description of the Locations object, see the returned for the `items` property in `MembersQueryResult`.
1943
+ * @public
1944
+ * @param options - Query options.
1945
+ * @permissionScope Manage Stores
1946
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1947
+ * @permissionScope Manage Members
1948
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1949
+ * @permissionScope Manage Bookings Services and Settings
1950
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1951
+ * @permissionScope Manage Events
1952
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1953
+ * @permissionScope Manage Challenges
1954
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1955
+ * @permissionScope Manage Portfolio
1956
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1957
+ * @permissionScope Access Verticals by Automations
1958
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1959
+ * @permissionScope Read Members and Contacts - all read permissions
1960
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1961
+ * @permissionScope Manage Restaurants - all permissions
1962
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1963
+ * @permissionScope Read Members
1964
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1965
+ * @permissionScope Set Up Automations
1966
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1967
+ * @permissionScope Manage Members and Contacts - all permissions
1968
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1969
+ * @permissionId MEMBERS.MEMBER_READ
1970
+ * @applicableIdentity APP
1971
+ * @applicableIdentity VISITOR
1972
+ * @fqn com.wixpress.members.api.Members.QueryMembers
1973
+ */
1974
+ export declare function queryMembers(options?: QueryMembersOptions): MembersQueryBuilder;
1975
+ export interface QueryMembersOptions {
1976
+ /**
1977
+ * Predefined sets of fields to return.
1978
+ *
1979
+ * Default: `"PUBLIC"`.
1980
+ * @maxSize 3
1981
+ */
1982
+ fieldsets?: Set[] | undefined;
1983
+ /** Plain text search. */
1984
+ search?: Search | undefined;
1985
+ }
1986
+ interface QueryOffsetResult {
1987
+ currentPage: number | undefined;
1988
+ totalPages: number | undefined;
1989
+ totalCount: number | undefined;
1990
+ hasNext: () => boolean;
1991
+ hasPrev: () => boolean;
1992
+ length: number;
1993
+ pageSize: number;
1994
+ }
1995
+ export interface MembersQueryResult extends QueryOffsetResult {
1996
+ items: Member[];
1997
+ query: MembersQueryBuilder;
1998
+ next: () => Promise<MembersQueryResult>;
1999
+ prev: () => Promise<MembersQueryResult>;
2000
+ }
2001
+ export interface MembersQueryBuilder {
2002
+ /** @param propertyName - Property whose value is compared with `value`.
2003
+ * @param value - Value to compare against.
2004
+ */
2005
+ eq: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
2006
+ /** @param propertyName - Property whose value is compared with `value`.
2007
+ * @param value - Value to compare against.
2008
+ */
2009
+ ne: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
2010
+ /** @param propertyName - Property whose value is compared with `string`.
2011
+ * @param string - String to compare against. Case-insensitive.
2012
+ */
2013
+ startsWith: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: string) => MembersQueryBuilder;
2014
+ /** @param propertyName - Property whose value is compared with `values`.
2015
+ * @param values - List of values to compare against.
2016
+ */
2017
+ hasSome: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any[]) => MembersQueryBuilder;
2018
+ in: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
2019
+ exists: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: boolean) => MembersQueryBuilder;
2020
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
2021
+ limit: (limit: number) => MembersQueryBuilder;
2022
+ /** @param skip - Number of items to skip in the query results before returning the results. */
2023
+ skip: (skip: number) => MembersQueryBuilder;
2024
+ find: () => Promise<MembersQueryResult>;
2025
+ }
2026
+ /**
2027
+ * Mutes a member.
2028
+ *
2029
+ * Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
2030
+ *
2031
+ * You can mute members in [Wix Blog](https://dev.wix.com/docs/rest/business-solutions/blog/introduction) and [Wix Forum](https://dev.wix.com/docs/rest/business-solutions/forum/introduction).
2032
+ * @param _id - ID of the member to mute.
2033
+ * @public
2034
+ * @requiredField _id
2035
+ * @permissionId MEMBERS.MEMBER_MUTE
2036
+ * @permissionScope Manage Members
2037
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2038
+ * @applicableIdentity APP
2039
+ * @fqn com.wixpress.members.api.Members.MuteMember
2040
+ */
2041
+ export declare function muteMember(_id: string): Promise<NonNullablePaths<MuteMemberResponse, {
2042
+ [P in MemberNonNullablePaths]: `member.${P}`;
2043
+ }[MemberNonNullablePaths]>>;
2044
+ /**
2045
+ * Unmutes a member.
2046
+ *
2047
+ * Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
2048
+ *
2049
+ * You can unmute members in [Wix Blog](https://dev.wix.com/docs/rest/business-solutions/blog/introduction) and [Wix Forum](https://dev.wix.com/docs/rest/business-solutions/forum/introduction).
2050
+ * @param _id - ID of the member to unmute.
2051
+ * @public
2052
+ * @requiredField _id
2053
+ * @permissionId MEMBERS.MEMBER_MUTE
2054
+ * @permissionScope Manage Members
2055
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2056
+ * @applicableIdentity APP
2057
+ * @fqn com.wixpress.members.api.Members.UnmuteMember
2058
+ */
2059
+ export declare function unmuteMember(_id: string): Promise<NonNullablePaths<UnmuteMemberResponse, {
2060
+ [P in MemberNonNullablePaths]: `member.${P}`;
2061
+ }[MemberNonNullablePaths]>>;
2062
+ /**
2063
+ * Changes member status to `"APPROVED"` and gives access to members-only pages.
2064
+ *
2065
+ * Call this API to:
2066
+ * - Approve a pending member.
2067
+ * - Unblock a blocked member.
2068
+ * @param _id - ID of the member to approve.
2069
+ * @public
2070
+ * @requiredField _id
2071
+ * @permissionId MEMBERS.MEMBER_APPROVE
2072
+ * @permissionScope Manage Members
2073
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2074
+ * @applicableIdentity APP
2075
+ * @fqn com.wixpress.members.api.Members.ApproveMember
2076
+ */
2077
+ export declare function approveMember(_id: string): Promise<NonNullablePaths<ApproveMemberResponse, {
2078
+ [P in MemberNonNullablePaths]: `member.${P}`;
2079
+ }[MemberNonNullablePaths]>>;
2080
+ /**
2081
+ * Blocks a member.
2082
+ *
2083
+ * A blocked member can't log in to members-only pages.
2084
+ *
2085
+ * To unblock a member, call Approve Member.
2086
+ * @param _id - ID of a member to block.
2087
+ * @public
2088
+ * @requiredField _id
2089
+ * @permissionId MEMBERS.MEMBER_BLOCK
2090
+ * @permissionScope Manage Members
2091
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2092
+ * @applicableIdentity APP
2093
+ * @fqn com.wixpress.members.api.Members.BlockMember
2094
+ */
2095
+ export declare function blockMember(_id: string): Promise<NonNullablePaths<BlockMemberResponse, {
2096
+ [P in MemberNonNullablePaths]: `member.${P}`;
2097
+ }[MemberNonNullablePaths]>>;
2098
+ /**
2099
+ * Disconnects a member.
2100
+ *
2101
+ * A disconnected member can't log in to members-only pages, and the member isn't visible in the dashboard.
2102
+ *
2103
+ * >**Note:** This action is irreversible. To connect the same member again, you have to create a member with a new slug.
2104
+ * @param _id - ID of a member to disconnect.
2105
+ * @public
2106
+ * @requiredField _id
2107
+ * @permissionId MEMBERS.MEMBER_DISCONNECT
2108
+ * @permissionScope Manage Members
2109
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2110
+ * @permissionScope Manage Challenges
2111
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2112
+ * @applicableIdentity APP
2113
+ * @fqn com.wixpress.members.api.Members.DisconnectMember
2114
+ */
2115
+ export declare function disconnectMember(_id: string): Promise<NonNullablePaths<DisconnectMemberResponse, {
2116
+ [P in MemberNonNullablePaths]: `member.${P}`;
2117
+ }[MemberNonNullablePaths]>>;
2118
+ /**
2119
+ * Deletes a member by ID.
2120
+ *
2121
+ * All content created by this member is transferred to a site owner's account. For example, if a Wix user had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
2122
+ * @param _id - ID of a member to delete.
2123
+ * @public
2124
+ * @requiredField _id
2125
+ * @permissionId MEMBERS.MEMBER_DELETE
2126
+ * @permissionScope Manage Members
2127
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2128
+ * @applicableIdentity APP
2129
+ * @fqn com.wixpress.members.api.Members.DeleteMember
2130
+ */
2131
+ export declare function deleteMember(_id: string): Promise<void>;
2132
+ /**
2133
+ * Deletes the current member.
2134
+ *
2135
+ * After calling this method, the member is logged out of the site.
2136
+ *
2137
+ * All content created by this member is transferred to another account. For example, if a Wix user had blog posts, those posts are transferred to the account specified in `contentAssignedId`, which then becomes the owner of those posts.
2138
+ *
2139
+ * >**Note:**
2140
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
2141
+ * @public
2142
+ * @permissionId MEMBERS.MEMBER_DELETE
2143
+ * @permissionScope Manage Members
2144
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2145
+ * @applicableIdentity APP
2146
+ * @fqn com.wixpress.members.api.Members.DeleteMyMember
2147
+ */
2148
+ export declare function deleteMyMember(options?: DeleteMyMemberOptions): Promise<void>;
2149
+ export interface DeleteMyMemberOptions {
2150
+ /**
2151
+ * ID of a member receiving the deleted member's content.
2152
+ * @format GUID
2153
+ */
2154
+ contentAssigneeId?: string | null;
2155
+ }
2156
+ /**
2157
+ * Deletes multiple members by `memberId`.
2158
+ *
2159
+ * All content created by these members is transferred to a site owner's account. For example, if Wix users had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
2160
+ * @param memberIds - IDs of members to be deleted.
2161
+ * @public
2162
+ * @requiredField memberIds
2163
+ * @permissionId MEMBERS.MEMBER_DELETE
2164
+ * @permissionScope Manage Members
2165
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2166
+ * @applicableIdentity APP
2167
+ * @fqn com.wixpress.members.api.Members.BulkDeleteMembers
2168
+ */
2169
+ export declare function bulkDeleteMembers(memberIds: string[]): Promise<NonNullablePaths<BulkDeleteMembersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
2170
+ /**
2171
+ * Deletes multiple members by the specified filter.
2172
+ *
2173
+ * All content created by these members is transferred to a site owner's account. For example, if Wix users had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
2174
+ * @param filter - Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details.
2175
+ * @public
2176
+ * @requiredField filter
2177
+ * @permissionId MEMBERS.MEMBER_DELETE
2178
+ * @permissionScope Manage Members
2179
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2180
+ * @applicableIdentity APP
2181
+ * @fqn com.wixpress.members.api.Members.BulkDeleteMembersByFilter
2182
+ */
2183
+ export declare function bulkDeleteMembersByFilter(filter: any, options?: BulkDeleteMembersByFilterOptions): Promise<NonNullablePaths<BulkDeleteMembersByFilterResponse, `jobId`>>;
2184
+ export interface BulkDeleteMembersByFilterOptions {
2185
+ /**
2186
+ * ID of a member receiving the deleted member's content.
2187
+ * @format GUID
2188
+ */
2189
+ contentAssigneeId?: string | null;
2190
+ /** Plain text search. */
2191
+ search?: Search;
2192
+ }
2193
+ /**
2194
+ * Changes status of multiple members to `"APPROVED"`, and gives access to members-only pages.
2195
+ *
2196
+ * Call this API to:
2197
+ * - Approve pending members.
2198
+ * - Unblock blocked members.
2199
+ * @param filter - Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details.
2200
+ * @public
2201
+ * @requiredField filter
2202
+ * @permissionId MEMBERS.MEMBER_APPROVE
2203
+ * @permissionScope Manage Members
2204
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2205
+ * @applicableIdentity APP
2206
+ * @fqn com.wixpress.members.api.Members.BulkApproveMembers
2207
+ */
2208
+ export declare function bulkApproveMembers(filter: any): Promise<NonNullablePaths<BulkApproveMembersResponse, `jobId`>>;
2209
+ /**
2210
+ * Blocks multiple members by a specified filter.
2211
+ *
2212
+ * Blocked members can't log in to members-only pages.
2213
+ *
2214
+ * To unblock multiple members, call Bulk Approve Members.
2215
+ * @param filter - Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details.
2216
+ * @public
2217
+ * @requiredField filter
2218
+ * @permissionId MEMBERS.MEMBER_BLOCK
2219
+ * @permissionScope Manage Members
2220
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2221
+ * @applicableIdentity APP
2222
+ * @fqn com.wixpress.members.api.Members.BulkBlockMembers
2223
+ */
2224
+ export declare function bulkBlockMembers(filter: any): Promise<NonNullablePaths<BulkBlockMembersResponse, `jobId`>>;
2225
+ /**
2226
+ * Creates a site member.
2227
+ *
2228
+ * After creation, you can call
2229
+ * [Send Set Password Email ([SDK](https://dev.wix.com/docs/sdk/backend-modules/members/authentication/send-set-password-email) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/members/member-authentication/send-set-password-email))
2230
+ * to email the member with a link to set their password.
2231
+ * The member can log in to the site
2232
+ * when they set their password for the first time.
2233
+ *
2234
+ * > **Note:**
2235
+ * > When creating multiple members,
2236
+ * > set your requests at least 1 second apart to keep below rate limits.
2237
+ * @public
2238
+ * @permissionId MEMBERS.MEMBER_CREATE
2239
+ * @permissionScope Manage Members
2240
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2241
+ * @permissionScope Manage Challenges
2242
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2243
+ * @applicableIdentity APP
2244
+ * @returns New member.
2245
+ * @fqn com.wixpress.members.api.Members.CreateMember
2246
+ */
2247
+ export declare function createMember(options?: CreateMemberOptions): Promise<NonNullablePaths<Member, MemberNonNullablePaths>>;
2248
+ export interface CreateMemberOptions {
2249
+ /** Member to create. */
2250
+ member?: Member;
2251
+ }
2252
+ /**
2253
+ * Updates a member's properties.
2254
+ *
2255
+ * Only the requested fields are updated.
2256
+ * To clear a field's value, set an empty value with an empty string `""`.
2257
+ *
2258
+ * > **Note:**
2259
+ * > Updating the `contact.addresses`, `contact.emails`, or `contact.phones` array overwrites the entire array, so any existing values you want to retain must be passed in the `updateMember()` call along with the new values to add.
2260
+ * > However, passing an empty array will have no effect, and these methods must be used to clear all data from the respective array:
2261
+ * >- To clear `contact.addresses`, use `deleteMemberAddresses()`.
2262
+ * >- To clear `contact.emails`, use `deleteMemberEmails()`.
2263
+ * >- To clear `contact.phones`, use `deleteMemberPhones()`.
2264
+ *
2265
+ * > **Note:**
2266
+ * > Only logged-in members can call this method without elevated permissions.
2267
+ * > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
2268
+ * @param _id - Member ID.
2269
+ * @public
2270
+ * @requiredField _id
2271
+ * @requiredField member
2272
+ * @param options - Member to update.
2273
+ * @permissionId MEMBERS.MEMBER_UPDATE
2274
+ * @permissionScope Manage Stores
2275
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2276
+ * @permissionScope Manage Members
2277
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2278
+ * @permissionScope Manage Bookings Services and Settings
2279
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
2280
+ * @permissionScope Manage Events
2281
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2282
+ * @permissionScope Manage Challenges
2283
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2284
+ * @permissionScope Manage Portfolio
2285
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
2286
+ * @permissionScope Access Verticals by Automations
2287
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2288
+ * @permissionScope Manage Restaurants - all permissions
2289
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2290
+ * @permissionScope Set Up Automations
2291
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2292
+ * @applicableIdentity APP
2293
+ * @applicableIdentity MEMBER
2294
+ * @returns Updated member.
2295
+ * @fqn com.wixpress.members.api.Members.UpdateMember
2296
+ */
2297
+ export declare function updateMember(_id: string, member: UpdateMember): Promise<NonNullablePaths<Member, MemberNonNullablePaths>>;
2298
+ export interface UpdateMember {
2299
+ /**
2300
+ * Member ID.
2301
+ * @format GUID
2302
+ * @readonly
2303
+ */
2304
+ _id?: string | null;
2305
+ /**
2306
+ * Email used by a member to log in to the site.
2307
+ * @format EMAIL
2308
+ */
2309
+ loginEmail?: string | null;
2310
+ /**
2311
+ * Whether the email used by a member has been verified.
2312
+ * @readonly
2313
+ */
2314
+ loginEmailVerified?: boolean | null;
2315
+ /**
2316
+ * Member site access status.
2317
+ * @readonly
2318
+ */
2319
+ status?: Status;
2320
+ /**
2321
+ * Contact ID.
2322
+ * @format GUID
2323
+ * @readonly
2324
+ */
2325
+ contactId?: string | null;
2326
+ /**
2327
+ * Member's contact information. Contact information is stored in the
2328
+ * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).
2329
+ *
2330
+ * The full set of contact data can be accessed and managed with the
2331
+ * Contacts API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction)).
2332
+ */
2333
+ contact?: Contact;
2334
+ /** Profile display details. */
2335
+ profile?: Profile;
2336
+ /** Member privacy status. */
2337
+ privacyStatus?: PrivacyStatusStatus;
2338
+ /**
2339
+ * Member activity status.
2340
+ * @readonly
2341
+ */
2342
+ activityStatus?: ActivityStatusStatus;
2343
+ /**
2344
+ * Date and time when the member was created.
2345
+ * @readonly
2346
+ */
2347
+ _createdDate?: Date | null;
2348
+ /**
2349
+ * Date and time when the member was updated.
2350
+ * @readonly
2351
+ */
2352
+ _updatedDate?: Date | null;
2353
+ /**
2354
+ * Date and time when the member last logged in to the site.
2355
+ * @readonly
2356
+ */
2357
+ lastLoginDate?: Date | null;
2358
+ }
2359
+ /**
2360
+ * Clears a member's phone numbers.
2361
+ *
2362
+ * `deleteMemberPhones()` clears the `phones` array under the `contact` property.
2363
+ *
2364
+ * > **Note:**
2365
+ * > Only logged-in members can call this method without elevated permissions.
2366
+ * > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
2367
+ * @param _id - ID of the member whose phone numbers will be deleted.
2368
+ * @public
2369
+ * @requiredField _id
2370
+ * @permissionId MEMBERS.MEMBER_UPDATE
2371
+ * @permissionScope Manage Stores
2372
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2373
+ * @permissionScope Manage Members
2374
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2375
+ * @permissionScope Manage Bookings Services and Settings
2376
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
2377
+ * @permissionScope Manage Events
2378
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2379
+ * @permissionScope Manage Challenges
2380
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2381
+ * @permissionScope Manage Portfolio
2382
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
2383
+ * @permissionScope Access Verticals by Automations
2384
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2385
+ * @permissionScope Manage Restaurants - all permissions
2386
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2387
+ * @permissionScope Set Up Automations
2388
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2389
+ * @applicableIdentity APP
2390
+ * @applicableIdentity MEMBER
2391
+ * @fqn com.wixpress.members.api.Members.DeleteMemberPhones
2392
+ */
2393
+ export declare function deleteMemberPhones(_id: string): Promise<NonNullablePaths<DeleteMemberPhonesResponse, {
2394
+ [P in MemberNonNullablePaths]: `member.${P}`;
2395
+ }[MemberNonNullablePaths]>>;
2396
+ /**
2397
+ * Clears a member's email addresses.
2398
+ *
2399
+ * `deleteMemberEmails()` clears the `emails` array under the `contact` property.
2400
+ *
2401
+ * > **Notes:**
2402
+ * > A member can still log in with their `loginEmail`,
2403
+ * > which is not cleared when this method is called.
2404
+ *
2405
+ * > Only logged-in members can call this method without elevated permissions.
2406
+ * > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
2407
+ * @param _id - ID of the member whose email addresses will be deleted.
2408
+ * @public
2409
+ * @requiredField _id
2410
+ * @permissionId MEMBERS.MEMBER_UPDATE
2411
+ * @permissionScope Manage Stores
2412
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2413
+ * @permissionScope Manage Members
2414
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2415
+ * @permissionScope Manage Bookings Services and Settings
2416
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
2417
+ * @permissionScope Manage Events
2418
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2419
+ * @permissionScope Manage Challenges
2420
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2421
+ * @permissionScope Manage Portfolio
2422
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
2423
+ * @permissionScope Access Verticals by Automations
2424
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2425
+ * @permissionScope Manage Restaurants - all permissions
2426
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2427
+ * @permissionScope Set Up Automations
2428
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2429
+ * @applicableIdentity APP
2430
+ * @applicableIdentity MEMBER
2431
+ * @fqn com.wixpress.members.api.Members.DeleteMemberEmails
2432
+ */
2433
+ export declare function deleteMemberEmails(_id: string): Promise<NonNullablePaths<DeleteMemberEmailsResponse, {
2434
+ [P in MemberNonNullablePaths]: `member.${P}`;
2435
+ }[MemberNonNullablePaths]>>;
2436
+ /**
2437
+ * Deletes a member's street addresses.
2438
+ *
2439
+ * `deleteMemberAddresses()` clears the `addresses` array under the `contact` property.
2440
+ *
2441
+ * > **Note:**
2442
+ * > Only logged-in members can call this method without elevated permissions.
2443
+ * > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
2444
+ * @param _id - ID of the member whose street addresses will be deleted.
2445
+ * @public
2446
+ * @requiredField _id
2447
+ * @permissionId MEMBERS.MEMBER_UPDATE
2448
+ * @permissionScope Manage Stores
2449
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
2450
+ * @permissionScope Manage Members
2451
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2452
+ * @permissionScope Manage Bookings Services and Settings
2453
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
2454
+ * @permissionScope Manage Events
2455
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2456
+ * @permissionScope Manage Challenges
2457
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2458
+ * @permissionScope Manage Portfolio
2459
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
2460
+ * @permissionScope Access Verticals by Automations
2461
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2462
+ * @permissionScope Manage Restaurants - all permissions
2463
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2464
+ * @permissionScope Set Up Automations
2465
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2466
+ * @applicableIdentity APP
2467
+ * @applicableIdentity MEMBER
2468
+ * @fqn com.wixpress.members.api.Members.DeleteMemberAddresses
2469
+ */
2470
+ export declare function deleteMemberAddresses(_id: string): Promise<NonNullablePaths<DeleteMemberAddressesResponse, {
2471
+ [P in MemberNonNullablePaths]: `member.${P}`;
2472
+ }[MemberNonNullablePaths]>>;
2473
+ export {};