@wix/auto_sdk_members_members 1.0.58 → 1.0.60
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.
- package/build/cjs/index.d.ts +380 -1
- package/build/cjs/index.js +1800 -15
- package/build/cjs/index.js.map +1 -1
- package/build/{es/src/members-v1-member-members.types.d.ts → cjs/members-v1-member-members.universal-JdMli_Bi.d.ts} +413 -177
- package/build/cjs/meta.d.ts +708 -1
- package/build/cjs/meta.js +1236 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/cjs/src/members-v1-member-members.public.d.ts → es/index.d.mts} +72 -33
- package/build/es/index.mjs +1743 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{cjs/src/members-v1-member-members.types.d.ts → es/members-v1-member-members.universal-JdMli_Bi.d.mts} +413 -177
- package/build/es/meta.d.mts +708 -0
- package/build/es/meta.mjs +1189 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +380 -1
- package/build/internal/cjs/index.js +1800 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{src/members-v1-member-members.types.d.ts → members-v1-member-members.universal-JdMli_Bi.d.ts} +413 -177
- package/build/internal/cjs/meta.d.ts +708 -1
- package/build/internal/cjs/meta.js +1236 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{es/src/members-v1-member-members.public.d.ts → internal/es/index.d.mts} +72 -33
- package/build/internal/es/index.mjs +1743 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/{src/members-v1-member-members.types.d.ts → members-v1-member-members.universal-JdMli_Bi.d.mts} +413 -177
- package/build/internal/es/meta.d.mts +708 -0
- package/build/internal/es/meta.mjs +1189 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +10 -9
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/members-v1-member-members.context.d.ts +0 -46
- package/build/cjs/src/members-v1-member-members.context.js +0 -59
- package/build/cjs/src/members-v1-member-members.context.js.map +0 -1
- package/build/cjs/src/members-v1-member-members.http.d.ts +0 -229
- package/build/cjs/src/members-v1-member-members.http.js +0 -959
- package/build/cjs/src/members-v1-member-members.http.js.map +0 -1
- package/build/cjs/src/members-v1-member-members.meta.d.ts +0 -60
- package/build/cjs/src/members-v1-member-members.meta.js +0 -484
- package/build/cjs/src/members-v1-member-members.meta.js.map +0 -1
- package/build/cjs/src/members-v1-member-members.public.d.ts +0 -341
- package/build/cjs/src/members-v1-member-members.public.js +0 -198
- package/build/cjs/src/members-v1-member-members.public.js.map +0 -1
- package/build/cjs/src/members-v1-member-members.types.js +0 -174
- package/build/cjs/src/members-v1-member-members.types.js.map +0 -1
- package/build/cjs/src/members-v1-member-members.universal.d.ts +0 -2509
- package/build/cjs/src/members-v1-member-members.universal.js +0 -1387
- package/build/cjs/src/members-v1-member-members.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/members-v1-member-members.context.d.ts +0 -46
- package/build/es/src/members-v1-member-members.context.js +0 -46
- package/build/es/src/members-v1-member-members.context.js.map +0 -1
- package/build/es/src/members-v1-member-members.http.d.ts +0 -229
- package/build/es/src/members-v1-member-members.http.js +0 -932
- package/build/es/src/members-v1-member-members.http.js.map +0 -1
- package/build/es/src/members-v1-member-members.meta.d.ts +0 -60
- package/build/es/src/members-v1-member-members.meta.js +0 -434
- package/build/es/src/members-v1-member-members.meta.js.map +0 -1
- package/build/es/src/members-v1-member-members.public.js +0 -161
- package/build/es/src/members-v1-member-members.public.js.map +0 -1
- package/build/es/src/members-v1-member-members.types.js +0 -171
- package/build/es/src/members-v1-member-members.types.js.map +0 -1
- package/build/es/src/members-v1-member-members.universal.d.ts +0 -2509
- package/build/es/src/members-v1-member-members.universal.js +0 -1337
- package/build/es/src/members-v1-member-members.universal.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/src/members-v1-member-members.context.d.ts +0 -46
- package/build/internal/cjs/src/members-v1-member-members.context.js +0 -59
- package/build/internal/cjs/src/members-v1-member-members.context.js.map +0 -1
- package/build/internal/cjs/src/members-v1-member-members.http.d.ts +0 -229
- package/build/internal/cjs/src/members-v1-member-members.http.js +0 -959
- package/build/internal/cjs/src/members-v1-member-members.http.js.map +0 -1
- package/build/internal/cjs/src/members-v1-member-members.meta.d.ts +0 -60
- package/build/internal/cjs/src/members-v1-member-members.meta.js +0 -484
- package/build/internal/cjs/src/members-v1-member-members.meta.js.map +0 -1
- package/build/internal/cjs/src/members-v1-member-members.public.js +0 -198
- package/build/internal/cjs/src/members-v1-member-members.public.js.map +0 -1
- package/build/internal/cjs/src/members-v1-member-members.types.js +0 -174
- package/build/internal/cjs/src/members-v1-member-members.types.js.map +0 -1
- package/build/internal/cjs/src/members-v1-member-members.universal.d.ts +0 -2509
- package/build/internal/cjs/src/members-v1-member-members.universal.js +0 -1387
- package/build/internal/cjs/src/members-v1-member-members.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/members-v1-member-members.context.d.ts +0 -46
- package/build/internal/es/src/members-v1-member-members.context.js +0 -46
- package/build/internal/es/src/members-v1-member-members.context.js.map +0 -1
- package/build/internal/es/src/members-v1-member-members.http.d.ts +0 -229
- package/build/internal/es/src/members-v1-member-members.http.js +0 -932
- package/build/internal/es/src/members-v1-member-members.http.js.map +0 -1
- package/build/internal/es/src/members-v1-member-members.meta.d.ts +0 -60
- package/build/internal/es/src/members-v1-member-members.meta.js +0 -434
- package/build/internal/es/src/members-v1-member-members.meta.js.map +0 -1
- package/build/internal/es/src/members-v1-member-members.public.d.ts +0 -341
- package/build/internal/es/src/members-v1-member-members.public.js +0 -161
- package/build/internal/es/src/members-v1-member-members.public.js.map +0 -1
- package/build/internal/es/src/members-v1-member-members.types.js +0 -171
- package/build/internal/es/src/members-v1-member-members.types.js.map +0 -1
- package/build/internal/es/src/members-v1-member-members.universal.d.ts +0 -2509
- package/build/internal/es/src/members-v1-member-members.universal.js +0 -1337
- package/build/internal/es/src/members-v1-member-members.universal.js.map +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
interface Member {
|
|
2
2
|
/**
|
|
3
3
|
* Member ID.
|
|
4
4
|
* @format GUID
|
|
5
5
|
* @readonly
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
_id?: string | null;
|
|
8
8
|
/**
|
|
9
9
|
* Email used by a member to log in to the site.
|
|
10
10
|
* @format EMAIL
|
|
@@ -47,19 +47,19 @@ export interface Member {
|
|
|
47
47
|
* Date and time when the member was created.
|
|
48
48
|
* @readonly
|
|
49
49
|
*/
|
|
50
|
-
|
|
50
|
+
_createdDate?: Date | null;
|
|
51
51
|
/**
|
|
52
52
|
* Date and time when the member was updated.
|
|
53
53
|
* @readonly
|
|
54
54
|
*/
|
|
55
|
-
|
|
55
|
+
_updatedDate?: Date | null;
|
|
56
56
|
/**
|
|
57
57
|
* Date and time when the member last logged in to the site.
|
|
58
58
|
* @readonly
|
|
59
59
|
*/
|
|
60
60
|
lastLoginDate?: Date | null;
|
|
61
61
|
}
|
|
62
|
-
|
|
62
|
+
declare enum Status {
|
|
63
63
|
/** Insufficient permissions to get the status. */
|
|
64
64
|
UNKNOWN = "UNKNOWN",
|
|
65
65
|
/** Member is created and is waiting for approval by a Wix user. */
|
|
@@ -72,9 +72,9 @@ export declare enum Status {
|
|
|
72
72
|
OFFLINE = "OFFLINE"
|
|
73
73
|
}
|
|
74
74
|
/** @enumType */
|
|
75
|
-
|
|
75
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PENDING' | 'APPROVED' | 'BLOCKED' | 'OFFLINE';
|
|
76
76
|
/** Contact info associated with the member. */
|
|
77
|
-
|
|
77
|
+
interface Contact {
|
|
78
78
|
/** Contact's first name. */
|
|
79
79
|
firstName?: string | null;
|
|
80
80
|
/** Contact's last name. */
|
|
@@ -106,14 +106,16 @@ export interface Contact {
|
|
|
106
106
|
*/
|
|
107
107
|
jobTitle?: string | null;
|
|
108
108
|
/**
|
|
109
|
-
* Custom fields
|
|
110
|
-
*
|
|
111
|
-
*
|
|
109
|
+
* 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.
|
|
110
|
+
*
|
|
111
|
+
* > **Notes:**
|
|
112
|
+
* > - Only custom fields added to the member profile in the dashboard are available through the Members API. Empty fields are not returned.
|
|
113
|
+
* > - When updating a member, `name` is ignored.
|
|
112
114
|
*/
|
|
113
115
|
customFields?: Record<string, CustomField>;
|
|
114
116
|
}
|
|
115
117
|
/** Street address. */
|
|
116
|
-
|
|
118
|
+
interface Address extends AddressStreetOneOf {
|
|
117
119
|
/** Street address object, with number and name in separate fields. */
|
|
118
120
|
streetAddress?: StreetAddress;
|
|
119
121
|
/**
|
|
@@ -126,7 +128,7 @@ export interface Address extends AddressStreetOneOf {
|
|
|
126
128
|
* @format GUID
|
|
127
129
|
* @readonly
|
|
128
130
|
*/
|
|
129
|
-
|
|
131
|
+
_id?: string | null;
|
|
130
132
|
/**
|
|
131
133
|
* Free text providing more detailed address information,
|
|
132
134
|
* such as apartment, suite, or floor.
|
|
@@ -148,7 +150,7 @@ export interface Address extends AddressStreetOneOf {
|
|
|
148
150
|
postalCode?: string | null;
|
|
149
151
|
}
|
|
150
152
|
/** @oneof */
|
|
151
|
-
|
|
153
|
+
interface AddressStreetOneOf {
|
|
152
154
|
/** Street address object, with number and name in separate fields. */
|
|
153
155
|
streetAddress?: StreetAddress;
|
|
154
156
|
/**
|
|
@@ -157,7 +159,7 @@ export interface AddressStreetOneOf {
|
|
|
157
159
|
*/
|
|
158
160
|
addressLine?: string | null;
|
|
159
161
|
}
|
|
160
|
-
|
|
162
|
+
interface StreetAddress {
|
|
161
163
|
/**
|
|
162
164
|
* Street number.
|
|
163
165
|
* @maxLength 100
|
|
@@ -169,14 +171,14 @@ export interface StreetAddress {
|
|
|
169
171
|
*/
|
|
170
172
|
name?: string;
|
|
171
173
|
}
|
|
172
|
-
|
|
174
|
+
interface CustomField {
|
|
173
175
|
/** Custom field name. */
|
|
174
176
|
name?: string | null;
|
|
175
177
|
/** Custom field value. */
|
|
176
178
|
value?: any;
|
|
177
179
|
}
|
|
178
180
|
/** Member Profile */
|
|
179
|
-
|
|
181
|
+
interface Profile {
|
|
180
182
|
/**
|
|
181
183
|
* Name that identifies the member to other members.
|
|
182
184
|
* Displayed on the member's profile page
|
|
@@ -205,12 +207,12 @@ export interface Profile {
|
|
|
205
207
|
*/
|
|
206
208
|
title?: string | null;
|
|
207
209
|
}
|
|
208
|
-
|
|
210
|
+
interface Image {
|
|
209
211
|
/**
|
|
210
212
|
* Wix Media image ID,
|
|
211
213
|
* set when the member selects an image from Wix Media.
|
|
212
214
|
*/
|
|
213
|
-
|
|
215
|
+
_id?: string;
|
|
214
216
|
/** Image URL. */
|
|
215
217
|
url?: string;
|
|
216
218
|
/** Original image width. */
|
|
@@ -230,7 +232,7 @@ export interface Image {
|
|
|
230
232
|
*/
|
|
231
233
|
offsetY?: number | null;
|
|
232
234
|
}
|
|
233
|
-
|
|
235
|
+
declare enum PrivacyStatusStatus {
|
|
234
236
|
/** Insufficient permissions to get the status. */
|
|
235
237
|
UNKNOWN = "UNKNOWN",
|
|
236
238
|
/** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
|
|
@@ -239,8 +241,8 @@ export declare enum PrivacyStatusStatus {
|
|
|
239
241
|
PUBLIC = "PUBLIC"
|
|
240
242
|
}
|
|
241
243
|
/** @enumType */
|
|
242
|
-
|
|
243
|
-
|
|
244
|
+
type PrivacyStatusStatusWithLiterals = PrivacyStatusStatus | 'UNKNOWN' | 'PRIVATE' | 'PUBLIC';
|
|
245
|
+
declare enum ActivityStatusStatus {
|
|
244
246
|
/** Insufficient permissions to get the status. */
|
|
245
247
|
UNKNOWN = "UNKNOWN",
|
|
246
248
|
/** Member can write forum posts and blog comments. */
|
|
@@ -249,8 +251,8 @@ export declare enum ActivityStatusStatus {
|
|
|
249
251
|
MUTED = "MUTED"
|
|
250
252
|
}
|
|
251
253
|
/** @enumType */
|
|
252
|
-
|
|
253
|
-
|
|
254
|
+
type ActivityStatusStatusWithLiterals = ActivityStatusStatus | 'UNKNOWN' | 'ACTIVE' | 'MUTED';
|
|
255
|
+
interface ExtendedFields {
|
|
254
256
|
/**
|
|
255
257
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
256
258
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -261,7 +263,7 @@ export interface ExtendedFields {
|
|
|
261
263
|
*/
|
|
262
264
|
namespaces?: Record<string, Record<string, any>>;
|
|
263
265
|
}
|
|
264
|
-
|
|
266
|
+
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
265
267
|
/**
|
|
266
268
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
267
269
|
* @format GUID
|
|
@@ -292,7 +294,7 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
292
294
|
hardPurge?: boolean;
|
|
293
295
|
}
|
|
294
296
|
/** @oneof */
|
|
295
|
-
|
|
297
|
+
interface InvalidateCacheGetByOneOf {
|
|
296
298
|
/**
|
|
297
299
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
298
300
|
* @format GUID
|
|
@@ -314,7 +316,7 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
314
316
|
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
315
317
|
customTag?: CustomTag;
|
|
316
318
|
}
|
|
317
|
-
|
|
319
|
+
interface App {
|
|
318
320
|
/**
|
|
319
321
|
* The AppDefId
|
|
320
322
|
* @minLength 1
|
|
@@ -326,7 +328,7 @@ export interface App {
|
|
|
326
328
|
*/
|
|
327
329
|
instanceId?: string;
|
|
328
330
|
}
|
|
329
|
-
|
|
331
|
+
interface Page {
|
|
330
332
|
/**
|
|
331
333
|
* the msid the page is on
|
|
332
334
|
* @format GUID
|
|
@@ -338,7 +340,7 @@ export interface Page {
|
|
|
338
340
|
*/
|
|
339
341
|
pageId?: string;
|
|
340
342
|
}
|
|
341
|
-
|
|
343
|
+
interface URI {
|
|
342
344
|
/**
|
|
343
345
|
* the msid the URI is on
|
|
344
346
|
* @format GUID
|
|
@@ -350,7 +352,7 @@ export interface URI {
|
|
|
350
352
|
*/
|
|
351
353
|
uriPath?: string;
|
|
352
354
|
}
|
|
353
|
-
|
|
355
|
+
interface File {
|
|
354
356
|
/**
|
|
355
357
|
* the msid the file is related to
|
|
356
358
|
* @format GUID
|
|
@@ -363,7 +365,7 @@ export interface File {
|
|
|
363
365
|
*/
|
|
364
366
|
fileName?: string;
|
|
365
367
|
}
|
|
366
|
-
|
|
368
|
+
interface CustomTag {
|
|
367
369
|
/**
|
|
368
370
|
* the msid the tag is related to
|
|
369
371
|
* @format GUID
|
|
@@ -376,44 +378,44 @@ export interface CustomTag {
|
|
|
376
378
|
*/
|
|
377
379
|
tag?: string;
|
|
378
380
|
}
|
|
379
|
-
|
|
381
|
+
interface UpdateMySlugRequest {
|
|
380
382
|
/**
|
|
381
383
|
* New slug.
|
|
382
384
|
* @maxLength 255
|
|
383
385
|
*/
|
|
384
386
|
slug: string;
|
|
385
387
|
}
|
|
386
|
-
|
|
388
|
+
interface UpdateMySlugResponse {
|
|
387
389
|
/** Updated member. */
|
|
388
390
|
member?: Member;
|
|
389
391
|
}
|
|
390
|
-
|
|
392
|
+
interface SlugAlreadyExistsPayload {
|
|
391
393
|
slug?: string;
|
|
392
394
|
}
|
|
393
|
-
|
|
395
|
+
interface UpdateMemberSlugRequest {
|
|
394
396
|
/**
|
|
395
397
|
* Member ID.
|
|
396
398
|
* @format GUID
|
|
397
399
|
*/
|
|
398
|
-
|
|
400
|
+
_id: string;
|
|
399
401
|
/**
|
|
400
402
|
* New slug.
|
|
401
403
|
* @maxLength 255
|
|
402
404
|
*/
|
|
403
405
|
slug: string;
|
|
404
406
|
}
|
|
405
|
-
|
|
407
|
+
interface UpdateMemberSlugResponse {
|
|
406
408
|
/** Updated member. */
|
|
407
409
|
member?: Member;
|
|
408
410
|
}
|
|
409
|
-
|
|
411
|
+
interface JoinCommunityRequest {
|
|
410
412
|
}
|
|
411
413
|
/** Member profile. */
|
|
412
|
-
|
|
414
|
+
interface JoinCommunityResponse {
|
|
413
415
|
/** The updated member. */
|
|
414
416
|
member?: Member;
|
|
415
417
|
}
|
|
416
|
-
|
|
418
|
+
interface MemberJoinedCommunity {
|
|
417
419
|
/**
|
|
418
420
|
* ID of the member who joined the community.
|
|
419
421
|
* @format GUID
|
|
@@ -421,14 +423,14 @@ export interface MemberJoinedCommunity {
|
|
|
421
423
|
*/
|
|
422
424
|
memberId?: string;
|
|
423
425
|
}
|
|
424
|
-
|
|
426
|
+
interface LeaveCommunityRequest {
|
|
425
427
|
}
|
|
426
428
|
/** Member profile. */
|
|
427
|
-
|
|
429
|
+
interface LeaveCommunityResponse {
|
|
428
430
|
/** The updated member. */
|
|
429
431
|
member?: Member;
|
|
430
432
|
}
|
|
431
|
-
|
|
433
|
+
interface MemberLeftCommunity {
|
|
432
434
|
/**
|
|
433
435
|
* ID of the site member who left the community.
|
|
434
436
|
* @format GUID
|
|
@@ -436,7 +438,7 @@ export interface MemberLeftCommunity {
|
|
|
436
438
|
*/
|
|
437
439
|
memberId?: string;
|
|
438
440
|
}
|
|
439
|
-
|
|
441
|
+
interface GetMyMemberRequest {
|
|
440
442
|
/**
|
|
441
443
|
* Predefined set of fields to return.
|
|
442
444
|
*
|
|
@@ -445,7 +447,7 @@ export interface GetMyMemberRequest {
|
|
|
445
447
|
*/
|
|
446
448
|
fieldsets?: SetWithLiterals[];
|
|
447
449
|
}
|
|
448
|
-
|
|
450
|
+
declare enum Set {
|
|
449
451
|
/**
|
|
450
452
|
* Includes `id`, `contactId`, `createdDate`, `updatedDate` and the `profile` object.
|
|
451
453
|
* `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
|
|
@@ -457,18 +459,18 @@ export declare enum Set {
|
|
|
457
459
|
FULL = "FULL"
|
|
458
460
|
}
|
|
459
461
|
/** @enumType */
|
|
460
|
-
|
|
462
|
+
type SetWithLiterals = Set | 'PUBLIC' | 'EXTENDED' | 'FULL';
|
|
461
463
|
/** Member profile. */
|
|
462
|
-
|
|
464
|
+
interface GetMyMemberResponse {
|
|
463
465
|
/** The retrieved member. */
|
|
464
466
|
member?: Member;
|
|
465
467
|
}
|
|
466
|
-
|
|
468
|
+
interface GetMemberRequest {
|
|
467
469
|
/**
|
|
468
470
|
* Member ID.
|
|
469
471
|
* @format GUID
|
|
470
472
|
*/
|
|
471
|
-
|
|
473
|
+
_id: string;
|
|
472
474
|
/**
|
|
473
475
|
* Predefined set of fields to return.
|
|
474
476
|
*
|
|
@@ -477,18 +479,18 @@ export interface GetMemberRequest {
|
|
|
477
479
|
*/
|
|
478
480
|
fieldsets?: SetWithLiterals[];
|
|
479
481
|
}
|
|
480
|
-
|
|
482
|
+
interface GetMemberResponse {
|
|
481
483
|
/** The requested member. */
|
|
482
484
|
member?: Member;
|
|
483
485
|
}
|
|
484
|
-
|
|
486
|
+
interface MemberToMemberBlockedPayload {
|
|
485
487
|
/**
|
|
486
488
|
* Member ID.
|
|
487
489
|
* @format GUID
|
|
488
490
|
*/
|
|
489
491
|
memberId?: string;
|
|
490
492
|
}
|
|
491
|
-
|
|
493
|
+
interface ListMembersRequest {
|
|
492
494
|
paging?: Paging;
|
|
493
495
|
/**
|
|
494
496
|
* Predefined sets of fields to return.
|
|
@@ -499,13 +501,13 @@ export interface ListMembersRequest {
|
|
|
499
501
|
fieldsets?: SetWithLiterals[];
|
|
500
502
|
sorting?: Sorting[];
|
|
501
503
|
}
|
|
502
|
-
|
|
504
|
+
interface Paging {
|
|
503
505
|
/** Number of items to load. */
|
|
504
506
|
limit?: number | null;
|
|
505
507
|
/** Number of items to skip in the current sort order. */
|
|
506
508
|
offset?: number | null;
|
|
507
509
|
}
|
|
508
|
-
|
|
510
|
+
interface Sorting {
|
|
509
511
|
/**
|
|
510
512
|
* Name of the field to sort by.
|
|
511
513
|
* @maxLength 512
|
|
@@ -514,13 +516,13 @@ export interface Sorting {
|
|
|
514
516
|
/** Sort order. */
|
|
515
517
|
order?: SortOrderWithLiterals;
|
|
516
518
|
}
|
|
517
|
-
|
|
519
|
+
declare enum SortOrder {
|
|
518
520
|
ASC = "ASC",
|
|
519
521
|
DESC = "DESC"
|
|
520
522
|
}
|
|
521
523
|
/** @enumType */
|
|
522
|
-
|
|
523
|
-
|
|
524
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
525
|
+
interface CursorPaging {
|
|
524
526
|
/**
|
|
525
527
|
* Maximum number of items to return in the results.
|
|
526
528
|
* @max 100
|
|
@@ -535,13 +537,13 @@ export interface CursorPaging {
|
|
|
535
537
|
*/
|
|
536
538
|
cursor?: string | null;
|
|
537
539
|
}
|
|
538
|
-
|
|
540
|
+
interface ListMembersResponse {
|
|
539
541
|
/** List of members. */
|
|
540
542
|
members?: Member[];
|
|
541
543
|
/** Metadata for the paginated results. */
|
|
542
544
|
metadata?: PagingMetadata;
|
|
543
545
|
}
|
|
544
|
-
|
|
546
|
+
interface PagingMetadata {
|
|
545
547
|
/** Number of items returned in the response. */
|
|
546
548
|
count?: number | null;
|
|
547
549
|
/** Offset that was requested. */
|
|
@@ -551,7 +553,7 @@ export interface PagingMetadata {
|
|
|
551
553
|
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
552
554
|
tooManyToCount?: boolean | null;
|
|
553
555
|
}
|
|
554
|
-
|
|
556
|
+
interface CursorPagingMetadata {
|
|
555
557
|
/** Number of items returned in the response. */
|
|
556
558
|
count?: number | null;
|
|
557
559
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -564,7 +566,7 @@ export interface CursorPagingMetadata {
|
|
|
564
566
|
*/
|
|
565
567
|
hasNext?: boolean | null;
|
|
566
568
|
}
|
|
567
|
-
|
|
569
|
+
interface Cursors {
|
|
568
570
|
/**
|
|
569
571
|
* Cursor string pointing to the next page in the list of results.
|
|
570
572
|
* @maxLength 16000
|
|
@@ -576,7 +578,7 @@ export interface Cursors {
|
|
|
576
578
|
*/
|
|
577
579
|
prev?: string | null;
|
|
578
580
|
}
|
|
579
|
-
|
|
581
|
+
interface QueryMembersRequest {
|
|
580
582
|
/** Query options. */
|
|
581
583
|
query?: Query;
|
|
582
584
|
/**
|
|
@@ -589,7 +591,7 @@ export interface QueryMembersRequest {
|
|
|
589
591
|
/** Plain text search. */
|
|
590
592
|
search?: Search;
|
|
591
593
|
}
|
|
592
|
-
|
|
594
|
+
interface Query {
|
|
593
595
|
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
594
596
|
filter?: any;
|
|
595
597
|
/** Limit number of results */
|
|
@@ -598,7 +600,7 @@ export interface Query {
|
|
|
598
600
|
sorting?: Sorting[];
|
|
599
601
|
}
|
|
600
602
|
/** Free text to match in searchable fields */
|
|
601
|
-
|
|
603
|
+
interface Search {
|
|
602
604
|
/**
|
|
603
605
|
* Search term or expression.
|
|
604
606
|
* @minLength 1
|
|
@@ -620,24 +622,24 @@ export interface Search {
|
|
|
620
622
|
*/
|
|
621
623
|
fields?: string[];
|
|
622
624
|
}
|
|
623
|
-
|
|
625
|
+
interface QueryMembersResponse {
|
|
624
626
|
/** List of members that met the query filter criteria. */
|
|
625
627
|
members?: Member[];
|
|
626
628
|
/** Metadata for the paginated results. */
|
|
627
629
|
metadata?: PagingMetadata;
|
|
628
630
|
}
|
|
629
|
-
|
|
631
|
+
interface MuteMemberRequest {
|
|
630
632
|
/**
|
|
631
633
|
* ID of the member to mute.
|
|
632
634
|
* @format GUID
|
|
633
635
|
*/
|
|
634
|
-
|
|
636
|
+
_id: string;
|
|
635
637
|
}
|
|
636
|
-
|
|
638
|
+
interface MuteMemberResponse {
|
|
637
639
|
/** Muted member. */
|
|
638
640
|
member?: Member;
|
|
639
641
|
}
|
|
640
|
-
|
|
642
|
+
interface MemberMuted {
|
|
641
643
|
/**
|
|
642
644
|
* ID of the member who got muted.
|
|
643
645
|
* @format GUID
|
|
@@ -645,18 +647,18 @@ export interface MemberMuted {
|
|
|
645
647
|
*/
|
|
646
648
|
memberId?: string;
|
|
647
649
|
}
|
|
648
|
-
|
|
650
|
+
interface UnmuteMemberRequest {
|
|
649
651
|
/**
|
|
650
652
|
* ID of the member to unmute.
|
|
651
653
|
* @format GUID
|
|
652
654
|
*/
|
|
653
|
-
|
|
655
|
+
_id: string;
|
|
654
656
|
}
|
|
655
|
-
|
|
657
|
+
interface UnmuteMemberResponse {
|
|
656
658
|
/** Unmuted member. */
|
|
657
659
|
member?: Member;
|
|
658
660
|
}
|
|
659
|
-
|
|
661
|
+
interface MemberUnmuted {
|
|
660
662
|
/**
|
|
661
663
|
* ID of the member who got unmuted.
|
|
662
664
|
* @format GUID
|
|
@@ -664,18 +666,18 @@ export interface MemberUnmuted {
|
|
|
664
666
|
*/
|
|
665
667
|
memberId?: string;
|
|
666
668
|
}
|
|
667
|
-
|
|
669
|
+
interface ApproveMemberRequest {
|
|
668
670
|
/**
|
|
669
671
|
* ID of the member to approve.
|
|
670
672
|
* @format GUID
|
|
671
673
|
*/
|
|
672
|
-
|
|
674
|
+
_id: string;
|
|
673
675
|
}
|
|
674
|
-
|
|
676
|
+
interface ApproveMemberResponse {
|
|
675
677
|
/** Approved member. */
|
|
676
678
|
member?: Member;
|
|
677
679
|
}
|
|
678
|
-
|
|
680
|
+
interface MemberApproved {
|
|
679
681
|
/**
|
|
680
682
|
* ID of the member who got approved.
|
|
681
683
|
* @format GUID
|
|
@@ -683,18 +685,18 @@ export interface MemberApproved {
|
|
|
683
685
|
*/
|
|
684
686
|
memberId?: string;
|
|
685
687
|
}
|
|
686
|
-
|
|
688
|
+
interface BlockMemberRequest {
|
|
687
689
|
/**
|
|
688
690
|
* ID of a member to block.
|
|
689
691
|
* @format GUID
|
|
690
692
|
*/
|
|
691
|
-
|
|
693
|
+
_id: string;
|
|
692
694
|
}
|
|
693
|
-
|
|
695
|
+
interface BlockMemberResponse {
|
|
694
696
|
/** Blocked member. */
|
|
695
697
|
member?: Member;
|
|
696
698
|
}
|
|
697
|
-
|
|
699
|
+
interface MemberBlocked {
|
|
698
700
|
/**
|
|
699
701
|
* ID of the member who got blocked.
|
|
700
702
|
* @format GUID
|
|
@@ -702,78 +704,78 @@ export interface MemberBlocked {
|
|
|
702
704
|
*/
|
|
703
705
|
memberId?: string;
|
|
704
706
|
}
|
|
705
|
-
|
|
707
|
+
interface MemberSelfBlockForbiddenPayload {
|
|
706
708
|
/**
|
|
707
709
|
* Target's member ID.
|
|
708
710
|
* @format GUID
|
|
709
711
|
*/
|
|
710
712
|
memberId?: string;
|
|
711
713
|
}
|
|
712
|
-
|
|
714
|
+
interface OwnerMemberBlockForbiddenPayload {
|
|
713
715
|
/**
|
|
714
716
|
* Owner's member ID.
|
|
715
717
|
* @format GUID
|
|
716
718
|
*/
|
|
717
719
|
memberId?: string;
|
|
718
720
|
}
|
|
719
|
-
|
|
721
|
+
interface ActiveSubscriptionMemberBlockForbiddenPayload {
|
|
720
722
|
/**
|
|
721
723
|
* Active subscription member ID.
|
|
722
724
|
* @format GUID
|
|
723
725
|
*/
|
|
724
726
|
memberId?: string;
|
|
725
727
|
}
|
|
726
|
-
|
|
728
|
+
interface DisconnectMemberRequest {
|
|
727
729
|
/**
|
|
728
730
|
* ID of a member to disconnect.
|
|
729
731
|
* @format GUID
|
|
730
732
|
*/
|
|
731
|
-
|
|
733
|
+
_id: string;
|
|
732
734
|
}
|
|
733
|
-
|
|
735
|
+
interface DisconnectMemberResponse {
|
|
734
736
|
/** Disconnected member. */
|
|
735
737
|
member?: Member;
|
|
736
738
|
}
|
|
737
|
-
|
|
739
|
+
interface DeleteMemberRequest {
|
|
738
740
|
/**
|
|
739
741
|
* ID of a member to delete.
|
|
740
742
|
* @format GUID
|
|
741
743
|
*/
|
|
742
|
-
|
|
744
|
+
_id: string;
|
|
743
745
|
}
|
|
744
|
-
|
|
746
|
+
interface DeleteMemberResponse {
|
|
745
747
|
}
|
|
746
|
-
|
|
748
|
+
interface ContentReassignmentRequested {
|
|
747
749
|
fromMember?: Member;
|
|
748
750
|
toMember?: Member;
|
|
749
751
|
}
|
|
750
|
-
|
|
752
|
+
interface ContentDeletionRequested {
|
|
751
753
|
member?: Member;
|
|
752
754
|
}
|
|
753
|
-
|
|
755
|
+
interface OwnerOrContributorDeleteForbiddenPayload {
|
|
754
756
|
/**
|
|
755
757
|
* Owner's or contributor's member ID.
|
|
756
758
|
* @format GUID
|
|
757
759
|
*/
|
|
758
760
|
memberId?: string;
|
|
759
761
|
}
|
|
760
|
-
|
|
762
|
+
interface ActiveSubscriptionMemberDeleteForbiddenPayload {
|
|
761
763
|
/**
|
|
762
764
|
* Active subscription member ID.
|
|
763
765
|
* @format GUID
|
|
764
766
|
*/
|
|
765
767
|
memberId?: string;
|
|
766
768
|
}
|
|
767
|
-
|
|
769
|
+
interface DeleteMyMemberRequest {
|
|
768
770
|
/**
|
|
769
771
|
* ID of a member receiving the deleted member's content.
|
|
770
772
|
* @format GUID
|
|
771
773
|
*/
|
|
772
774
|
contentAssigneeId?: string | null;
|
|
773
775
|
}
|
|
774
|
-
|
|
776
|
+
interface DeleteMyMemberResponse {
|
|
775
777
|
}
|
|
776
|
-
|
|
778
|
+
interface BulkDeleteMembersRequest {
|
|
777
779
|
/**
|
|
778
780
|
* IDs of members to be deleted.
|
|
779
781
|
* @minSize 1
|
|
@@ -782,18 +784,18 @@ export interface BulkDeleteMembersRequest {
|
|
|
782
784
|
*/
|
|
783
785
|
memberIds: string[];
|
|
784
786
|
}
|
|
785
|
-
|
|
787
|
+
interface BulkDeleteMembersResponse {
|
|
786
788
|
/** Result. */
|
|
787
789
|
results?: BulkMemberResult[];
|
|
788
790
|
/** Bulk action result metadata. */
|
|
789
791
|
bulkActionMetadata?: BulkActionMetadata;
|
|
790
792
|
}
|
|
791
|
-
|
|
793
|
+
interface ItemMetadata {
|
|
792
794
|
/**
|
|
793
795
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
794
796
|
* @maxLength 255
|
|
795
797
|
*/
|
|
796
|
-
|
|
798
|
+
_id?: string | null;
|
|
797
799
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
798
800
|
originalIndex?: number;
|
|
799
801
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -801,7 +803,7 @@ export interface ItemMetadata {
|
|
|
801
803
|
/** Details about the error in case of failure. */
|
|
802
804
|
error?: ApplicationError;
|
|
803
805
|
}
|
|
804
|
-
|
|
806
|
+
interface ApplicationError {
|
|
805
807
|
/** Error code. */
|
|
806
808
|
code?: string;
|
|
807
809
|
/** Description of the error. */
|
|
@@ -809,10 +811,10 @@ export interface ApplicationError {
|
|
|
809
811
|
/** Data related to the error. */
|
|
810
812
|
data?: Record<string, any> | null;
|
|
811
813
|
}
|
|
812
|
-
|
|
814
|
+
interface BulkMemberResult {
|
|
813
815
|
itemMetadata?: ItemMetadata;
|
|
814
816
|
}
|
|
815
|
-
|
|
817
|
+
interface BulkActionMetadata {
|
|
816
818
|
/** Number of items that were successfully processed. */
|
|
817
819
|
totalSuccesses?: number;
|
|
818
820
|
/** Number of items that couldn't be processed. */
|
|
@@ -820,7 +822,7 @@ export interface BulkActionMetadata {
|
|
|
820
822
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
821
823
|
undetailedFailures?: number;
|
|
822
824
|
}
|
|
823
|
-
|
|
825
|
+
interface BulkDeleteMembersByFilterRequest {
|
|
824
826
|
/** 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. */
|
|
825
827
|
filter: any;
|
|
826
828
|
/**
|
|
@@ -831,97 +833,97 @@ export interface BulkDeleteMembersByFilterRequest {
|
|
|
831
833
|
/** Plain text search. */
|
|
832
834
|
search?: Search;
|
|
833
835
|
}
|
|
834
|
-
|
|
836
|
+
interface BulkDeleteMembersByFilterResponse {
|
|
835
837
|
/**
|
|
836
838
|
* Job ID.
|
|
837
839
|
* 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.
|
|
838
840
|
*/
|
|
839
841
|
jobId?: string;
|
|
840
842
|
}
|
|
841
|
-
|
|
843
|
+
interface BulkApproveMembersRequest {
|
|
842
844
|
/** 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. */
|
|
843
845
|
filter: any;
|
|
844
846
|
}
|
|
845
|
-
|
|
847
|
+
interface BulkApproveMembersResponse {
|
|
846
848
|
/**
|
|
847
849
|
* Job ID.
|
|
848
850
|
* 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.
|
|
849
851
|
*/
|
|
850
852
|
jobId?: string;
|
|
851
853
|
}
|
|
852
|
-
|
|
854
|
+
interface BulkBlockMembersRequest {
|
|
853
855
|
/** 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. */
|
|
854
856
|
filter: any;
|
|
855
857
|
}
|
|
856
|
-
|
|
858
|
+
interface BulkBlockMembersResponse {
|
|
857
859
|
/**
|
|
858
860
|
* Job ID.
|
|
859
861
|
* 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.
|
|
860
862
|
*/
|
|
861
863
|
jobId?: string;
|
|
862
864
|
}
|
|
863
|
-
|
|
865
|
+
interface CreateMemberRequest {
|
|
864
866
|
/** Member to create. */
|
|
865
867
|
member?: Member;
|
|
866
868
|
}
|
|
867
|
-
|
|
869
|
+
interface CreateMemberResponse {
|
|
868
870
|
/** New member. */
|
|
869
871
|
member?: Member;
|
|
870
872
|
}
|
|
871
|
-
|
|
873
|
+
interface UpdateMemberRequest {
|
|
872
874
|
/** Member info to update. */
|
|
873
875
|
member?: Member;
|
|
874
876
|
}
|
|
875
|
-
|
|
877
|
+
interface UpdateMemberResponse {
|
|
876
878
|
/** Updated member. */
|
|
877
879
|
member?: Member;
|
|
878
880
|
}
|
|
879
|
-
|
|
881
|
+
interface InvalidCustomFieldUrlPayload {
|
|
880
882
|
/** Custom field key and invalid URL. */
|
|
881
883
|
fields?: Record<string, string>;
|
|
882
884
|
}
|
|
883
|
-
|
|
885
|
+
interface DeleteMemberPhonesRequest {
|
|
884
886
|
/**
|
|
885
887
|
* ID of the member whose phone numbers will be deleted.
|
|
886
888
|
* @format GUID
|
|
887
889
|
*/
|
|
888
|
-
|
|
890
|
+
_id: string;
|
|
889
891
|
}
|
|
890
|
-
|
|
892
|
+
interface DeleteMemberPhonesResponse {
|
|
891
893
|
/** Updated member. */
|
|
892
894
|
member?: Member;
|
|
893
895
|
}
|
|
894
|
-
|
|
896
|
+
interface DeleteMemberEmailsRequest {
|
|
895
897
|
/**
|
|
896
898
|
* ID of the member whose email addresses will be deleted.
|
|
897
899
|
* @format GUID
|
|
898
900
|
*/
|
|
899
|
-
|
|
901
|
+
_id: string;
|
|
900
902
|
}
|
|
901
|
-
|
|
903
|
+
interface DeleteMemberEmailsResponse {
|
|
902
904
|
/** Updated member. */
|
|
903
905
|
member?: Member;
|
|
904
906
|
}
|
|
905
|
-
|
|
907
|
+
interface DeleteMemberAddressesRequest {
|
|
906
908
|
/**
|
|
907
909
|
* ID of the member whose street addresses will be deleted.
|
|
908
910
|
* @format GUID
|
|
909
911
|
*/
|
|
910
|
-
|
|
912
|
+
_id: string;
|
|
911
913
|
}
|
|
912
|
-
|
|
914
|
+
interface DeleteMemberAddressesResponse {
|
|
913
915
|
/** Updated member. */
|
|
914
916
|
member?: Member;
|
|
915
917
|
}
|
|
916
|
-
|
|
918
|
+
interface Empty {
|
|
917
919
|
}
|
|
918
|
-
|
|
920
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
919
921
|
createdEvent?: EntityCreatedEvent;
|
|
920
922
|
updatedEvent?: EntityUpdatedEvent;
|
|
921
923
|
deletedEvent?: EntityDeletedEvent;
|
|
922
924
|
actionEvent?: ActionEvent;
|
|
923
925
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
924
|
-
|
|
926
|
+
_id?: string;
|
|
925
927
|
/**
|
|
926
928
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
927
929
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -950,36 +952,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
950
952
|
entityEventSequence?: string | null;
|
|
951
953
|
}
|
|
952
954
|
/** @oneof */
|
|
953
|
-
|
|
955
|
+
interface DomainEventBodyOneOf {
|
|
954
956
|
createdEvent?: EntityCreatedEvent;
|
|
955
957
|
updatedEvent?: EntityUpdatedEvent;
|
|
956
958
|
deletedEvent?: EntityDeletedEvent;
|
|
957
959
|
actionEvent?: ActionEvent;
|
|
958
960
|
}
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
962
|
-
restoreInfo?: RestoreInfo;
|
|
961
|
+
interface EntityCreatedEvent {
|
|
962
|
+
entity?: string;
|
|
963
963
|
}
|
|
964
|
-
|
|
964
|
+
interface RestoreInfo {
|
|
965
965
|
deletedDate?: Date | null;
|
|
966
966
|
}
|
|
967
|
-
|
|
967
|
+
interface EntityUpdatedEvent {
|
|
968
968
|
/**
|
|
969
969
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
970
970
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
971
971
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
972
972
|
*/
|
|
973
|
-
|
|
973
|
+
currentEntity?: string;
|
|
974
974
|
}
|
|
975
|
-
|
|
975
|
+
interface EntityDeletedEvent {
|
|
976
976
|
/** Entity that was deleted. */
|
|
977
|
-
|
|
977
|
+
deletedEntity?: string | null;
|
|
978
978
|
}
|
|
979
|
-
|
|
980
|
-
|
|
979
|
+
interface ActionEvent {
|
|
980
|
+
body?: string;
|
|
981
981
|
}
|
|
982
|
-
|
|
982
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
983
983
|
/** Emitted on a meta site creation. */
|
|
984
984
|
siteCreated?: SiteCreated;
|
|
985
985
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -1045,7 +1045,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
1045
1045
|
assets?: Asset[];
|
|
1046
1046
|
}
|
|
1047
1047
|
/** @oneof */
|
|
1048
|
-
|
|
1048
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
1049
1049
|
/** Emitted on a meta site creation. */
|
|
1050
1050
|
siteCreated?: SiteCreated;
|
|
1051
1051
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -1095,7 +1095,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
1095
1095
|
/** Emitted when Picasso is detached. */
|
|
1096
1096
|
picassoUnassigned?: PicassoUnassigned;
|
|
1097
1097
|
}
|
|
1098
|
-
|
|
1098
|
+
interface Asset {
|
|
1099
1099
|
/**
|
|
1100
1100
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1101
1101
|
* @maxLength 36
|
|
@@ -1109,7 +1109,7 @@ export interface Asset {
|
|
|
1109
1109
|
/** An application state. */
|
|
1110
1110
|
state?: StateWithLiterals;
|
|
1111
1111
|
}
|
|
1112
|
-
|
|
1112
|
+
declare enum State {
|
|
1113
1113
|
UNKNOWN = "UNKNOWN",
|
|
1114
1114
|
ENABLED = "ENABLED",
|
|
1115
1115
|
DISABLED = "DISABLED",
|
|
@@ -1117,8 +1117,8 @@ export declare enum State {
|
|
|
1117
1117
|
DEMO = "DEMO"
|
|
1118
1118
|
}
|
|
1119
1119
|
/** @enumType */
|
|
1120
|
-
|
|
1121
|
-
|
|
1120
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
1121
|
+
interface SiteCreated {
|
|
1122
1122
|
/**
|
|
1123
1123
|
* A template identifier (empty if not created from a template).
|
|
1124
1124
|
* @maxLength 36
|
|
@@ -1147,7 +1147,7 @@ export interface SiteCreated {
|
|
|
1147
1147
|
/** A namespace. */
|
|
1148
1148
|
namespace?: NamespaceWithLiterals;
|
|
1149
1149
|
}
|
|
1150
|
-
|
|
1150
|
+
declare enum SiteCreatedContext {
|
|
1151
1151
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1152
1152
|
OTHER = "OTHER",
|
|
1153
1153
|
/** A meta site was created from template. */
|
|
@@ -1162,8 +1162,8 @@ export declare enum SiteCreatedContext {
|
|
|
1162
1162
|
FLASH = "FLASH"
|
|
1163
1163
|
}
|
|
1164
1164
|
/** @enumType */
|
|
1165
|
-
|
|
1166
|
-
|
|
1165
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
1166
|
+
declare enum Namespace {
|
|
1167
1167
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1168
1168
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1169
1169
|
WIX = "WIX",
|
|
@@ -1246,9 +1246,9 @@ export declare enum Namespace {
|
|
|
1246
1246
|
MIMIR = "MIMIR"
|
|
1247
1247
|
}
|
|
1248
1248
|
/** @enumType */
|
|
1249
|
-
|
|
1249
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
|
|
1250
1250
|
/** Site transferred to another user. */
|
|
1251
|
-
|
|
1251
|
+
interface SiteTransferred {
|
|
1252
1252
|
/**
|
|
1253
1253
|
* A previous owner id (user that transfers meta site).
|
|
1254
1254
|
* @format GUID
|
|
@@ -1261,11 +1261,11 @@ export interface SiteTransferred {
|
|
|
1261
1261
|
newOwnerId?: string;
|
|
1262
1262
|
}
|
|
1263
1263
|
/** Soft deletion of the meta site. Could be restored. */
|
|
1264
|
-
|
|
1264
|
+
interface SiteDeleted {
|
|
1265
1265
|
/** A deletion context. */
|
|
1266
1266
|
deleteContext?: DeleteContext;
|
|
1267
1267
|
}
|
|
1268
|
-
|
|
1268
|
+
interface DeleteContext {
|
|
1269
1269
|
/** When the meta site was deleted. */
|
|
1270
1270
|
dateDeleted?: Date | null;
|
|
1271
1271
|
/** A status. */
|
|
@@ -1281,7 +1281,7 @@ export interface DeleteContext {
|
|
|
1281
1281
|
*/
|
|
1282
1282
|
initiatorId?: string | null;
|
|
1283
1283
|
}
|
|
1284
|
-
|
|
1284
|
+
declare enum DeleteStatus {
|
|
1285
1285
|
UNKNOWN = "UNKNOWN",
|
|
1286
1286
|
TRASH = "TRASH",
|
|
1287
1287
|
DELETED = "DELETED",
|
|
@@ -1289,14 +1289,14 @@ export declare enum DeleteStatus {
|
|
|
1289
1289
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1290
1290
|
}
|
|
1291
1291
|
/** @enumType */
|
|
1292
|
-
|
|
1292
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
1293
1293
|
/** Restoration of the meta site. */
|
|
1294
|
-
|
|
1294
|
+
interface SiteUndeleted {
|
|
1295
1295
|
}
|
|
1296
1296
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1297
|
-
|
|
1297
|
+
interface SitePublished {
|
|
1298
1298
|
}
|
|
1299
|
-
|
|
1299
|
+
interface SiteUnpublished {
|
|
1300
1300
|
/**
|
|
1301
1301
|
* A list of URLs previously associated with the meta site.
|
|
1302
1302
|
* @maxLength 4000
|
|
@@ -1304,9 +1304,9 @@ export interface SiteUnpublished {
|
|
|
1304
1304
|
*/
|
|
1305
1305
|
urls?: string[];
|
|
1306
1306
|
}
|
|
1307
|
-
|
|
1307
|
+
interface SiteMarkedAsTemplate {
|
|
1308
1308
|
}
|
|
1309
|
-
|
|
1309
|
+
interface SiteMarkedAsWixSite {
|
|
1310
1310
|
}
|
|
1311
1311
|
/**
|
|
1312
1312
|
* Represents a service provisioned a site.
|
|
@@ -1323,7 +1323,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
1323
1323
|
* changes made to the original template afterward.
|
|
1324
1324
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1325
1325
|
*/
|
|
1326
|
-
|
|
1326
|
+
interface ServiceProvisioned {
|
|
1327
1327
|
/**
|
|
1328
1328
|
* Either UUID or EmbeddedServiceType.
|
|
1329
1329
|
* @maxLength 36
|
|
@@ -1350,7 +1350,7 @@ export interface ServiceProvisioned {
|
|
|
1350
1350
|
*/
|
|
1351
1351
|
originMetaSiteId?: string | null;
|
|
1352
1352
|
}
|
|
1353
|
-
|
|
1353
|
+
interface ServiceRemoved {
|
|
1354
1354
|
/**
|
|
1355
1355
|
* Either UUID or EmbeddedServiceType.
|
|
1356
1356
|
* @maxLength 36
|
|
@@ -1368,7 +1368,7 @@ export interface ServiceRemoved {
|
|
|
1368
1368
|
version?: string | null;
|
|
1369
1369
|
}
|
|
1370
1370
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1371
|
-
|
|
1371
|
+
interface SiteRenamed {
|
|
1372
1372
|
/**
|
|
1373
1373
|
* A new meta site name (URL slug).
|
|
1374
1374
|
* @maxLength 20
|
|
@@ -1385,21 +1385,21 @@ export interface SiteRenamed {
|
|
|
1385
1385
|
*
|
|
1386
1386
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1387
1387
|
*/
|
|
1388
|
-
|
|
1388
|
+
interface SiteHardDeleted {
|
|
1389
1389
|
/** A deletion context. */
|
|
1390
1390
|
deleteContext?: DeleteContext;
|
|
1391
1391
|
}
|
|
1392
|
-
|
|
1392
|
+
interface NamespaceChanged {
|
|
1393
1393
|
/** A previous namespace. */
|
|
1394
1394
|
oldNamespace?: NamespaceWithLiterals;
|
|
1395
1395
|
/** A new namespace. */
|
|
1396
1396
|
newNamespace?: NamespaceWithLiterals;
|
|
1397
1397
|
}
|
|
1398
1398
|
/** Assigned Studio editor */
|
|
1399
|
-
|
|
1399
|
+
interface StudioAssigned {
|
|
1400
1400
|
}
|
|
1401
1401
|
/** Unassigned Studio editor */
|
|
1402
|
-
|
|
1402
|
+
interface StudioUnassigned {
|
|
1403
1403
|
}
|
|
1404
1404
|
/**
|
|
1405
1405
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -1409,13 +1409,13 @@ export interface StudioUnassigned {
|
|
|
1409
1409
|
*
|
|
1410
1410
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1411
1411
|
*/
|
|
1412
|
-
|
|
1412
|
+
interface SiteUrlChanged {
|
|
1413
1413
|
}
|
|
1414
1414
|
/**
|
|
1415
1415
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1416
1416
|
* Consumed by other teams to remove relevant data.
|
|
1417
1417
|
*/
|
|
1418
|
-
|
|
1418
|
+
interface SitePurgedExternally {
|
|
1419
1419
|
/**
|
|
1420
1420
|
* @maxLength 2048
|
|
1421
1421
|
* @maxSize 100
|
|
@@ -1425,28 +1425,28 @@ export interface SitePurgedExternally {
|
|
|
1425
1425
|
appDefId?: string[];
|
|
1426
1426
|
}
|
|
1427
1427
|
/** Assigned Odeditor */
|
|
1428
|
-
|
|
1428
|
+
interface OdeditorAssigned {
|
|
1429
1429
|
}
|
|
1430
1430
|
/** Unassigned Odeditor */
|
|
1431
|
-
|
|
1431
|
+
interface OdeditorUnassigned {
|
|
1432
1432
|
}
|
|
1433
1433
|
/** Assigned Picasso editor */
|
|
1434
|
-
|
|
1434
|
+
interface PicassoAssigned {
|
|
1435
1435
|
}
|
|
1436
1436
|
/** Unassigned Picasso */
|
|
1437
|
-
|
|
1437
|
+
interface PicassoUnassigned {
|
|
1438
1438
|
}
|
|
1439
|
-
|
|
1439
|
+
interface MemberOwnershipTransferred {
|
|
1440
1440
|
fromMember?: Member;
|
|
1441
1441
|
toMember?: Member;
|
|
1442
1442
|
}
|
|
1443
|
-
|
|
1443
|
+
interface MemberIdChanged {
|
|
1444
1444
|
/** @format GUID */
|
|
1445
1445
|
fromId?: string;
|
|
1446
1446
|
/** @format GUID */
|
|
1447
1447
|
toId?: string;
|
|
1448
1448
|
}
|
|
1449
|
-
|
|
1449
|
+
interface MessageEnvelope {
|
|
1450
1450
|
/**
|
|
1451
1451
|
* App instance ID.
|
|
1452
1452
|
* @format GUID
|
|
@@ -1462,7 +1462,7 @@ export interface MessageEnvelope {
|
|
|
1462
1462
|
/** Stringify payload. */
|
|
1463
1463
|
data?: string;
|
|
1464
1464
|
}
|
|
1465
|
-
|
|
1465
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1466
1466
|
/**
|
|
1467
1467
|
* ID of a site visitor that has not logged in to the site.
|
|
1468
1468
|
* @format GUID
|
|
@@ -1487,7 +1487,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1487
1487
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1488
1488
|
}
|
|
1489
1489
|
/** @oneof */
|
|
1490
|
-
|
|
1490
|
+
interface IdentificationDataIdOneOf {
|
|
1491
1491
|
/**
|
|
1492
1492
|
* ID of a site visitor that has not logged in to the site.
|
|
1493
1493
|
* @format GUID
|
|
@@ -1509,7 +1509,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1509
1509
|
*/
|
|
1510
1510
|
appId?: string;
|
|
1511
1511
|
}
|
|
1512
|
-
|
|
1512
|
+
declare enum WebhookIdentityType {
|
|
1513
1513
|
UNKNOWN = "UNKNOWN",
|
|
1514
1514
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1515
1515
|
MEMBER = "MEMBER",
|
|
@@ -1517,4 +1517,240 @@ export declare enum WebhookIdentityType {
|
|
|
1517
1517
|
APP = "APP"
|
|
1518
1518
|
}
|
|
1519
1519
|
/** @enumType */
|
|
1520
|
-
|
|
1520
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1521
|
+
interface BaseEventMetadata {
|
|
1522
|
+
/**
|
|
1523
|
+
* App instance ID.
|
|
1524
|
+
* @format GUID
|
|
1525
|
+
*/
|
|
1526
|
+
instanceId?: string | null;
|
|
1527
|
+
/**
|
|
1528
|
+
* Event type.
|
|
1529
|
+
* @maxLength 150
|
|
1530
|
+
*/
|
|
1531
|
+
eventType?: string;
|
|
1532
|
+
/** The identification type and identity data. */
|
|
1533
|
+
identity?: IdentificationData;
|
|
1534
|
+
}
|
|
1535
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1536
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1537
|
+
_id?: string;
|
|
1538
|
+
/**
|
|
1539
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1540
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1541
|
+
*/
|
|
1542
|
+
entityFqdn?: string;
|
|
1543
|
+
/**
|
|
1544
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1545
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1546
|
+
*/
|
|
1547
|
+
slug?: string;
|
|
1548
|
+
/** ID of the entity associated with the event. */
|
|
1549
|
+
entityId?: string;
|
|
1550
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1551
|
+
eventTime?: Date | null;
|
|
1552
|
+
/**
|
|
1553
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1554
|
+
* (for example, GDPR).
|
|
1555
|
+
*/
|
|
1556
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1557
|
+
/** If present, indicates the action that triggered the event. */
|
|
1558
|
+
originatedFrom?: string | null;
|
|
1559
|
+
/**
|
|
1560
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1561
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1562
|
+
*/
|
|
1563
|
+
entityEventSequence?: string | null;
|
|
1564
|
+
}
|
|
1565
|
+
interface MemberCreatedEnvelope {
|
|
1566
|
+
entity: Member;
|
|
1567
|
+
metadata: EventMetadata;
|
|
1568
|
+
}
|
|
1569
|
+
interface MemberDeletedEnvelope {
|
|
1570
|
+
metadata: EventMetadata;
|
|
1571
|
+
}
|
|
1572
|
+
interface MemberUpdatedEnvelope {
|
|
1573
|
+
entity: Member;
|
|
1574
|
+
metadata: EventMetadata;
|
|
1575
|
+
}
|
|
1576
|
+
interface GetCurrentMemberOptions {
|
|
1577
|
+
/**
|
|
1578
|
+
* Predefined set of fields to return.
|
|
1579
|
+
*
|
|
1580
|
+
* Default: `"PUBLIC"`.
|
|
1581
|
+
* @maxSize 3
|
|
1582
|
+
*/
|
|
1583
|
+
fieldsets?: SetWithLiterals[];
|
|
1584
|
+
}
|
|
1585
|
+
interface GetMemberOptions {
|
|
1586
|
+
/**
|
|
1587
|
+
* Predefined set of fields to return.
|
|
1588
|
+
*
|
|
1589
|
+
* Defaults to `"PUBLIC"`.
|
|
1590
|
+
* @maxSize 3
|
|
1591
|
+
*/
|
|
1592
|
+
fieldsets?: SetWithLiterals[];
|
|
1593
|
+
}
|
|
1594
|
+
interface ListMembersOptions {
|
|
1595
|
+
/** Paging options. */
|
|
1596
|
+
paging?: Paging;
|
|
1597
|
+
/**
|
|
1598
|
+
* Predefined sets of fields to return.
|
|
1599
|
+
*
|
|
1600
|
+
* Default: `"PUBLIC"`.
|
|
1601
|
+
* @maxSize 3
|
|
1602
|
+
*/
|
|
1603
|
+
fieldsets?: SetWithLiterals[];
|
|
1604
|
+
/** Sorting options. */
|
|
1605
|
+
sorting?: Sorting[];
|
|
1606
|
+
}
|
|
1607
|
+
interface QueryMembersOptions {
|
|
1608
|
+
/**
|
|
1609
|
+
* Predefined sets of fields to return.
|
|
1610
|
+
*
|
|
1611
|
+
* Default: `"PUBLIC"`.
|
|
1612
|
+
* @maxSize 3
|
|
1613
|
+
*/
|
|
1614
|
+
fieldsets?: SetWithLiterals[] | undefined;
|
|
1615
|
+
/** Plain text search. */
|
|
1616
|
+
search?: Search | undefined;
|
|
1617
|
+
}
|
|
1618
|
+
interface QueryOffsetResult {
|
|
1619
|
+
currentPage: number | undefined;
|
|
1620
|
+
totalPages: number | undefined;
|
|
1621
|
+
totalCount: number | undefined;
|
|
1622
|
+
hasNext: () => boolean;
|
|
1623
|
+
hasPrev: () => boolean;
|
|
1624
|
+
length: number;
|
|
1625
|
+
pageSize: number;
|
|
1626
|
+
}
|
|
1627
|
+
interface MembersQueryResult extends QueryOffsetResult {
|
|
1628
|
+
items: Member[];
|
|
1629
|
+
query: MembersQueryBuilder;
|
|
1630
|
+
next: () => Promise<MembersQueryResult>;
|
|
1631
|
+
prev: () => Promise<MembersQueryResult>;
|
|
1632
|
+
}
|
|
1633
|
+
interface MembersQueryBuilder {
|
|
1634
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1635
|
+
* @param value - Value to compare against.
|
|
1636
|
+
*/
|
|
1637
|
+
eq: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
1638
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1639
|
+
* @param value - Value to compare against.
|
|
1640
|
+
*/
|
|
1641
|
+
ne: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
1642
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1643
|
+
* @param value - Value to compare against.
|
|
1644
|
+
*/
|
|
1645
|
+
ge: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: any) => MembersQueryBuilder;
|
|
1646
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1647
|
+
* @param value - Value to compare against.
|
|
1648
|
+
*/
|
|
1649
|
+
gt: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: any) => MembersQueryBuilder;
|
|
1650
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1651
|
+
* @param value - Value to compare against.
|
|
1652
|
+
*/
|
|
1653
|
+
le: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: any) => MembersQueryBuilder;
|
|
1654
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1655
|
+
* @param value - Value to compare against.
|
|
1656
|
+
*/
|
|
1657
|
+
lt: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: any) => MembersQueryBuilder;
|
|
1658
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
1659
|
+
* @param string - String to compare against. Case-insensitive.
|
|
1660
|
+
*/
|
|
1661
|
+
startsWith: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: string) => MembersQueryBuilder;
|
|
1662
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
1663
|
+
* @param values - List of values to compare against.
|
|
1664
|
+
*/
|
|
1665
|
+
hasSome: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any[]) => MembersQueryBuilder;
|
|
1666
|
+
in: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
1667
|
+
exists: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: boolean) => MembersQueryBuilder;
|
|
1668
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
1669
|
+
limit: (limit: number) => MembersQueryBuilder;
|
|
1670
|
+
/** @param skip - Number of items to skip in the query results before returning the results. */
|
|
1671
|
+
skip: (skip: number) => MembersQueryBuilder;
|
|
1672
|
+
find: () => Promise<MembersQueryResult>;
|
|
1673
|
+
}
|
|
1674
|
+
interface DeleteMyMemberOptions {
|
|
1675
|
+
/**
|
|
1676
|
+
* ID of a member receiving the deleted member's content.
|
|
1677
|
+
* @format GUID
|
|
1678
|
+
*/
|
|
1679
|
+
contentAssigneeId?: string | null;
|
|
1680
|
+
}
|
|
1681
|
+
interface BulkDeleteMembersByFilterOptions {
|
|
1682
|
+
/**
|
|
1683
|
+
* ID of a member receiving the deleted member's content.
|
|
1684
|
+
* @format GUID
|
|
1685
|
+
*/
|
|
1686
|
+
contentAssigneeId?: string | null;
|
|
1687
|
+
/** Plain text search. */
|
|
1688
|
+
search?: Search;
|
|
1689
|
+
}
|
|
1690
|
+
interface CreateMemberOptions {
|
|
1691
|
+
/** Member to create. */
|
|
1692
|
+
member?: Member;
|
|
1693
|
+
}
|
|
1694
|
+
interface UpdateMember {
|
|
1695
|
+
/**
|
|
1696
|
+
* Member ID.
|
|
1697
|
+
* @format GUID
|
|
1698
|
+
* @readonly
|
|
1699
|
+
*/
|
|
1700
|
+
_id?: string | null;
|
|
1701
|
+
/**
|
|
1702
|
+
* Email used by a member to log in to the site.
|
|
1703
|
+
* @format EMAIL
|
|
1704
|
+
*/
|
|
1705
|
+
loginEmail?: string | null;
|
|
1706
|
+
/**
|
|
1707
|
+
* Whether the email used by a member has been verified.
|
|
1708
|
+
* @readonly
|
|
1709
|
+
*/
|
|
1710
|
+
loginEmailVerified?: boolean | null;
|
|
1711
|
+
/**
|
|
1712
|
+
* Member site access status.
|
|
1713
|
+
* @readonly
|
|
1714
|
+
*/
|
|
1715
|
+
status?: StatusWithLiterals;
|
|
1716
|
+
/**
|
|
1717
|
+
* Contact ID.
|
|
1718
|
+
* @format GUID
|
|
1719
|
+
* @readonly
|
|
1720
|
+
*/
|
|
1721
|
+
contactId?: string | null;
|
|
1722
|
+
/**
|
|
1723
|
+
* Member's contact information. Contact information is stored in the
|
|
1724
|
+
* [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).
|
|
1725
|
+
*
|
|
1726
|
+
* The full set of contact data can be accessed and managed with the
|
|
1727
|
+
* 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)).
|
|
1728
|
+
*/
|
|
1729
|
+
contact?: Contact;
|
|
1730
|
+
/** Profile display details. */
|
|
1731
|
+
profile?: Profile;
|
|
1732
|
+
/** Member privacy status. */
|
|
1733
|
+
privacyStatus?: PrivacyStatusStatusWithLiterals;
|
|
1734
|
+
/**
|
|
1735
|
+
* Member activity status.
|
|
1736
|
+
* @readonly
|
|
1737
|
+
*/
|
|
1738
|
+
activityStatus?: ActivityStatusStatusWithLiterals;
|
|
1739
|
+
/**
|
|
1740
|
+
* Date and time when the member was created.
|
|
1741
|
+
* @readonly
|
|
1742
|
+
*/
|
|
1743
|
+
_createdDate?: Date | null;
|
|
1744
|
+
/**
|
|
1745
|
+
* Date and time when the member was updated.
|
|
1746
|
+
* @readonly
|
|
1747
|
+
*/
|
|
1748
|
+
_updatedDate?: Date | null;
|
|
1749
|
+
/**
|
|
1750
|
+
* Date and time when the member last logged in to the site.
|
|
1751
|
+
* @readonly
|
|
1752
|
+
*/
|
|
1753
|
+
lastLoginDate?: Date | null;
|
|
1754
|
+
}
|
|
1755
|
+
|
|
1756
|
+
export { type URI as $, type ApproveMemberResponse as A, type BlockMemberResponse as B, type CreateMemberOptions as C, type DisconnectMemberResponse as D, DeleteStatus as E, type Contact as F, type GetCurrentMemberOptions as G, type Address as H, type AddressStreetOneOf as I, type JoinCommunityResponse as J, type StreetAddress as K, type LeaveCommunityResponse as L, type Member as M, Namespace as N, type CustomField as O, PrivacyStatusStatus as P, type QueryMembersOptions as Q, type Profile as R, Status as S, type Image as T, type UpdateMySlugResponse as U, type ExtendedFields as V, WebhookIdentityType as W, type InvalidateCache as X, type InvalidateCacheGetByOneOf as Y, type App as Z, type Page as _, type UpdateMemberSlugResponse as a, type EntityCreatedEvent as a$, type File as a0, type CustomTag as a1, type UpdateMySlugRequest as a2, type SlugAlreadyExistsPayload as a3, type UpdateMemberSlugRequest as a4, type JoinCommunityRequest as a5, type MemberJoinedCommunity as a6, type LeaveCommunityRequest as a7, type MemberLeftCommunity as a8, type GetMyMemberRequest as a9, type DeleteMemberRequest as aA, type DeleteMemberResponse as aB, type ContentReassignmentRequested as aC, type ContentDeletionRequested as aD, type OwnerOrContributorDeleteForbiddenPayload as aE, type ActiveSubscriptionMemberDeleteForbiddenPayload as aF, type DeleteMyMemberRequest as aG, type DeleteMyMemberResponse as aH, type BulkDeleteMembersRequest as aI, type ItemMetadata as aJ, type ApplicationError as aK, type BulkMemberResult as aL, type BulkActionMetadata as aM, type BulkDeleteMembersByFilterRequest as aN, type BulkApproveMembersRequest as aO, type BulkBlockMembersRequest as aP, type CreateMemberRequest as aQ, type CreateMemberResponse as aR, type UpdateMemberRequest as aS, type UpdateMemberResponse as aT, type InvalidCustomFieldUrlPayload as aU, type DeleteMemberPhonesRequest as aV, type DeleteMemberEmailsRequest as aW, type DeleteMemberAddressesRequest as aX, type Empty as aY, type DomainEvent as aZ, type DomainEventBodyOneOf as a_, type GetMemberRequest as aa, type GetMemberResponse as ab, type MemberToMemberBlockedPayload as ac, type ListMembersRequest as ad, type Paging as ae, type Sorting as af, type CursorPaging as ag, type PagingMetadata as ah, type CursorPagingMetadata as ai, type Cursors as aj, type QueryMembersRequest as ak, type Query as al, type Search as am, type QueryMembersResponse as an, type MuteMemberRequest as ao, type MemberMuted as ap, type UnmuteMemberRequest as aq, type MemberUnmuted as ar, type ApproveMemberRequest as as, type MemberApproved as at, type BlockMemberRequest as au, type MemberBlocked as av, type MemberSelfBlockForbiddenPayload as aw, type OwnerMemberBlockForbiddenPayload as ax, type ActiveSubscriptionMemberBlockForbiddenPayload as ay, type DisconnectMemberRequest as az, type GetMyMemberResponse as b, type RestoreInfo as b0, type EntityUpdatedEvent as b1, type EntityDeletedEvent as b2, type ActionEvent as b3, type MetaSiteSpecialEvent as b4, type MetaSiteSpecialEventPayloadOneOf as b5, type Asset as b6, type SiteCreated as b7, type SiteTransferred as b8, type SiteDeleted as b9, type MembersQueryResult as bA, type DeleteContext as ba, type SiteUndeleted as bb, type SitePublished as bc, type SiteUnpublished as bd, type SiteMarkedAsTemplate as be, type SiteMarkedAsWixSite as bf, type ServiceProvisioned as bg, type ServiceRemoved as bh, type SiteRenamed as bi, type SiteHardDeleted as bj, type NamespaceChanged as bk, type StudioAssigned as bl, type StudioUnassigned as bm, type SiteUrlChanged as bn, type SitePurgedExternally as bo, type OdeditorAssigned as bp, type OdeditorUnassigned as bq, type PicassoAssigned as br, type PicassoUnassigned as bs, type MemberOwnershipTransferred as bt, type MemberIdChanged as bu, type MessageEnvelope as bv, type IdentificationData as bw, type IdentificationDataIdOneOf as bx, type BaseEventMetadata as by, type EventMetadata as bz, type GetMemberOptions as c, type ListMembersOptions as d, type ListMembersResponse as e, type MembersQueryBuilder as f, type MuteMemberResponse as g, type UnmuteMemberResponse as h, type DeleteMyMemberOptions as i, type BulkDeleteMembersResponse as j, type BulkDeleteMembersByFilterOptions as k, type BulkDeleteMembersByFilterResponse as l, type BulkApproveMembersResponse as m, type BulkBlockMembersResponse as n, type UpdateMember as o, type DeleteMemberPhonesResponse as p, type DeleteMemberEmailsResponse as q, type DeleteMemberAddressesResponse as r, type MemberCreatedEnvelope as s, type MemberDeletedEnvelope as t, type MemberUpdatedEnvelope as u, ActivityStatusStatus as v, Set as w, SortOrder as x, State as y, SiteCreatedContext as z };
|