@wix/auto_sdk_members_members 1.0.55 → 1.0.56

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} +179 -390
  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 +2435 -0
  26. package/build/cjs/src/members-v1-member-members.universal.js +1365 -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} +179 -390
  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 +2435 -0
  54. package/build/es/src/members-v1-member-members.universal.js +1315 -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} +179 -390
  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 +2435 -0
  81. package/build/internal/cjs/src/members-v1-member-members.universal.js +1365 -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} +179 -390
  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 +2435 -0
  108. package/build/internal/es/src/members-v1-member-members.universal.js +1315 -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,2435 @@
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
+ /**
917
+ * Unique event ID.
918
+ * Allows clients to ignore duplicate webhooks.
919
+ */
920
+ _id?: string;
921
+ /**
922
+ * Assumes actions are also always typed to an entity_type
923
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
924
+ */
925
+ entityFqdn?: string;
926
+ /**
927
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
928
+ * This is although the created/updated/deleted notion is duplication of the oneof types
929
+ * Example: created/updated/deleted/started/completed/email_opened
930
+ */
931
+ slug?: string;
932
+ /** ID of the entity associated with the event. */
933
+ entityId?: string;
934
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
935
+ eventTime?: Date | null;
936
+ /**
937
+ * Whether the event was triggered as a result of a privacy regulation application
938
+ * (for example, GDPR).
939
+ */
940
+ triggeredByAnonymizeRequest?: boolean | null;
941
+ /** If present, indicates the action that triggered the event. */
942
+ originatedFrom?: string | null;
943
+ /**
944
+ * A sequence number defining the order of updates to the underlying entity.
945
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
946
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
947
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
948
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
949
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
950
+ */
951
+ entityEventSequence?: string | null;
952
+ }
953
+ /** @oneof */
954
+ export interface DomainEventBodyOneOf {
955
+ createdEvent?: EntityCreatedEvent;
956
+ updatedEvent?: EntityUpdatedEvent;
957
+ deletedEvent?: EntityDeletedEvent;
958
+ actionEvent?: ActionEvent;
959
+ }
960
+ export interface EntityCreatedEvent {
961
+ entity?: string;
962
+ }
963
+ export interface RestoreInfo {
964
+ deletedDate?: Date | null;
965
+ }
966
+ export interface EntityUpdatedEvent {
967
+ /**
968
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
969
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
970
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
971
+ */
972
+ currentEntity?: string;
973
+ }
974
+ export interface EntityDeletedEvent {
975
+ /** Entity that was deleted */
976
+ deletedEntity?: string | null;
977
+ }
978
+ export interface ActionEvent {
979
+ body?: string;
980
+ }
981
+ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
982
+ /** Emitted on a meta site creation. */
983
+ siteCreated?: SiteCreated;
984
+ /** Emitted on a meta site transfer completion. */
985
+ siteTransferred?: SiteTransferred;
986
+ /** Emitted on a meta site deletion. */
987
+ siteDeleted?: SiteDeleted;
988
+ /** Emitted on a meta site restoration. */
989
+ siteUndeleted?: SiteUndeleted;
990
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
991
+ sitePublished?: SitePublished;
992
+ /** Emitted on a meta site unpublish. */
993
+ siteUnpublished?: SiteUnpublished;
994
+ /** Emitted when meta site is marked as template. */
995
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
996
+ /** Emitted when meta site is marked as a WixSite. */
997
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
998
+ /** Emitted when an application is provisioned (installed). */
999
+ serviceProvisioned?: ServiceProvisioned;
1000
+ /** Emitted when an application is removed (uninstalled). */
1001
+ serviceRemoved?: ServiceRemoved;
1002
+ /** Emitted when meta site name (URL slug) is changed. */
1003
+ siteRenamedPayload?: SiteRenamed;
1004
+ /** Emitted when meta site was permanently deleted. */
1005
+ hardDeleted?: SiteHardDeleted;
1006
+ /** Emitted on a namespace change. */
1007
+ namespaceChanged?: NamespaceChanged;
1008
+ /** Emitted when Studio is attached. */
1009
+ studioAssigned?: StudioAssigned;
1010
+ /** Emitted when Studio is detached. */
1011
+ studioUnassigned?: StudioUnassigned;
1012
+ /**
1013
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
1014
+ * the actual URL.
1015
+ *
1016
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
1017
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
1018
+ */
1019
+ urlChanged?: SiteUrlChanged;
1020
+ /** Site is marked as PurgedExternally */
1021
+ sitePurgedExternally?: SitePurgedExternally;
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
+ }
1081
+ export interface Asset {
1082
+ /**
1083
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
1084
+ * @maxLength 36
1085
+ */
1086
+ appDefId?: string;
1087
+ /**
1088
+ * An instance id. For legacy reasons may be UUID or a string.
1089
+ * @maxLength 200
1090
+ */
1091
+ instanceId?: string;
1092
+ /** An application state. */
1093
+ state?: State;
1094
+ }
1095
+ export declare enum State {
1096
+ UNKNOWN = "UNKNOWN",
1097
+ ENABLED = "ENABLED",
1098
+ DISABLED = "DISABLED",
1099
+ PENDING = "PENDING",
1100
+ DEMO = "DEMO"
1101
+ }
1102
+ export interface SiteCreated {
1103
+ /**
1104
+ * A template identifier (empty if not created from a template).
1105
+ * @maxLength 36
1106
+ */
1107
+ originTemplateId?: string;
1108
+ /**
1109
+ * An account id of the owner.
1110
+ * @format GUID
1111
+ */
1112
+ ownerId?: string;
1113
+ /** A context in which meta site was created. */
1114
+ context?: SiteCreatedContext;
1115
+ /**
1116
+ * A meta site id from which this site was created.
1117
+ *
1118
+ * In case of a creation from a template it's a template id.
1119
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
1120
+ * @format GUID
1121
+ */
1122
+ originMetaSiteId?: string | null;
1123
+ /**
1124
+ * A meta site name (URL slug).
1125
+ * @maxLength 20
1126
+ */
1127
+ siteName?: string;
1128
+ /** A namespace. */
1129
+ namespace?: Namespace;
1130
+ }
1131
+ export declare enum SiteCreatedContext {
1132
+ /** A valid option, we don't expose all reasons why site might be created. */
1133
+ OTHER = "OTHER",
1134
+ /** A meta site was created from template. */
1135
+ FROM_TEMPLATE = "FROM_TEMPLATE",
1136
+ /** A meta site was created by copying of the transfferred meta site. */
1137
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
1138
+ /** A copy of existing meta site. */
1139
+ DUPLICATE = "DUPLICATE",
1140
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
1141
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
1142
+ /** deprecated A meta site was created for Flash editor. */
1143
+ FLASH = "FLASH"
1144
+ }
1145
+ export declare enum Namespace {
1146
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
1147
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
1148
+ WIX = "WIX",
1149
+ /** 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. */
1150
+ SHOUT_OUT = "SHOUT_OUT",
1151
+ /** 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. */
1152
+ ALBUMS = "ALBUMS",
1153
+ /** 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. */
1154
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
1155
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1156
+ HOTELS = "HOTELS",
1157
+ /** 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. */
1158
+ CLUBS = "CLUBS",
1159
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1160
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
1161
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1162
+ DEV_SITE = "DEV_SITE",
1163
+ /** 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. */
1164
+ LOGOS = "LOGOS",
1165
+ /** 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. */
1166
+ VIDEO_MAKER = "VIDEO_MAKER",
1167
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1168
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
1169
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1170
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
1171
+ /**
1172
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
1173
+ *
1174
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
1175
+ */
1176
+ HTML_DRAFT = "HTML_DRAFT",
1177
+ /**
1178
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
1179
+ * Will be accessible from Site List and will not have a website app.
1180
+ * Once the user attaches a site, the site will become a regular wixsite.
1181
+ */
1182
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
1183
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
1184
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
1185
+ /** It is to be used in the Business First efforts. */
1186
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
1187
+ /** Bookings business flow with no site. */
1188
+ ANYWHERE = "ANYWHERE",
1189
+ /** Namespace for Headless Backoffice with no editor */
1190
+ HEADLESS = "HEADLESS",
1191
+ /**
1192
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
1193
+ * The site will be used for account level CSM feature for enterprise
1194
+ */
1195
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
1196
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
1197
+ RISE = "RISE",
1198
+ /**
1199
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
1200
+ * There's a blank site behind the scene but it's blank).
1201
+ * The Mobile company will be the owner of this namespace.
1202
+ */
1203
+ BRANDED_FIRST = "BRANDED_FIRST",
1204
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
1205
+ NOWNIA = "NOWNIA",
1206
+ /**
1207
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
1208
+ * The Partners company owns this namespace.
1209
+ */
1210
+ UGC_TEMPLATE = "UGC_TEMPLATE",
1211
+ /** Codux Headless Sites */
1212
+ CODUX = "CODUX",
1213
+ /** Bobb - AI Design Creator. */
1214
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
1215
+ /**
1216
+ * Shared Blog Site is a unique single site across Enterprise account,
1217
+ * This site will hold all Blog posts related to the Marketing product.
1218
+ */
1219
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
1220
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1221
+ STANDALONE_FORMS = "STANDALONE_FORMS",
1222
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1223
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
1224
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
1225
+ MIMIR = "MIMIR"
1226
+ }
1227
+ /** Site transferred to another user. */
1228
+ export interface SiteTransferred {
1229
+ /**
1230
+ * A previous owner id (user that transfers meta site).
1231
+ * @format GUID
1232
+ */
1233
+ oldOwnerId?: string;
1234
+ /**
1235
+ * A new owner id (user that accepts meta site).
1236
+ * @format GUID
1237
+ */
1238
+ newOwnerId?: string;
1239
+ }
1240
+ /** Soft deletion of the meta site. Could be restored. */
1241
+ export interface SiteDeleted {
1242
+ /** A deletion context. */
1243
+ deleteContext?: DeleteContext;
1244
+ }
1245
+ export interface DeleteContext {
1246
+ /** When the meta site was deleted. */
1247
+ dateDeleted?: Date | null;
1248
+ /** A status. */
1249
+ deleteStatus?: DeleteStatus;
1250
+ /**
1251
+ * A reason (flow).
1252
+ * @maxLength 255
1253
+ */
1254
+ deleteOrigin?: string;
1255
+ /**
1256
+ * A service that deleted it.
1257
+ * @maxLength 255
1258
+ */
1259
+ initiatorId?: string | null;
1260
+ }
1261
+ export declare enum DeleteStatus {
1262
+ UNKNOWN = "UNKNOWN",
1263
+ TRASH = "TRASH",
1264
+ DELETED = "DELETED",
1265
+ PENDING_PURGE = "PENDING_PURGE",
1266
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
1267
+ }
1268
+ /** Restoration of the meta site. */
1269
+ export interface SiteUndeleted {
1270
+ }
1271
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
1272
+ export interface SitePublished {
1273
+ }
1274
+ export interface SiteUnpublished {
1275
+ /**
1276
+ * A list of URLs previously associated with the meta site.
1277
+ * @maxLength 4000
1278
+ * @maxSize 10000
1279
+ */
1280
+ urls?: string[];
1281
+ }
1282
+ export interface SiteMarkedAsTemplate {
1283
+ }
1284
+ export interface SiteMarkedAsWixSite {
1285
+ }
1286
+ /**
1287
+ * Represents a service provisioned a site.
1288
+ *
1289
+ * Note on `origin_instance_id`:
1290
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
1291
+ * This is because of the following scenario:
1292
+ *
1293
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
1294
+ * such as a product catalog. When you create a site from this template, you inherit this
1295
+ * default product catalog. However, if the template's product catalog is modified,
1296
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
1297
+ * your site remains consistent with what you initially received and does not include any
1298
+ * changes made to the original template afterward.
1299
+ * To ensure this, the TPA on the template gets a new instance_id.
1300
+ */
1301
+ export interface ServiceProvisioned {
1302
+ /**
1303
+ * Either UUID or EmbeddedServiceType.
1304
+ * @maxLength 36
1305
+ */
1306
+ appDefId?: string;
1307
+ /**
1308
+ * Not only UUID. Something here could be something weird.
1309
+ * @maxLength 36
1310
+ */
1311
+ instanceId?: string;
1312
+ /**
1313
+ * An instance id from which this instance is originated.
1314
+ * @maxLength 36
1315
+ */
1316
+ originInstanceId?: string;
1317
+ /**
1318
+ * A version.
1319
+ * @maxLength 500
1320
+ */
1321
+ version?: string | null;
1322
+ /**
1323
+ * The origin meta site id
1324
+ * @format GUID
1325
+ */
1326
+ originMetaSiteId?: string | null;
1327
+ }
1328
+ export interface ServiceRemoved {
1329
+ /**
1330
+ * Either UUID or EmbeddedServiceType.
1331
+ * @maxLength 36
1332
+ */
1333
+ appDefId?: string;
1334
+ /**
1335
+ * Not only UUID. Something here could be something weird.
1336
+ * @maxLength 36
1337
+ */
1338
+ instanceId?: string;
1339
+ /**
1340
+ * A version.
1341
+ * @maxLength 500
1342
+ */
1343
+ version?: string | null;
1344
+ }
1345
+ /** Rename of the site. Meaning, free public url has been changed as well. */
1346
+ export interface SiteRenamed {
1347
+ /**
1348
+ * A new meta site name (URL slug).
1349
+ * @maxLength 20
1350
+ */
1351
+ newSiteName?: string;
1352
+ /**
1353
+ * A previous meta site name (URL slug).
1354
+ * @maxLength 255
1355
+ */
1356
+ oldSiteName?: string;
1357
+ }
1358
+ /**
1359
+ * Hard deletion of the meta site.
1360
+ *
1361
+ * Could not be restored. Therefore it's desirable to cleanup data.
1362
+ */
1363
+ export interface SiteHardDeleted {
1364
+ /** A deletion context. */
1365
+ deleteContext?: DeleteContext;
1366
+ }
1367
+ export interface NamespaceChanged {
1368
+ /** A previous namespace. */
1369
+ oldNamespace?: Namespace;
1370
+ /** A new namespace. */
1371
+ newNamespace?: Namespace;
1372
+ }
1373
+ /** Assigned Studio editor */
1374
+ export interface StudioAssigned {
1375
+ }
1376
+ /** Unassigned Studio editor */
1377
+ export interface StudioUnassigned {
1378
+ }
1379
+ /**
1380
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
1381
+ *
1382
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
1383
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
1384
+ *
1385
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
1386
+ */
1387
+ export interface SiteUrlChanged {
1388
+ }
1389
+ /**
1390
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
1391
+ * Consumed by other teams to remove relevant data.
1392
+ */
1393
+ export interface SitePurgedExternally {
1394
+ /**
1395
+ * @maxLength 2048
1396
+ * @maxSize 100
1397
+ * @deprecated
1398
+ * @targetRemovalDate 2025-04-15
1399
+ */
1400
+ appDefId?: string[];
1401
+ }
1402
+ export interface MemberOwnershipTransferred {
1403
+ fromMember?: Member;
1404
+ toMember?: Member;
1405
+ }
1406
+ export interface MemberIdChanged {
1407
+ /** @format GUID */
1408
+ fromId?: string;
1409
+ /** @format GUID */
1410
+ toId?: string;
1411
+ }
1412
+ export interface MessageEnvelope {
1413
+ /**
1414
+ * App instance ID.
1415
+ * @format GUID
1416
+ */
1417
+ instanceId?: string | null;
1418
+ /**
1419
+ * Event type.
1420
+ * @maxLength 150
1421
+ */
1422
+ eventType?: string;
1423
+ /** The identification type and identity data. */
1424
+ identity?: IdentificationData;
1425
+ /** Stringify payload. */
1426
+ data?: string;
1427
+ }
1428
+ export interface IdentificationData extends IdentificationDataIdOneOf {
1429
+ /**
1430
+ * ID of a site visitor that has not logged in to the site.
1431
+ * @format GUID
1432
+ */
1433
+ anonymousVisitorId?: string;
1434
+ /**
1435
+ * ID of a site visitor that has logged in to the site.
1436
+ * @format GUID
1437
+ */
1438
+ memberId?: string;
1439
+ /**
1440
+ * ID of a Wix user (site owner, contributor, etc.).
1441
+ * @format GUID
1442
+ */
1443
+ wixUserId?: string;
1444
+ /**
1445
+ * ID of an app.
1446
+ * @format GUID
1447
+ */
1448
+ appId?: string;
1449
+ /** @readonly */
1450
+ identityType?: WebhookIdentityType;
1451
+ }
1452
+ /** @oneof */
1453
+ export interface IdentificationDataIdOneOf {
1454
+ /**
1455
+ * ID of a site visitor that has not logged in to the site.
1456
+ * @format GUID
1457
+ */
1458
+ anonymousVisitorId?: string;
1459
+ /**
1460
+ * ID of a site visitor that has logged in to the site.
1461
+ * @format GUID
1462
+ */
1463
+ memberId?: string;
1464
+ /**
1465
+ * ID of a Wix user (site owner, contributor, etc.).
1466
+ * @format GUID
1467
+ */
1468
+ wixUserId?: string;
1469
+ /**
1470
+ * ID of an app.
1471
+ * @format GUID
1472
+ */
1473
+ appId?: string;
1474
+ }
1475
+ export declare enum WebhookIdentityType {
1476
+ UNKNOWN = "UNKNOWN",
1477
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1478
+ MEMBER = "MEMBER",
1479
+ WIX_USER = "WIX_USER",
1480
+ APP = "APP"
1481
+ }
1482
+ export interface BaseEventMetadata {
1483
+ /**
1484
+ * App instance ID.
1485
+ * @format GUID
1486
+ */
1487
+ instanceId?: string | null;
1488
+ /**
1489
+ * Event type.
1490
+ * @maxLength 150
1491
+ */
1492
+ eventType?: string;
1493
+ /** The identification type and identity data. */
1494
+ identity?: IdentificationData;
1495
+ }
1496
+ export interface EventMetadata extends BaseEventMetadata {
1497
+ /**
1498
+ * Unique event ID.
1499
+ * Allows clients to ignore duplicate webhooks.
1500
+ */
1501
+ _id?: string;
1502
+ /**
1503
+ * Assumes actions are also always typed to an entity_type
1504
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1505
+ */
1506
+ entityFqdn?: string;
1507
+ /**
1508
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1509
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1510
+ * Example: created/updated/deleted/started/completed/email_opened
1511
+ */
1512
+ slug?: string;
1513
+ /** ID of the entity associated with the event. */
1514
+ entityId?: string;
1515
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1516
+ eventTime?: Date | null;
1517
+ /**
1518
+ * Whether the event was triggered as a result of a privacy regulation application
1519
+ * (for example, GDPR).
1520
+ */
1521
+ triggeredByAnonymizeRequest?: boolean | null;
1522
+ /** If present, indicates the action that triggered the event. */
1523
+ originatedFrom?: string | null;
1524
+ /**
1525
+ * A sequence number defining the order of updates to the underlying entity.
1526
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1527
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1528
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1529
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1530
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1531
+ */
1532
+ entityEventSequence?: string | null;
1533
+ }
1534
+ export interface MemberCreatedEnvelope {
1535
+ entity: Member;
1536
+ metadata: EventMetadata;
1537
+ }
1538
+ /**
1539
+ * Triggered when a member is created.
1540
+ *
1541
+ * The site owner can configure the site to automatically approve members or require manual approval.
1542
+ *
1543
+ * 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.
1544
+ * @permissionScope Manage Members
1545
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1546
+ * @permissionScope Manage Bookings Services and Settings
1547
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1548
+ * @permissionScope Manage Events
1549
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1550
+ * @permissionScope Manage Challenges
1551
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1552
+ * @permissionScope Manage Portfolio
1553
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1554
+ * @permissionScope Access Verticals by Automations
1555
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1556
+ * @permissionScope Read Members and Contacts - all read permissions
1557
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1558
+ * @permissionScope Manage Restaurants - all permissions
1559
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1560
+ * @permissionScope Read Members
1561
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1562
+ * @permissionScope Set Up Automations
1563
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1564
+ * @permissionScope Manage Members and Contacts - all permissions
1565
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1566
+ * @permissionId MEMBERS.MEMBER_READ
1567
+ * @webhook
1568
+ * @eventType wix.members.v1.member_created
1569
+ * @serviceIdentifier com.wixpress.members.api.Members
1570
+ * @slug created
1571
+ */
1572
+ export declare function onMemberCreated(handler: (event: MemberCreatedEnvelope) => void | Promise<void>): void;
1573
+ export interface MemberDeletedEnvelope {
1574
+ metadata: EventMetadata;
1575
+ }
1576
+ /**
1577
+ * Triggered when a member is deleted.
1578
+ * @permissionScope Manage Members
1579
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1580
+ * @permissionScope Manage Bookings Services and Settings
1581
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1582
+ * @permissionScope Manage Events
1583
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1584
+ * @permissionScope Manage Challenges
1585
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1586
+ * @permissionScope Manage Portfolio
1587
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1588
+ * @permissionScope Access Verticals by Automations
1589
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1590
+ * @permissionScope Read Members and Contacts - all read permissions
1591
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1592
+ * @permissionScope Manage Restaurants - all permissions
1593
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1594
+ * @permissionScope Read Members
1595
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1596
+ * @permissionScope Set Up Automations
1597
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1598
+ * @permissionScope Manage Members and Contacts - all permissions
1599
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1600
+ * @permissionId MEMBERS.MEMBER_READ
1601
+ * @webhook
1602
+ * @eventType wix.members.v1.member_deleted
1603
+ * @serviceIdentifier com.wixpress.members.api.Members
1604
+ * @slug deleted
1605
+ */
1606
+ export declare function onMemberDeleted(handler: (event: MemberDeletedEnvelope) => void | Promise<void>): void;
1607
+ export interface MemberUpdatedEnvelope {
1608
+ entity: Member;
1609
+ metadata: EventMetadata;
1610
+ }
1611
+ /** @permissionScope Manage Members
1612
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1613
+ * @permissionScope Manage Bookings Services and Settings
1614
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1615
+ * @permissionScope Manage Events
1616
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1617
+ * @permissionScope Manage Challenges
1618
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1619
+ * @permissionScope Manage Portfolio
1620
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1621
+ * @permissionScope Access Verticals by Automations
1622
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1623
+ * @permissionScope Read Members and Contacts - all read permissions
1624
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1625
+ * @permissionScope Manage Restaurants - all permissions
1626
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1627
+ * @permissionScope Read Members
1628
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1629
+ * @permissionScope Set Up Automations
1630
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1631
+ * @permissionScope Manage Members and Contacts - all permissions
1632
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1633
+ * @permissionId MEMBERS.MEMBER_READ
1634
+ * @webhook
1635
+ * @eventType wix.members.v1.member_updated
1636
+ * @serviceIdentifier com.wixpress.members.api.Members
1637
+ * @slug updated
1638
+ */
1639
+ export declare function onMemberUpdated(handler: (event: MemberUpdatedEnvelope) => void | Promise<void>): void;
1640
+ 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`;
1641
+ /**
1642
+ * Updates the currently logged in member's slug.
1643
+ *
1644
+ * 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`.
1645
+ *
1646
+ * > **Note:**
1647
+ * > Only logged-in members can call this method without elevated permissions.
1648
+ * > 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.
1649
+ * @param slug - New slug.
1650
+ * @public
1651
+ * @requiredField slug
1652
+ * @permissionId MEMBERS.MEMBER_UPDATE
1653
+ * @permissionScope Manage Members
1654
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1655
+ * @permissionScope Manage Bookings Services and Settings
1656
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1657
+ * @permissionScope Manage Events
1658
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1659
+ * @permissionScope Manage Challenges
1660
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1661
+ * @permissionScope Manage Portfolio
1662
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1663
+ * @permissionScope Access Verticals by Automations
1664
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1665
+ * @permissionScope Manage Restaurants - all permissions
1666
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1667
+ * @permissionScope Set Up Automations
1668
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1669
+ * @applicableIdentity APP
1670
+ * @applicableIdentity MEMBER
1671
+ * @fqn com.wixpress.members.api.Members.UpdateMySlug
1672
+ */
1673
+ export declare function updateCurrentMemberSlug(slug: string): Promise<NonNullablePaths<UpdateMySlugResponse, {
1674
+ [P in MemberNonNullablePaths]: `member.${P}`;
1675
+ }[MemberNonNullablePaths]>>;
1676
+ /**
1677
+ * Updates a member's slug.
1678
+ * @param _id - Member ID.
1679
+ * @param slug - New slug.
1680
+ * @public
1681
+ * @requiredField _id
1682
+ * @requiredField slug
1683
+ * @permissionId MEMBERS.MEMBER_UPDATE
1684
+ * @permissionScope Manage Members
1685
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1686
+ * @permissionScope Manage Bookings Services and Settings
1687
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1688
+ * @permissionScope Manage Events
1689
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1690
+ * @permissionScope Manage Challenges
1691
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1692
+ * @permissionScope Manage Portfolio
1693
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1694
+ * @permissionScope Access Verticals by Automations
1695
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1696
+ * @permissionScope Manage Restaurants - all permissions
1697
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1698
+ * @permissionScope Set Up Automations
1699
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1700
+ * @applicableIdentity APP
1701
+ * @applicableIdentity MEMBER
1702
+ * @fqn com.wixpress.members.api.Members.UpdateMemberSlug
1703
+ */
1704
+ export declare function updateMemberSlug(_id: string, slug: string): Promise<NonNullablePaths<UpdateMemberSlugResponse, {
1705
+ [P in MemberNonNullablePaths]: `member.${P}`;
1706
+ }[MemberNonNullablePaths]>>;
1707
+ /**
1708
+ * Joins the current member to the site community and sets their profile to public.
1709
+ *
1710
+ * When a member's profile is public, they have access to the site's
1711
+ * [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
1712
+ * features, such as chat, forum, and followers,
1713
+ * and their profile is visible to other members and site visitors.
1714
+ *
1715
+ * > **Note:**
1716
+ * > Only logged-in members can call this method without elevated permissions.
1717
+ * > 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.
1718
+ * @public
1719
+ * @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY
1720
+ * @permissionScope Manage Members
1721
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1722
+ * @applicableIdentity APP
1723
+ * @applicableIdentity MEMBER
1724
+ * @returns Member profile.
1725
+ * @fqn com.wixpress.members.api.Members.JoinCommunity
1726
+ */
1727
+ export declare function joinCommunity(): Promise<NonNullablePaths<JoinCommunityResponse, {
1728
+ [P in MemberNonNullablePaths]: `member.${P}`;
1729
+ }[MemberNonNullablePaths]>>;
1730
+ /**
1731
+ * Removes the current member from the site community and sets their profile to private.
1732
+ *
1733
+ * When a member's profile is private,
1734
+ * they do not have access to the site's
1735
+ * [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
1736
+ * features, such as chat, forum, and followers,
1737
+ * and their profile is hidden from other members and site visitors.
1738
+ *
1739
+ * > **Notes:**
1740
+ * > + If a member leaves the site's community, their content, such as forum posts and blog comments, remain publicly visible.
1741
+ *
1742
+ * > + Only logged-in members can call this method without elevated permissions.
1743
+ * > + 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.
1744
+ * @public
1745
+ * @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY
1746
+ * @permissionScope Manage Members
1747
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1748
+ * @applicableIdentity APP
1749
+ * @applicableIdentity MEMBER
1750
+ * @returns Member profile.
1751
+ * @fqn com.wixpress.members.api.Members.LeaveCommunity
1752
+ */
1753
+ export declare function leaveCommunity(): Promise<NonNullablePaths<LeaveCommunityResponse, {
1754
+ [P in MemberNonNullablePaths]: `member.${P}`;
1755
+ }[MemberNonNullablePaths]>>;
1756
+ /**
1757
+ * Retrieves the current member.
1758
+ *
1759
+ * >**Note:**
1760
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
1761
+ * @public
1762
+ * @permissionId MEMBERS.MEMBER_READ
1763
+ * @permissionScope Manage Members
1764
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1765
+ * @permissionScope Manage Bookings Services and Settings
1766
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1767
+ * @permissionScope Manage Events
1768
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1769
+ * @permissionScope Manage Challenges
1770
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1771
+ * @permissionScope Manage Portfolio
1772
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1773
+ * @permissionScope Access Verticals by Automations
1774
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1775
+ * @permissionScope Read Members and Contacts - all read permissions
1776
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1777
+ * @permissionScope Manage Restaurants - all permissions
1778
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1779
+ * @permissionScope Read Members
1780
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1781
+ * @permissionScope Set Up Automations
1782
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1783
+ * @permissionScope Manage Members and Contacts - all permissions
1784
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1785
+ * @applicableIdentity APP
1786
+ * @applicableIdentity VISITOR
1787
+ * @returns Member profile.
1788
+ * @fqn com.wixpress.members.api.Members.GetMyMember
1789
+ */
1790
+ export declare function getCurrentMember(options?: GetCurrentMemberOptions): Promise<NonNullablePaths<GetMyMemberResponse, {
1791
+ [P in MemberNonNullablePaths]: `member.${P}`;
1792
+ }[MemberNonNullablePaths]>>;
1793
+ export interface GetCurrentMemberOptions {
1794
+ /**
1795
+ * Predefined set of fields to return.
1796
+ *
1797
+ * Default: `"PUBLIC"`.
1798
+ * @maxSize 3
1799
+ */
1800
+ fieldsets?: Set[];
1801
+ }
1802
+ /**
1803
+ * Retrieves a member by ID.
1804
+ *
1805
+ * >**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).
1806
+ *
1807
+ * @param _id - Member ID.
1808
+ * @public
1809
+ * @requiredField _id
1810
+ * @param options - Fieldset options.
1811
+ * @permissionId MEMBERS.MEMBER_READ
1812
+ * @permissionScope Manage Members
1813
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1814
+ * @permissionScope Manage Bookings Services and Settings
1815
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1816
+ * @permissionScope Manage Events
1817
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1818
+ * @permissionScope Manage Challenges
1819
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1820
+ * @permissionScope Manage Portfolio
1821
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1822
+ * @permissionScope Access Verticals by Automations
1823
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1824
+ * @permissionScope Read Members and Contacts - all read permissions
1825
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1826
+ * @permissionScope Manage Restaurants - all permissions
1827
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1828
+ * @permissionScope Read Members
1829
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1830
+ * @permissionScope Set Up Automations
1831
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1832
+ * @permissionScope Manage Members and Contacts - all permissions
1833
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1834
+ * @applicableIdentity APP
1835
+ * @applicableIdentity VISITOR
1836
+ * @returns The requested member.
1837
+ * @fqn com.wixpress.members.api.Members.GetMember
1838
+ */
1839
+ export declare function getMember(_id: string, options?: GetMemberOptions): Promise<NonNullablePaths<Member, MemberNonNullablePaths>>;
1840
+ export interface GetMemberOptions {
1841
+ /**
1842
+ * Predefined set of fields to return.
1843
+ *
1844
+ * Defaults to `"PUBLIC"`.
1845
+ * @maxSize 3
1846
+ */
1847
+ fieldsets?: Set[];
1848
+ }
1849
+ /**
1850
+ * Lists site members, given the provided paging and fieldsets.
1851
+ * @public
1852
+ * @param options - Options for paging, sorting, and specifying fields to return.
1853
+ * @permissionId MEMBERS.MEMBER_READ
1854
+ * @permissionScope Manage Members
1855
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1856
+ * @permissionScope Manage Bookings Services and Settings
1857
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1858
+ * @permissionScope Manage Events
1859
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1860
+ * @permissionScope Manage Challenges
1861
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1862
+ * @permissionScope Manage Portfolio
1863
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1864
+ * @permissionScope Access Verticals by Automations
1865
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1866
+ * @permissionScope Read Members and Contacts - all read permissions
1867
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1868
+ * @permissionScope Manage Restaurants - all permissions
1869
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1870
+ * @permissionScope Read Members
1871
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1872
+ * @permissionScope Set Up Automations
1873
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1874
+ * @permissionScope Manage Members and Contacts - all permissions
1875
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1876
+ * @applicableIdentity APP
1877
+ * @applicableIdentity VISITOR
1878
+ * @fqn com.wixpress.members.api.Members.ListMembers
1879
+ */
1880
+ export declare function listMembers(options?: ListMembersOptions): Promise<NonNullablePaths<ListMembersResponse, {
1881
+ [P in MemberNonNullablePaths]: `members.${number}.${P}`;
1882
+ }[MemberNonNullablePaths]>>;
1883
+ export interface ListMembersOptions {
1884
+ /** Paging options. */
1885
+ paging?: Paging;
1886
+ /**
1887
+ * Predefined sets of fields to return.
1888
+ *
1889
+ * Default: `"PUBLIC"`.
1890
+ * @maxSize 3
1891
+ */
1892
+ fieldsets?: Set[];
1893
+ /** Sorting options. */
1894
+ sorting?: Sorting[];
1895
+ }
1896
+ /**
1897
+ * Retrieves a list of up to 100 members, given the specified filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object.
1898
+ *
1899
+ * The returned object contains the query definition which is typically used to run the query using the `find()` method.
1900
+ *
1901
+ * 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.
1902
+ *
1903
+ * `queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override:
1904
+ * - `skip`: `0`
1905
+ * - `limit`: `50`
1906
+ *
1907
+ * Currently supported fields for sorting:
1908
+ * - `profile.nickname`
1909
+ * - `contact.firstName`
1910
+ * - `contact.lastName`
1911
+ * - `createdDate`
1912
+ * - `lastLoginDate`
1913
+ *
1914
+ * 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`.
1915
+ * @public
1916
+ * @param options - Query options.
1917
+ * @permissionScope Manage Members
1918
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1919
+ * @permissionScope Manage Bookings Services and Settings
1920
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1921
+ * @permissionScope Manage Events
1922
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1923
+ * @permissionScope Manage Challenges
1924
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1925
+ * @permissionScope Manage Portfolio
1926
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1927
+ * @permissionScope Access Verticals by Automations
1928
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1929
+ * @permissionScope Read Members and Contacts - all read permissions
1930
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
1931
+ * @permissionScope Manage Restaurants - all permissions
1932
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1933
+ * @permissionScope Read Members
1934
+ * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
1935
+ * @permissionScope Set Up Automations
1936
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1937
+ * @permissionScope Manage Members and Contacts - all permissions
1938
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
1939
+ * @permissionId MEMBERS.MEMBER_READ
1940
+ * @applicableIdentity APP
1941
+ * @applicableIdentity VISITOR
1942
+ * @fqn com.wixpress.members.api.Members.QueryMembers
1943
+ */
1944
+ export declare function queryMembers(options?: QueryMembersOptions): MembersQueryBuilder;
1945
+ export interface QueryMembersOptions {
1946
+ /**
1947
+ * Predefined sets of fields to return.
1948
+ *
1949
+ * Default: `"PUBLIC"`.
1950
+ * @maxSize 3
1951
+ */
1952
+ fieldsets?: Set[] | undefined;
1953
+ /** Plain text search. */
1954
+ search?: Search | undefined;
1955
+ }
1956
+ interface QueryOffsetResult {
1957
+ currentPage: number | undefined;
1958
+ totalPages: number | undefined;
1959
+ totalCount: number | undefined;
1960
+ hasNext: () => boolean;
1961
+ hasPrev: () => boolean;
1962
+ length: number;
1963
+ pageSize: number;
1964
+ }
1965
+ export interface MembersQueryResult extends QueryOffsetResult {
1966
+ items: Member[];
1967
+ query: MembersQueryBuilder;
1968
+ next: () => Promise<MembersQueryResult>;
1969
+ prev: () => Promise<MembersQueryResult>;
1970
+ }
1971
+ export interface MembersQueryBuilder {
1972
+ /** @param propertyName - Property whose value is compared with `value`.
1973
+ * @param value - Value to compare against.
1974
+ */
1975
+ eq: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
1976
+ /** @param propertyName - Property whose value is compared with `value`.
1977
+ * @param value - Value to compare against.
1978
+ */
1979
+ ne: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
1980
+ /** @param propertyName - Property whose value is compared with `string`.
1981
+ * @param string - String to compare against. Case-insensitive.
1982
+ */
1983
+ startsWith: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: string) => MembersQueryBuilder;
1984
+ /** @param propertyName - Property whose value is compared with `values`.
1985
+ * @param values - List of values to compare against.
1986
+ */
1987
+ hasSome: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any[]) => MembersQueryBuilder;
1988
+ in: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
1989
+ exists: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: boolean) => MembersQueryBuilder;
1990
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
1991
+ limit: (limit: number) => MembersQueryBuilder;
1992
+ /** @param skip - Number of items to skip in the query results before returning the results. */
1993
+ skip: (skip: number) => MembersQueryBuilder;
1994
+ find: () => Promise<MembersQueryResult>;
1995
+ }
1996
+ /**
1997
+ * Mutes a member.
1998
+ *
1999
+ * Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
2000
+ *
2001
+ * 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).
2002
+ * @param _id - ID of the member to mute.
2003
+ * @public
2004
+ * @requiredField _id
2005
+ * @permissionId MEMBERS.MEMBER_MUTE
2006
+ * @permissionScope Manage Members
2007
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2008
+ * @applicableIdentity APP
2009
+ * @fqn com.wixpress.members.api.Members.MuteMember
2010
+ */
2011
+ export declare function muteMember(_id: string): Promise<NonNullablePaths<MuteMemberResponse, {
2012
+ [P in MemberNonNullablePaths]: `member.${P}`;
2013
+ }[MemberNonNullablePaths]>>;
2014
+ /**
2015
+ * Unmutes a member.
2016
+ *
2017
+ * Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
2018
+ *
2019
+ * 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).
2020
+ * @param _id - ID of the member to unmute.
2021
+ * @public
2022
+ * @requiredField _id
2023
+ * @permissionId MEMBERS.MEMBER_MUTE
2024
+ * @permissionScope Manage Members
2025
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2026
+ * @applicableIdentity APP
2027
+ * @fqn com.wixpress.members.api.Members.UnmuteMember
2028
+ */
2029
+ export declare function unmuteMember(_id: string): Promise<NonNullablePaths<UnmuteMemberResponse, {
2030
+ [P in MemberNonNullablePaths]: `member.${P}`;
2031
+ }[MemberNonNullablePaths]>>;
2032
+ /**
2033
+ * Changes member status to `"APPROVED"` and gives access to members-only pages.
2034
+ *
2035
+ * Call this API to:
2036
+ * - Approve a pending member.
2037
+ * - Unblock a blocked member.
2038
+ * @param _id - ID of the member to approve.
2039
+ * @public
2040
+ * @requiredField _id
2041
+ * @permissionId MEMBERS.MEMBER_APPROVE
2042
+ * @permissionScope Manage Members
2043
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2044
+ * @applicableIdentity APP
2045
+ * @fqn com.wixpress.members.api.Members.ApproveMember
2046
+ */
2047
+ export declare function approveMember(_id: string): Promise<NonNullablePaths<ApproveMemberResponse, {
2048
+ [P in MemberNonNullablePaths]: `member.${P}`;
2049
+ }[MemberNonNullablePaths]>>;
2050
+ /**
2051
+ * Blocks a member.
2052
+ *
2053
+ * A blocked member can't log in to members-only pages.
2054
+ *
2055
+ * To unblock a member, call Approve Member.
2056
+ * @param _id - ID of a member to block.
2057
+ * @public
2058
+ * @requiredField _id
2059
+ * @permissionId MEMBERS.MEMBER_BLOCK
2060
+ * @permissionScope Manage Members
2061
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2062
+ * @applicableIdentity APP
2063
+ * @fqn com.wixpress.members.api.Members.BlockMember
2064
+ */
2065
+ export declare function blockMember(_id: string): Promise<NonNullablePaths<BlockMemberResponse, {
2066
+ [P in MemberNonNullablePaths]: `member.${P}`;
2067
+ }[MemberNonNullablePaths]>>;
2068
+ /**
2069
+ * Disconnects a member.
2070
+ *
2071
+ * A disconnected member can't log in to members-only pages, and the member isn't visible in the dashboard.
2072
+ *
2073
+ * >**Note:** This action is irreversible. To connect the same member again, you have to create a member with a new slug.
2074
+ * @param _id - ID of a member to disconnect.
2075
+ * @public
2076
+ * @requiredField _id
2077
+ * @permissionId MEMBERS.MEMBER_DISCONNECT
2078
+ * @permissionScope Manage Members
2079
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2080
+ * @permissionScope Manage Challenges
2081
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2082
+ * @applicableIdentity APP
2083
+ * @fqn com.wixpress.members.api.Members.DisconnectMember
2084
+ */
2085
+ export declare function disconnectMember(_id: string): Promise<NonNullablePaths<DisconnectMemberResponse, {
2086
+ [P in MemberNonNullablePaths]: `member.${P}`;
2087
+ }[MemberNonNullablePaths]>>;
2088
+ /**
2089
+ * Deletes a member by ID.
2090
+ *
2091
+ * 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.
2092
+ * @param _id - ID of a member to delete.
2093
+ * @public
2094
+ * @requiredField _id
2095
+ * @permissionId MEMBERS.MEMBER_DELETE
2096
+ * @permissionScope Manage Members
2097
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2098
+ * @applicableIdentity APP
2099
+ * @fqn com.wixpress.members.api.Members.DeleteMember
2100
+ */
2101
+ export declare function deleteMember(_id: string): Promise<void>;
2102
+ /**
2103
+ * Deletes the current member.
2104
+ *
2105
+ * After calling this method, the member is logged out of the site.
2106
+ *
2107
+ * 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.
2108
+ *
2109
+ * >**Note:**
2110
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
2111
+ * @public
2112
+ * @permissionId MEMBERS.MEMBER_DELETE
2113
+ * @permissionScope Manage Members
2114
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2115
+ * @applicableIdentity APP
2116
+ * @fqn com.wixpress.members.api.Members.DeleteMyMember
2117
+ */
2118
+ export declare function deleteMyMember(options?: DeleteMyMemberOptions): Promise<void>;
2119
+ export interface DeleteMyMemberOptions {
2120
+ /**
2121
+ * ID of a member receiving the deleted member's content.
2122
+ * @format GUID
2123
+ */
2124
+ contentAssigneeId?: string | null;
2125
+ }
2126
+ /**
2127
+ * Deletes multiple members by `memberId`.
2128
+ *
2129
+ * 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.
2130
+ * @param memberIds - IDs of members to be deleted.
2131
+ * @public
2132
+ * @requiredField memberIds
2133
+ * @permissionId MEMBERS.MEMBER_DELETE
2134
+ * @permissionScope Manage Members
2135
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2136
+ * @applicableIdentity APP
2137
+ * @fqn com.wixpress.members.api.Members.BulkDeleteMembers
2138
+ */
2139
+ 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`>>;
2140
+ /**
2141
+ * Deletes multiple members by the specified filter.
2142
+ *
2143
+ * 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.
2144
+ * @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.
2145
+ * @public
2146
+ * @requiredField filter
2147
+ * @permissionId MEMBERS.MEMBER_DELETE
2148
+ * @permissionScope Manage Members
2149
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2150
+ * @applicableIdentity APP
2151
+ * @fqn com.wixpress.members.api.Members.BulkDeleteMembersByFilter
2152
+ */
2153
+ export declare function bulkDeleteMembersByFilter(filter: any, options?: BulkDeleteMembersByFilterOptions): Promise<NonNullablePaths<BulkDeleteMembersByFilterResponse, `jobId`>>;
2154
+ export interface BulkDeleteMembersByFilterOptions {
2155
+ /**
2156
+ * ID of a member receiving the deleted member's content.
2157
+ * @format GUID
2158
+ */
2159
+ contentAssigneeId?: string | null;
2160
+ /** Plain text search. */
2161
+ search?: Search;
2162
+ }
2163
+ /**
2164
+ * Changes status of multiple members to `"APPROVED"`, and gives access to members-only pages.
2165
+ *
2166
+ * Call this API to:
2167
+ * - Approve pending members.
2168
+ * - Unblock blocked members.
2169
+ * @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.
2170
+ * @public
2171
+ * @requiredField filter
2172
+ * @permissionId MEMBERS.MEMBER_APPROVE
2173
+ * @permissionScope Manage Members
2174
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2175
+ * @applicableIdentity APP
2176
+ * @fqn com.wixpress.members.api.Members.BulkApproveMembers
2177
+ */
2178
+ export declare function bulkApproveMembers(filter: any): Promise<NonNullablePaths<BulkApproveMembersResponse, `jobId`>>;
2179
+ /**
2180
+ * Blocks multiple members by a specified filter.
2181
+ *
2182
+ * Blocked members can't log in to members-only pages.
2183
+ *
2184
+ * To unblock multiple members, call Bulk Approve Members.
2185
+ * @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.
2186
+ * @public
2187
+ * @requiredField filter
2188
+ * @permissionId MEMBERS.MEMBER_BLOCK
2189
+ * @permissionScope Manage Members
2190
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2191
+ * @applicableIdentity APP
2192
+ * @fqn com.wixpress.members.api.Members.BulkBlockMembers
2193
+ */
2194
+ export declare function bulkBlockMembers(filter: any): Promise<NonNullablePaths<BulkBlockMembersResponse, `jobId`>>;
2195
+ /**
2196
+ * Creates a site member.
2197
+ *
2198
+ * After creation, you can call
2199
+ * [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))
2200
+ * to email the member with a link to set their password.
2201
+ * The member can log in to the site
2202
+ * when they set their password for the first time.
2203
+ *
2204
+ * > **Note:**
2205
+ * > When creating multiple members,
2206
+ * > set your requests at least 1 second apart to keep below rate limits.
2207
+ * @public
2208
+ * @permissionId MEMBERS.MEMBER_CREATE
2209
+ * @permissionScope Manage Members
2210
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2211
+ * @permissionScope Manage Challenges
2212
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2213
+ * @applicableIdentity APP
2214
+ * @returns New member.
2215
+ * @fqn com.wixpress.members.api.Members.CreateMember
2216
+ */
2217
+ export declare function createMember(options?: CreateMemberOptions): Promise<NonNullablePaths<Member, MemberNonNullablePaths>>;
2218
+ export interface CreateMemberOptions {
2219
+ /** Member to create. */
2220
+ member?: Member;
2221
+ }
2222
+ /**
2223
+ * Updates a member's properties.
2224
+ *
2225
+ * Only the requested fields are updated.
2226
+ * To clear a field's value, set an empty value with an empty string `""`.
2227
+ *
2228
+ * > **Note:**
2229
+ * > 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.
2230
+ * > However, passing an empty array will have no effect, and these methods must be used to clear all data from the respective array:
2231
+ * >- To clear `contact.addresses`, use `deleteMemberAddresses()`.
2232
+ * >- To clear `contact.emails`, use `deleteMemberEmails()`.
2233
+ * >- To clear `contact.phones`, use `deleteMemberPhones()`.
2234
+ *
2235
+ * > **Note:**
2236
+ * > Only logged-in members can call this method without elevated permissions.
2237
+ * > 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.
2238
+ * @param _id - Member ID.
2239
+ * @public
2240
+ * @requiredField _id
2241
+ * @requiredField member
2242
+ * @param options - Member to update.
2243
+ * @permissionId MEMBERS.MEMBER_UPDATE
2244
+ * @permissionScope Manage Members
2245
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2246
+ * @permissionScope Manage Bookings Services and Settings
2247
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
2248
+ * @permissionScope Manage Events
2249
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2250
+ * @permissionScope Manage Challenges
2251
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2252
+ * @permissionScope Manage Portfolio
2253
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
2254
+ * @permissionScope Access Verticals by Automations
2255
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2256
+ * @permissionScope Manage Restaurants - all permissions
2257
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2258
+ * @permissionScope Set Up Automations
2259
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2260
+ * @applicableIdentity APP
2261
+ * @applicableIdentity MEMBER
2262
+ * @returns Updated member.
2263
+ * @fqn com.wixpress.members.api.Members.UpdateMember
2264
+ */
2265
+ export declare function updateMember(_id: string, member: UpdateMember): Promise<NonNullablePaths<Member, MemberNonNullablePaths>>;
2266
+ export interface UpdateMember {
2267
+ /**
2268
+ * Member ID.
2269
+ * @format GUID
2270
+ * @readonly
2271
+ */
2272
+ _id?: string | null;
2273
+ /**
2274
+ * Email used by a member to log in to the site.
2275
+ * @format EMAIL
2276
+ */
2277
+ loginEmail?: string | null;
2278
+ /**
2279
+ * Whether the email used by a member has been verified.
2280
+ * @readonly
2281
+ */
2282
+ loginEmailVerified?: boolean | null;
2283
+ /**
2284
+ * Member site access status.
2285
+ * @readonly
2286
+ */
2287
+ status?: Status;
2288
+ /**
2289
+ * Contact ID.
2290
+ * @format GUID
2291
+ * @readonly
2292
+ */
2293
+ contactId?: string | null;
2294
+ /**
2295
+ * Member's contact information. Contact information is stored in the
2296
+ * [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).
2297
+ *
2298
+ * The full set of contact data can be accessed and managed with the
2299
+ * 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)).
2300
+ */
2301
+ contact?: Contact;
2302
+ /** Profile display details. */
2303
+ profile?: Profile;
2304
+ /** Member privacy status. */
2305
+ privacyStatus?: PrivacyStatusStatus;
2306
+ /**
2307
+ * Member activity status.
2308
+ * @readonly
2309
+ */
2310
+ activityStatus?: ActivityStatusStatus;
2311
+ /**
2312
+ * Date and time when the member was created.
2313
+ * @readonly
2314
+ */
2315
+ _createdDate?: Date | null;
2316
+ /**
2317
+ * Date and time when the member was updated.
2318
+ * @readonly
2319
+ */
2320
+ _updatedDate?: Date | null;
2321
+ /**
2322
+ * Date and time when the member last logged in to the site.
2323
+ * @readonly
2324
+ */
2325
+ lastLoginDate?: Date | null;
2326
+ }
2327
+ /**
2328
+ * Clears a member's phone numbers.
2329
+ *
2330
+ * `deleteMemberPhones()` clears the `phones` array under the `contact` property.
2331
+ *
2332
+ * > **Note:**
2333
+ * > Only logged-in members can call this method without elevated permissions.
2334
+ * > 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.
2335
+ * @param _id - ID of the member whose phone numbers will be deleted.
2336
+ * @public
2337
+ * @requiredField _id
2338
+ * @permissionId MEMBERS.MEMBER_UPDATE
2339
+ * @permissionScope Manage Members
2340
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2341
+ * @permissionScope Manage Bookings Services and Settings
2342
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
2343
+ * @permissionScope Manage Events
2344
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2345
+ * @permissionScope Manage Challenges
2346
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2347
+ * @permissionScope Manage Portfolio
2348
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
2349
+ * @permissionScope Access Verticals by Automations
2350
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2351
+ * @permissionScope Manage Restaurants - all permissions
2352
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2353
+ * @permissionScope Set Up Automations
2354
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2355
+ * @applicableIdentity APP
2356
+ * @applicableIdentity MEMBER
2357
+ * @fqn com.wixpress.members.api.Members.DeleteMemberPhones
2358
+ */
2359
+ export declare function deleteMemberPhones(_id: string): Promise<NonNullablePaths<DeleteMemberPhonesResponse, {
2360
+ [P in MemberNonNullablePaths]: `member.${P}`;
2361
+ }[MemberNonNullablePaths]>>;
2362
+ /**
2363
+ * Clears a member's email addresses.
2364
+ *
2365
+ * `deleteMemberEmails()` clears the `emails` array under the `contact` property.
2366
+ *
2367
+ * > **Notes:**
2368
+ * > A member can still log in with their `loginEmail`,
2369
+ * > which is not cleared when this method is called.
2370
+ *
2371
+ * > Only logged-in members can call this method without elevated permissions.
2372
+ * > 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.
2373
+ * @param _id - ID of the member whose email addresses will be deleted.
2374
+ * @public
2375
+ * @requiredField _id
2376
+ * @permissionId MEMBERS.MEMBER_UPDATE
2377
+ * @permissionScope Manage Members
2378
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2379
+ * @permissionScope Manage Bookings Services and Settings
2380
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
2381
+ * @permissionScope Manage Events
2382
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2383
+ * @permissionScope Manage Challenges
2384
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2385
+ * @permissionScope Manage Portfolio
2386
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
2387
+ * @permissionScope Access Verticals by Automations
2388
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2389
+ * @permissionScope Manage Restaurants - all permissions
2390
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2391
+ * @permissionScope Set Up Automations
2392
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2393
+ * @applicableIdentity APP
2394
+ * @applicableIdentity MEMBER
2395
+ * @fqn com.wixpress.members.api.Members.DeleteMemberEmails
2396
+ */
2397
+ export declare function deleteMemberEmails(_id: string): Promise<NonNullablePaths<DeleteMemberEmailsResponse, {
2398
+ [P in MemberNonNullablePaths]: `member.${P}`;
2399
+ }[MemberNonNullablePaths]>>;
2400
+ /**
2401
+ * Deletes a member's street addresses.
2402
+ *
2403
+ * `deleteMemberAddresses()` clears the `addresses` array under the `contact` property.
2404
+ *
2405
+ * > **Note:**
2406
+ * > Only logged-in members can call this method without elevated permissions.
2407
+ * > 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.
2408
+ * @param _id - ID of the member whose street addresses will be deleted.
2409
+ * @public
2410
+ * @requiredField _id
2411
+ * @permissionId MEMBERS.MEMBER_UPDATE
2412
+ * @permissionScope Manage Members
2413
+ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2414
+ * @permissionScope Manage Bookings Services and Settings
2415
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
2416
+ * @permissionScope Manage Events
2417
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2418
+ * @permissionScope Manage Challenges
2419
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2420
+ * @permissionScope Manage Portfolio
2421
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
2422
+ * @permissionScope Access Verticals by Automations
2423
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
2424
+ * @permissionScope Manage Restaurants - all permissions
2425
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2426
+ * @permissionScope Set Up Automations
2427
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
2428
+ * @applicableIdentity APP
2429
+ * @applicableIdentity MEMBER
2430
+ * @fqn com.wixpress.members.api.Members.DeleteMemberAddresses
2431
+ */
2432
+ export declare function deleteMemberAddresses(_id: string): Promise<NonNullablePaths<DeleteMemberAddressesResponse, {
2433
+ [P in MemberNonNullablePaths]: `member.${P}`;
2434
+ }[MemberNonNullablePaths]>>;
2435
+ export {};