@wix/auto_sdk_members_members 1.0.52 → 1.0.54

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