@wix/auto_sdk_members_members 1.0.0

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