@wix/auto_sdk_members_members 1.0.59 → 1.0.61
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-DiAMq6Kr.d.ts} +414 -182
- package/build/cjs/meta.d.ts +704 -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} +73 -34
- 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-DiAMq6Kr.d.mts} +414 -182
- package/build/es/meta.d.mts +704 -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-DiAMq6Kr.d.ts} +414 -182
- package/build/internal/cjs/meta.d.ts +704 -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} +73 -34
- 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-DiAMq6Kr.d.mts} +414 -182
- package/build/internal/es/meta.d.mts +704 -0
- package/build/internal/es/meta.mjs +1189 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +9 -8
- 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 -2539
- package/build/cjs/src/members-v1-member-members.universal.js +0 -1411
- 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 -2539
- package/build/es/src/members-v1-member-members.universal.js +0 -1361
- 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 -2539
- package/build/internal/cjs/src/members-v1-member-members.universal.js +0 -1411
- 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 -2539
- package/build/internal/es/src/members-v1-member-members.universal.js +0 -1361
- 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
|
|
@@ -198,19 +200,15 @@ export interface Profile {
|
|
|
198
200
|
* When left empty, the values default to `0`.
|
|
199
201
|
*/
|
|
200
202
|
cover?: Image;
|
|
201
|
-
/**
|
|
202
|
-
* Member title.
|
|
203
|
-
*
|
|
204
|
-
* Currently available through the API only.
|
|
205
|
-
*/
|
|
203
|
+
/** Member title. */
|
|
206
204
|
title?: string | null;
|
|
207
205
|
}
|
|
208
|
-
|
|
206
|
+
interface Image {
|
|
209
207
|
/**
|
|
210
208
|
* Wix Media image ID,
|
|
211
209
|
* set when the member selects an image from Wix Media.
|
|
212
210
|
*/
|
|
213
|
-
|
|
211
|
+
_id?: string;
|
|
214
212
|
/** Image URL. */
|
|
215
213
|
url?: string;
|
|
216
214
|
/** Original image width. */
|
|
@@ -230,7 +228,7 @@ export interface Image {
|
|
|
230
228
|
*/
|
|
231
229
|
offsetY?: number | null;
|
|
232
230
|
}
|
|
233
|
-
|
|
231
|
+
declare enum PrivacyStatusStatus {
|
|
234
232
|
/** Insufficient permissions to get the status. */
|
|
235
233
|
UNKNOWN = "UNKNOWN",
|
|
236
234
|
/** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
|
|
@@ -239,8 +237,8 @@ export declare enum PrivacyStatusStatus {
|
|
|
239
237
|
PUBLIC = "PUBLIC"
|
|
240
238
|
}
|
|
241
239
|
/** @enumType */
|
|
242
|
-
|
|
243
|
-
|
|
240
|
+
type PrivacyStatusStatusWithLiterals = PrivacyStatusStatus | 'UNKNOWN' | 'PRIVATE' | 'PUBLIC';
|
|
241
|
+
declare enum ActivityStatusStatus {
|
|
244
242
|
/** Insufficient permissions to get the status. */
|
|
245
243
|
UNKNOWN = "UNKNOWN",
|
|
246
244
|
/** Member can write forum posts and blog comments. */
|
|
@@ -249,8 +247,8 @@ export declare enum ActivityStatusStatus {
|
|
|
249
247
|
MUTED = "MUTED"
|
|
250
248
|
}
|
|
251
249
|
/** @enumType */
|
|
252
|
-
|
|
253
|
-
|
|
250
|
+
type ActivityStatusStatusWithLiterals = ActivityStatusStatus | 'UNKNOWN' | 'ACTIVE' | 'MUTED';
|
|
251
|
+
interface ExtendedFields {
|
|
254
252
|
/**
|
|
255
253
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
256
254
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -261,7 +259,7 @@ export interface ExtendedFields {
|
|
|
261
259
|
*/
|
|
262
260
|
namespaces?: Record<string, Record<string, any>>;
|
|
263
261
|
}
|
|
264
|
-
|
|
262
|
+
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
265
263
|
/**
|
|
266
264
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
267
265
|
* @format GUID
|
|
@@ -292,7 +290,7 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
292
290
|
hardPurge?: boolean;
|
|
293
291
|
}
|
|
294
292
|
/** @oneof */
|
|
295
|
-
|
|
293
|
+
interface InvalidateCacheGetByOneOf {
|
|
296
294
|
/**
|
|
297
295
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
298
296
|
* @format GUID
|
|
@@ -314,7 +312,7 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
314
312
|
/** 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
313
|
customTag?: CustomTag;
|
|
316
314
|
}
|
|
317
|
-
|
|
315
|
+
interface App {
|
|
318
316
|
/**
|
|
319
317
|
* The AppDefId
|
|
320
318
|
* @minLength 1
|
|
@@ -326,7 +324,7 @@ export interface App {
|
|
|
326
324
|
*/
|
|
327
325
|
instanceId?: string;
|
|
328
326
|
}
|
|
329
|
-
|
|
327
|
+
interface Page {
|
|
330
328
|
/**
|
|
331
329
|
* the msid the page is on
|
|
332
330
|
* @format GUID
|
|
@@ -338,7 +336,7 @@ export interface Page {
|
|
|
338
336
|
*/
|
|
339
337
|
pageId?: string;
|
|
340
338
|
}
|
|
341
|
-
|
|
339
|
+
interface URI {
|
|
342
340
|
/**
|
|
343
341
|
* the msid the URI is on
|
|
344
342
|
* @format GUID
|
|
@@ -350,7 +348,7 @@ export interface URI {
|
|
|
350
348
|
*/
|
|
351
349
|
uriPath?: string;
|
|
352
350
|
}
|
|
353
|
-
|
|
351
|
+
interface File {
|
|
354
352
|
/**
|
|
355
353
|
* the msid the file is related to
|
|
356
354
|
* @format GUID
|
|
@@ -363,7 +361,7 @@ export interface File {
|
|
|
363
361
|
*/
|
|
364
362
|
fileName?: string;
|
|
365
363
|
}
|
|
366
|
-
|
|
364
|
+
interface CustomTag {
|
|
367
365
|
/**
|
|
368
366
|
* the msid the tag is related to
|
|
369
367
|
* @format GUID
|
|
@@ -376,44 +374,44 @@ export interface CustomTag {
|
|
|
376
374
|
*/
|
|
377
375
|
tag?: string;
|
|
378
376
|
}
|
|
379
|
-
|
|
377
|
+
interface UpdateMySlugRequest {
|
|
380
378
|
/**
|
|
381
379
|
* New slug.
|
|
382
380
|
* @maxLength 255
|
|
383
381
|
*/
|
|
384
382
|
slug: string;
|
|
385
383
|
}
|
|
386
|
-
|
|
384
|
+
interface UpdateMySlugResponse {
|
|
387
385
|
/** Updated member. */
|
|
388
386
|
member?: Member;
|
|
389
387
|
}
|
|
390
|
-
|
|
388
|
+
interface SlugAlreadyExistsPayload {
|
|
391
389
|
slug?: string;
|
|
392
390
|
}
|
|
393
|
-
|
|
391
|
+
interface UpdateMemberSlugRequest {
|
|
394
392
|
/**
|
|
395
393
|
* Member ID.
|
|
396
394
|
* @format GUID
|
|
397
395
|
*/
|
|
398
|
-
|
|
396
|
+
_id: string;
|
|
399
397
|
/**
|
|
400
398
|
* New slug.
|
|
401
399
|
* @maxLength 255
|
|
402
400
|
*/
|
|
403
401
|
slug: string;
|
|
404
402
|
}
|
|
405
|
-
|
|
403
|
+
interface UpdateMemberSlugResponse {
|
|
406
404
|
/** Updated member. */
|
|
407
405
|
member?: Member;
|
|
408
406
|
}
|
|
409
|
-
|
|
407
|
+
interface JoinCommunityRequest {
|
|
410
408
|
}
|
|
411
409
|
/** Member profile. */
|
|
412
|
-
|
|
410
|
+
interface JoinCommunityResponse {
|
|
413
411
|
/** The updated member. */
|
|
414
412
|
member?: Member;
|
|
415
413
|
}
|
|
416
|
-
|
|
414
|
+
interface MemberJoinedCommunity {
|
|
417
415
|
/**
|
|
418
416
|
* ID of the member who joined the community.
|
|
419
417
|
* @format GUID
|
|
@@ -421,14 +419,14 @@ export interface MemberJoinedCommunity {
|
|
|
421
419
|
*/
|
|
422
420
|
memberId?: string;
|
|
423
421
|
}
|
|
424
|
-
|
|
422
|
+
interface LeaveCommunityRequest {
|
|
425
423
|
}
|
|
426
424
|
/** Member profile. */
|
|
427
|
-
|
|
425
|
+
interface LeaveCommunityResponse {
|
|
428
426
|
/** The updated member. */
|
|
429
427
|
member?: Member;
|
|
430
428
|
}
|
|
431
|
-
|
|
429
|
+
interface MemberLeftCommunity {
|
|
432
430
|
/**
|
|
433
431
|
* ID of the site member who left the community.
|
|
434
432
|
* @format GUID
|
|
@@ -436,7 +434,7 @@ export interface MemberLeftCommunity {
|
|
|
436
434
|
*/
|
|
437
435
|
memberId?: string;
|
|
438
436
|
}
|
|
439
|
-
|
|
437
|
+
interface GetMyMemberRequest {
|
|
440
438
|
/**
|
|
441
439
|
* Predefined set of fields to return.
|
|
442
440
|
*
|
|
@@ -445,7 +443,7 @@ export interface GetMyMemberRequest {
|
|
|
445
443
|
*/
|
|
446
444
|
fieldsets?: SetWithLiterals[];
|
|
447
445
|
}
|
|
448
|
-
|
|
446
|
+
declare enum Set {
|
|
449
447
|
/**
|
|
450
448
|
* Includes `id`, `contactId`, `createdDate`, `updatedDate` and the `profile` object.
|
|
451
449
|
* `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
|
|
@@ -457,18 +455,18 @@ export declare enum Set {
|
|
|
457
455
|
FULL = "FULL"
|
|
458
456
|
}
|
|
459
457
|
/** @enumType */
|
|
460
|
-
|
|
458
|
+
type SetWithLiterals = Set | 'PUBLIC' | 'EXTENDED' | 'FULL';
|
|
461
459
|
/** Member profile. */
|
|
462
|
-
|
|
460
|
+
interface GetMyMemberResponse {
|
|
463
461
|
/** The retrieved member. */
|
|
464
462
|
member?: Member;
|
|
465
463
|
}
|
|
466
|
-
|
|
464
|
+
interface GetMemberRequest {
|
|
467
465
|
/**
|
|
468
466
|
* Member ID.
|
|
469
467
|
* @format GUID
|
|
470
468
|
*/
|
|
471
|
-
|
|
469
|
+
_id: string;
|
|
472
470
|
/**
|
|
473
471
|
* Predefined set of fields to return.
|
|
474
472
|
*
|
|
@@ -477,18 +475,18 @@ export interface GetMemberRequest {
|
|
|
477
475
|
*/
|
|
478
476
|
fieldsets?: SetWithLiterals[];
|
|
479
477
|
}
|
|
480
|
-
|
|
478
|
+
interface GetMemberResponse {
|
|
481
479
|
/** The requested member. */
|
|
482
480
|
member?: Member;
|
|
483
481
|
}
|
|
484
|
-
|
|
482
|
+
interface MemberToMemberBlockedPayload {
|
|
485
483
|
/**
|
|
486
484
|
* Member ID.
|
|
487
485
|
* @format GUID
|
|
488
486
|
*/
|
|
489
487
|
memberId?: string;
|
|
490
488
|
}
|
|
491
|
-
|
|
489
|
+
interface ListMembersRequest {
|
|
492
490
|
paging?: Paging;
|
|
493
491
|
/**
|
|
494
492
|
* Predefined sets of fields to return.
|
|
@@ -499,13 +497,13 @@ export interface ListMembersRequest {
|
|
|
499
497
|
fieldsets?: SetWithLiterals[];
|
|
500
498
|
sorting?: Sorting[];
|
|
501
499
|
}
|
|
502
|
-
|
|
500
|
+
interface Paging {
|
|
503
501
|
/** Number of items to load. */
|
|
504
502
|
limit?: number | null;
|
|
505
503
|
/** Number of items to skip in the current sort order. */
|
|
506
504
|
offset?: number | null;
|
|
507
505
|
}
|
|
508
|
-
|
|
506
|
+
interface Sorting {
|
|
509
507
|
/**
|
|
510
508
|
* Name of the field to sort by.
|
|
511
509
|
* @maxLength 512
|
|
@@ -514,13 +512,13 @@ export interface Sorting {
|
|
|
514
512
|
/** Sort order. */
|
|
515
513
|
order?: SortOrderWithLiterals;
|
|
516
514
|
}
|
|
517
|
-
|
|
515
|
+
declare enum SortOrder {
|
|
518
516
|
ASC = "ASC",
|
|
519
517
|
DESC = "DESC"
|
|
520
518
|
}
|
|
521
519
|
/** @enumType */
|
|
522
|
-
|
|
523
|
-
|
|
520
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
521
|
+
interface CursorPaging {
|
|
524
522
|
/**
|
|
525
523
|
* Maximum number of items to return in the results.
|
|
526
524
|
* @max 100
|
|
@@ -535,13 +533,13 @@ export interface CursorPaging {
|
|
|
535
533
|
*/
|
|
536
534
|
cursor?: string | null;
|
|
537
535
|
}
|
|
538
|
-
|
|
536
|
+
interface ListMembersResponse {
|
|
539
537
|
/** List of members. */
|
|
540
538
|
members?: Member[];
|
|
541
539
|
/** Metadata for the paginated results. */
|
|
542
540
|
metadata?: PagingMetadata;
|
|
543
541
|
}
|
|
544
|
-
|
|
542
|
+
interface PagingMetadata {
|
|
545
543
|
/** Number of items returned in the response. */
|
|
546
544
|
count?: number | null;
|
|
547
545
|
/** Offset that was requested. */
|
|
@@ -551,7 +549,7 @@ export interface PagingMetadata {
|
|
|
551
549
|
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
552
550
|
tooManyToCount?: boolean | null;
|
|
553
551
|
}
|
|
554
|
-
|
|
552
|
+
interface CursorPagingMetadata {
|
|
555
553
|
/** Number of items returned in the response. */
|
|
556
554
|
count?: number | null;
|
|
557
555
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -564,7 +562,7 @@ export interface CursorPagingMetadata {
|
|
|
564
562
|
*/
|
|
565
563
|
hasNext?: boolean | null;
|
|
566
564
|
}
|
|
567
|
-
|
|
565
|
+
interface Cursors {
|
|
568
566
|
/**
|
|
569
567
|
* Cursor string pointing to the next page in the list of results.
|
|
570
568
|
* @maxLength 16000
|
|
@@ -576,7 +574,7 @@ export interface Cursors {
|
|
|
576
574
|
*/
|
|
577
575
|
prev?: string | null;
|
|
578
576
|
}
|
|
579
|
-
|
|
577
|
+
interface QueryMembersRequest {
|
|
580
578
|
/** Query options. */
|
|
581
579
|
query?: Query;
|
|
582
580
|
/**
|
|
@@ -589,7 +587,7 @@ export interface QueryMembersRequest {
|
|
|
589
587
|
/** Plain text search. */
|
|
590
588
|
search?: Search;
|
|
591
589
|
}
|
|
592
|
-
|
|
590
|
+
interface Query {
|
|
593
591
|
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
594
592
|
filter?: any;
|
|
595
593
|
/** Limit number of results */
|
|
@@ -598,7 +596,7 @@ export interface Query {
|
|
|
598
596
|
sorting?: Sorting[];
|
|
599
597
|
}
|
|
600
598
|
/** Free text to match in searchable fields */
|
|
601
|
-
|
|
599
|
+
interface Search {
|
|
602
600
|
/**
|
|
603
601
|
* Search term or expression.
|
|
604
602
|
* @minLength 1
|
|
@@ -620,24 +618,24 @@ export interface Search {
|
|
|
620
618
|
*/
|
|
621
619
|
fields?: string[];
|
|
622
620
|
}
|
|
623
|
-
|
|
621
|
+
interface QueryMembersResponse {
|
|
624
622
|
/** List of members that met the query filter criteria. */
|
|
625
623
|
members?: Member[];
|
|
626
624
|
/** Metadata for the paginated results. */
|
|
627
625
|
metadata?: PagingMetadata;
|
|
628
626
|
}
|
|
629
|
-
|
|
627
|
+
interface MuteMemberRequest {
|
|
630
628
|
/**
|
|
631
629
|
* ID of the member to mute.
|
|
632
630
|
* @format GUID
|
|
633
631
|
*/
|
|
634
|
-
|
|
632
|
+
_id: string;
|
|
635
633
|
}
|
|
636
|
-
|
|
634
|
+
interface MuteMemberResponse {
|
|
637
635
|
/** Muted member. */
|
|
638
636
|
member?: Member;
|
|
639
637
|
}
|
|
640
|
-
|
|
638
|
+
interface MemberMuted {
|
|
641
639
|
/**
|
|
642
640
|
* ID of the member who got muted.
|
|
643
641
|
* @format GUID
|
|
@@ -645,18 +643,18 @@ export interface MemberMuted {
|
|
|
645
643
|
*/
|
|
646
644
|
memberId?: string;
|
|
647
645
|
}
|
|
648
|
-
|
|
646
|
+
interface UnmuteMemberRequest {
|
|
649
647
|
/**
|
|
650
648
|
* ID of the member to unmute.
|
|
651
649
|
* @format GUID
|
|
652
650
|
*/
|
|
653
|
-
|
|
651
|
+
_id: string;
|
|
654
652
|
}
|
|
655
|
-
|
|
653
|
+
interface UnmuteMemberResponse {
|
|
656
654
|
/** Unmuted member. */
|
|
657
655
|
member?: Member;
|
|
658
656
|
}
|
|
659
|
-
|
|
657
|
+
interface MemberUnmuted {
|
|
660
658
|
/**
|
|
661
659
|
* ID of the member who got unmuted.
|
|
662
660
|
* @format GUID
|
|
@@ -664,18 +662,18 @@ export interface MemberUnmuted {
|
|
|
664
662
|
*/
|
|
665
663
|
memberId?: string;
|
|
666
664
|
}
|
|
667
|
-
|
|
665
|
+
interface ApproveMemberRequest {
|
|
668
666
|
/**
|
|
669
667
|
* ID of the member to approve.
|
|
670
668
|
* @format GUID
|
|
671
669
|
*/
|
|
672
|
-
|
|
670
|
+
_id: string;
|
|
673
671
|
}
|
|
674
|
-
|
|
672
|
+
interface ApproveMemberResponse {
|
|
675
673
|
/** Approved member. */
|
|
676
674
|
member?: Member;
|
|
677
675
|
}
|
|
678
|
-
|
|
676
|
+
interface MemberApproved {
|
|
679
677
|
/**
|
|
680
678
|
* ID of the member who got approved.
|
|
681
679
|
* @format GUID
|
|
@@ -683,18 +681,18 @@ export interface MemberApproved {
|
|
|
683
681
|
*/
|
|
684
682
|
memberId?: string;
|
|
685
683
|
}
|
|
686
|
-
|
|
684
|
+
interface BlockMemberRequest {
|
|
687
685
|
/**
|
|
688
686
|
* ID of a member to block.
|
|
689
687
|
* @format GUID
|
|
690
688
|
*/
|
|
691
|
-
|
|
689
|
+
_id: string;
|
|
692
690
|
}
|
|
693
|
-
|
|
691
|
+
interface BlockMemberResponse {
|
|
694
692
|
/** Blocked member. */
|
|
695
693
|
member?: Member;
|
|
696
694
|
}
|
|
697
|
-
|
|
695
|
+
interface MemberBlocked {
|
|
698
696
|
/**
|
|
699
697
|
* ID of the member who got blocked.
|
|
700
698
|
* @format GUID
|
|
@@ -702,78 +700,78 @@ export interface MemberBlocked {
|
|
|
702
700
|
*/
|
|
703
701
|
memberId?: string;
|
|
704
702
|
}
|
|
705
|
-
|
|
703
|
+
interface MemberSelfBlockForbiddenPayload {
|
|
706
704
|
/**
|
|
707
705
|
* Target's member ID.
|
|
708
706
|
* @format GUID
|
|
709
707
|
*/
|
|
710
708
|
memberId?: string;
|
|
711
709
|
}
|
|
712
|
-
|
|
710
|
+
interface OwnerMemberBlockForbiddenPayload {
|
|
713
711
|
/**
|
|
714
712
|
* Owner's member ID.
|
|
715
713
|
* @format GUID
|
|
716
714
|
*/
|
|
717
715
|
memberId?: string;
|
|
718
716
|
}
|
|
719
|
-
|
|
717
|
+
interface ActiveSubscriptionMemberBlockForbiddenPayload {
|
|
720
718
|
/**
|
|
721
719
|
* Active subscription member ID.
|
|
722
720
|
* @format GUID
|
|
723
721
|
*/
|
|
724
722
|
memberId?: string;
|
|
725
723
|
}
|
|
726
|
-
|
|
724
|
+
interface DisconnectMemberRequest {
|
|
727
725
|
/**
|
|
728
726
|
* ID of a member to disconnect.
|
|
729
727
|
* @format GUID
|
|
730
728
|
*/
|
|
731
|
-
|
|
729
|
+
_id: string;
|
|
732
730
|
}
|
|
733
|
-
|
|
731
|
+
interface DisconnectMemberResponse {
|
|
734
732
|
/** Disconnected member. */
|
|
735
733
|
member?: Member;
|
|
736
734
|
}
|
|
737
|
-
|
|
735
|
+
interface DeleteMemberRequest {
|
|
738
736
|
/**
|
|
739
737
|
* ID of a member to delete.
|
|
740
738
|
* @format GUID
|
|
741
739
|
*/
|
|
742
|
-
|
|
740
|
+
_id: string;
|
|
743
741
|
}
|
|
744
|
-
|
|
742
|
+
interface DeleteMemberResponse {
|
|
745
743
|
}
|
|
746
|
-
|
|
744
|
+
interface ContentReassignmentRequested {
|
|
747
745
|
fromMember?: Member;
|
|
748
746
|
toMember?: Member;
|
|
749
747
|
}
|
|
750
|
-
|
|
748
|
+
interface ContentDeletionRequested {
|
|
751
749
|
member?: Member;
|
|
752
750
|
}
|
|
753
|
-
|
|
751
|
+
interface OwnerOrContributorDeleteForbiddenPayload {
|
|
754
752
|
/**
|
|
755
753
|
* Owner's or contributor's member ID.
|
|
756
754
|
* @format GUID
|
|
757
755
|
*/
|
|
758
756
|
memberId?: string;
|
|
759
757
|
}
|
|
760
|
-
|
|
758
|
+
interface ActiveSubscriptionMemberDeleteForbiddenPayload {
|
|
761
759
|
/**
|
|
762
760
|
* Active subscription member ID.
|
|
763
761
|
* @format GUID
|
|
764
762
|
*/
|
|
765
763
|
memberId?: string;
|
|
766
764
|
}
|
|
767
|
-
|
|
765
|
+
interface DeleteMyMemberRequest {
|
|
768
766
|
/**
|
|
769
767
|
* ID of a member receiving the deleted member's content.
|
|
770
768
|
* @format GUID
|
|
771
769
|
*/
|
|
772
770
|
contentAssigneeId?: string | null;
|
|
773
771
|
}
|
|
774
|
-
|
|
772
|
+
interface DeleteMyMemberResponse {
|
|
775
773
|
}
|
|
776
|
-
|
|
774
|
+
interface BulkDeleteMembersRequest {
|
|
777
775
|
/**
|
|
778
776
|
* IDs of members to be deleted.
|
|
779
777
|
* @minSize 1
|
|
@@ -782,18 +780,18 @@ export interface BulkDeleteMembersRequest {
|
|
|
782
780
|
*/
|
|
783
781
|
memberIds: string[];
|
|
784
782
|
}
|
|
785
|
-
|
|
783
|
+
interface BulkDeleteMembersResponse {
|
|
786
784
|
/** Result. */
|
|
787
785
|
results?: BulkMemberResult[];
|
|
788
786
|
/** Bulk action result metadata. */
|
|
789
787
|
bulkActionMetadata?: BulkActionMetadata;
|
|
790
788
|
}
|
|
791
|
-
|
|
789
|
+
interface ItemMetadata {
|
|
792
790
|
/**
|
|
793
791
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
794
792
|
* @maxLength 255
|
|
795
793
|
*/
|
|
796
|
-
|
|
794
|
+
_id?: string | null;
|
|
797
795
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
798
796
|
originalIndex?: number;
|
|
799
797
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -801,7 +799,7 @@ export interface ItemMetadata {
|
|
|
801
799
|
/** Details about the error in case of failure. */
|
|
802
800
|
error?: ApplicationError;
|
|
803
801
|
}
|
|
804
|
-
|
|
802
|
+
interface ApplicationError {
|
|
805
803
|
/** Error code. */
|
|
806
804
|
code?: string;
|
|
807
805
|
/** Description of the error. */
|
|
@@ -809,10 +807,10 @@ export interface ApplicationError {
|
|
|
809
807
|
/** Data related to the error. */
|
|
810
808
|
data?: Record<string, any> | null;
|
|
811
809
|
}
|
|
812
|
-
|
|
810
|
+
interface BulkMemberResult {
|
|
813
811
|
itemMetadata?: ItemMetadata;
|
|
814
812
|
}
|
|
815
|
-
|
|
813
|
+
interface BulkActionMetadata {
|
|
816
814
|
/** Number of items that were successfully processed. */
|
|
817
815
|
totalSuccesses?: number;
|
|
818
816
|
/** Number of items that couldn't be processed. */
|
|
@@ -820,7 +818,7 @@ export interface BulkActionMetadata {
|
|
|
820
818
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
821
819
|
undetailedFailures?: number;
|
|
822
820
|
}
|
|
823
|
-
|
|
821
|
+
interface BulkDeleteMembersByFilterRequest {
|
|
824
822
|
/** 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
823
|
filter: any;
|
|
826
824
|
/**
|
|
@@ -831,97 +829,97 @@ export interface BulkDeleteMembersByFilterRequest {
|
|
|
831
829
|
/** Plain text search. */
|
|
832
830
|
search?: Search;
|
|
833
831
|
}
|
|
834
|
-
|
|
832
|
+
interface BulkDeleteMembersByFilterResponse {
|
|
835
833
|
/**
|
|
836
834
|
* Job ID.
|
|
837
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.
|
|
838
836
|
*/
|
|
839
837
|
jobId?: string;
|
|
840
838
|
}
|
|
841
|
-
|
|
839
|
+
interface BulkApproveMembersRequest {
|
|
842
840
|
/** 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
841
|
filter: any;
|
|
844
842
|
}
|
|
845
|
-
|
|
843
|
+
interface BulkApproveMembersResponse {
|
|
846
844
|
/**
|
|
847
845
|
* Job ID.
|
|
848
846
|
* 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
847
|
*/
|
|
850
848
|
jobId?: string;
|
|
851
849
|
}
|
|
852
|
-
|
|
850
|
+
interface BulkBlockMembersRequest {
|
|
853
851
|
/** 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
852
|
filter: any;
|
|
855
853
|
}
|
|
856
|
-
|
|
854
|
+
interface BulkBlockMembersResponse {
|
|
857
855
|
/**
|
|
858
856
|
* Job ID.
|
|
859
857
|
* 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
858
|
*/
|
|
861
859
|
jobId?: string;
|
|
862
860
|
}
|
|
863
|
-
|
|
861
|
+
interface CreateMemberRequest {
|
|
864
862
|
/** Member to create. */
|
|
865
863
|
member?: Member;
|
|
866
864
|
}
|
|
867
|
-
|
|
865
|
+
interface CreateMemberResponse {
|
|
868
866
|
/** New member. */
|
|
869
867
|
member?: Member;
|
|
870
868
|
}
|
|
871
|
-
|
|
869
|
+
interface UpdateMemberRequest {
|
|
872
870
|
/** Member info to update. */
|
|
873
871
|
member?: Member;
|
|
874
872
|
}
|
|
875
|
-
|
|
873
|
+
interface UpdateMemberResponse {
|
|
876
874
|
/** Updated member. */
|
|
877
875
|
member?: Member;
|
|
878
876
|
}
|
|
879
|
-
|
|
877
|
+
interface InvalidCustomFieldUrlPayload {
|
|
880
878
|
/** Custom field key and invalid URL. */
|
|
881
879
|
fields?: Record<string, string>;
|
|
882
880
|
}
|
|
883
|
-
|
|
881
|
+
interface DeleteMemberPhonesRequest {
|
|
884
882
|
/**
|
|
885
883
|
* ID of the member whose phone numbers will be deleted.
|
|
886
884
|
* @format GUID
|
|
887
885
|
*/
|
|
888
|
-
|
|
886
|
+
_id: string;
|
|
889
887
|
}
|
|
890
|
-
|
|
888
|
+
interface DeleteMemberPhonesResponse {
|
|
891
889
|
/** Updated member. */
|
|
892
890
|
member?: Member;
|
|
893
891
|
}
|
|
894
|
-
|
|
892
|
+
interface DeleteMemberEmailsRequest {
|
|
895
893
|
/**
|
|
896
894
|
* ID of the member whose email addresses will be deleted.
|
|
897
895
|
* @format GUID
|
|
898
896
|
*/
|
|
899
|
-
|
|
897
|
+
_id: string;
|
|
900
898
|
}
|
|
901
|
-
|
|
899
|
+
interface DeleteMemberEmailsResponse {
|
|
902
900
|
/** Updated member. */
|
|
903
901
|
member?: Member;
|
|
904
902
|
}
|
|
905
|
-
|
|
903
|
+
interface DeleteMemberAddressesRequest {
|
|
906
904
|
/**
|
|
907
905
|
* ID of the member whose street addresses will be deleted.
|
|
908
906
|
* @format GUID
|
|
909
907
|
*/
|
|
910
|
-
|
|
908
|
+
_id: string;
|
|
911
909
|
}
|
|
912
|
-
|
|
910
|
+
interface DeleteMemberAddressesResponse {
|
|
913
911
|
/** Updated member. */
|
|
914
912
|
member?: Member;
|
|
915
913
|
}
|
|
916
|
-
|
|
914
|
+
interface Empty {
|
|
917
915
|
}
|
|
918
|
-
|
|
916
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
919
917
|
createdEvent?: EntityCreatedEvent;
|
|
920
918
|
updatedEvent?: EntityUpdatedEvent;
|
|
921
919
|
deletedEvent?: EntityDeletedEvent;
|
|
922
920
|
actionEvent?: ActionEvent;
|
|
923
921
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
924
|
-
|
|
922
|
+
_id?: string;
|
|
925
923
|
/**
|
|
926
924
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
927
925
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -950,36 +948,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
950
948
|
entityEventSequence?: string | null;
|
|
951
949
|
}
|
|
952
950
|
/** @oneof */
|
|
953
|
-
|
|
951
|
+
interface DomainEventBodyOneOf {
|
|
954
952
|
createdEvent?: EntityCreatedEvent;
|
|
955
953
|
updatedEvent?: EntityUpdatedEvent;
|
|
956
954
|
deletedEvent?: EntityDeletedEvent;
|
|
957
955
|
actionEvent?: ActionEvent;
|
|
958
956
|
}
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
962
|
-
restoreInfo?: RestoreInfo;
|
|
957
|
+
interface EntityCreatedEvent {
|
|
958
|
+
entity?: string;
|
|
963
959
|
}
|
|
964
|
-
|
|
960
|
+
interface RestoreInfo {
|
|
965
961
|
deletedDate?: Date | null;
|
|
966
962
|
}
|
|
967
|
-
|
|
963
|
+
interface EntityUpdatedEvent {
|
|
968
964
|
/**
|
|
969
965
|
* 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
966
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
971
967
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
972
968
|
*/
|
|
973
|
-
|
|
969
|
+
currentEntity?: string;
|
|
974
970
|
}
|
|
975
|
-
|
|
971
|
+
interface EntityDeletedEvent {
|
|
976
972
|
/** Entity that was deleted. */
|
|
977
|
-
|
|
973
|
+
deletedEntity?: string | null;
|
|
978
974
|
}
|
|
979
|
-
|
|
980
|
-
|
|
975
|
+
interface ActionEvent {
|
|
976
|
+
body?: string;
|
|
981
977
|
}
|
|
982
|
-
|
|
978
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
983
979
|
/** Emitted on a meta site creation. */
|
|
984
980
|
siteCreated?: SiteCreated;
|
|
985
981
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -1045,7 +1041,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
1045
1041
|
assets?: Asset[];
|
|
1046
1042
|
}
|
|
1047
1043
|
/** @oneof */
|
|
1048
|
-
|
|
1044
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
1049
1045
|
/** Emitted on a meta site creation. */
|
|
1050
1046
|
siteCreated?: SiteCreated;
|
|
1051
1047
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -1095,7 +1091,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
1095
1091
|
/** Emitted when Picasso is detached. */
|
|
1096
1092
|
picassoUnassigned?: PicassoUnassigned;
|
|
1097
1093
|
}
|
|
1098
|
-
|
|
1094
|
+
interface Asset {
|
|
1099
1095
|
/**
|
|
1100
1096
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1101
1097
|
* @maxLength 36
|
|
@@ -1109,7 +1105,7 @@ export interface Asset {
|
|
|
1109
1105
|
/** An application state. */
|
|
1110
1106
|
state?: StateWithLiterals;
|
|
1111
1107
|
}
|
|
1112
|
-
|
|
1108
|
+
declare enum State {
|
|
1113
1109
|
UNKNOWN = "UNKNOWN",
|
|
1114
1110
|
ENABLED = "ENABLED",
|
|
1115
1111
|
DISABLED = "DISABLED",
|
|
@@ -1117,8 +1113,8 @@ export declare enum State {
|
|
|
1117
1113
|
DEMO = "DEMO"
|
|
1118
1114
|
}
|
|
1119
1115
|
/** @enumType */
|
|
1120
|
-
|
|
1121
|
-
|
|
1116
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
1117
|
+
interface SiteCreated {
|
|
1122
1118
|
/**
|
|
1123
1119
|
* A template identifier (empty if not created from a template).
|
|
1124
1120
|
* @maxLength 36
|
|
@@ -1147,7 +1143,7 @@ export interface SiteCreated {
|
|
|
1147
1143
|
/** A namespace. */
|
|
1148
1144
|
namespace?: NamespaceWithLiterals;
|
|
1149
1145
|
}
|
|
1150
|
-
|
|
1146
|
+
declare enum SiteCreatedContext {
|
|
1151
1147
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1152
1148
|
OTHER = "OTHER",
|
|
1153
1149
|
/** A meta site was created from template. */
|
|
@@ -1162,8 +1158,8 @@ export declare enum SiteCreatedContext {
|
|
|
1162
1158
|
FLASH = "FLASH"
|
|
1163
1159
|
}
|
|
1164
1160
|
/** @enumType */
|
|
1165
|
-
|
|
1166
|
-
|
|
1161
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
1162
|
+
declare enum Namespace {
|
|
1167
1163
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1168
1164
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1169
1165
|
WIX = "WIX",
|
|
@@ -1246,9 +1242,9 @@ export declare enum Namespace {
|
|
|
1246
1242
|
MIMIR = "MIMIR"
|
|
1247
1243
|
}
|
|
1248
1244
|
/** @enumType */
|
|
1249
|
-
|
|
1245
|
+
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
1246
|
/** Site transferred to another user. */
|
|
1251
|
-
|
|
1247
|
+
interface SiteTransferred {
|
|
1252
1248
|
/**
|
|
1253
1249
|
* A previous owner id (user that transfers meta site).
|
|
1254
1250
|
* @format GUID
|
|
@@ -1261,11 +1257,11 @@ export interface SiteTransferred {
|
|
|
1261
1257
|
newOwnerId?: string;
|
|
1262
1258
|
}
|
|
1263
1259
|
/** Soft deletion of the meta site. Could be restored. */
|
|
1264
|
-
|
|
1260
|
+
interface SiteDeleted {
|
|
1265
1261
|
/** A deletion context. */
|
|
1266
1262
|
deleteContext?: DeleteContext;
|
|
1267
1263
|
}
|
|
1268
|
-
|
|
1264
|
+
interface DeleteContext {
|
|
1269
1265
|
/** When the meta site was deleted. */
|
|
1270
1266
|
dateDeleted?: Date | null;
|
|
1271
1267
|
/** A status. */
|
|
@@ -1281,7 +1277,7 @@ export interface DeleteContext {
|
|
|
1281
1277
|
*/
|
|
1282
1278
|
initiatorId?: string | null;
|
|
1283
1279
|
}
|
|
1284
|
-
|
|
1280
|
+
declare enum DeleteStatus {
|
|
1285
1281
|
UNKNOWN = "UNKNOWN",
|
|
1286
1282
|
TRASH = "TRASH",
|
|
1287
1283
|
DELETED = "DELETED",
|
|
@@ -1289,14 +1285,14 @@ export declare enum DeleteStatus {
|
|
|
1289
1285
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1290
1286
|
}
|
|
1291
1287
|
/** @enumType */
|
|
1292
|
-
|
|
1288
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
1293
1289
|
/** Restoration of the meta site. */
|
|
1294
|
-
|
|
1290
|
+
interface SiteUndeleted {
|
|
1295
1291
|
}
|
|
1296
1292
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1297
|
-
|
|
1293
|
+
interface SitePublished {
|
|
1298
1294
|
}
|
|
1299
|
-
|
|
1295
|
+
interface SiteUnpublished {
|
|
1300
1296
|
/**
|
|
1301
1297
|
* A list of URLs previously associated with the meta site.
|
|
1302
1298
|
* @maxLength 4000
|
|
@@ -1304,9 +1300,9 @@ export interface SiteUnpublished {
|
|
|
1304
1300
|
*/
|
|
1305
1301
|
urls?: string[];
|
|
1306
1302
|
}
|
|
1307
|
-
|
|
1303
|
+
interface SiteMarkedAsTemplate {
|
|
1308
1304
|
}
|
|
1309
|
-
|
|
1305
|
+
interface SiteMarkedAsWixSite {
|
|
1310
1306
|
}
|
|
1311
1307
|
/**
|
|
1312
1308
|
* Represents a service provisioned a site.
|
|
@@ -1323,7 +1319,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
1323
1319
|
* changes made to the original template afterward.
|
|
1324
1320
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1325
1321
|
*/
|
|
1326
|
-
|
|
1322
|
+
interface ServiceProvisioned {
|
|
1327
1323
|
/**
|
|
1328
1324
|
* Either UUID or EmbeddedServiceType.
|
|
1329
1325
|
* @maxLength 36
|
|
@@ -1350,7 +1346,7 @@ export interface ServiceProvisioned {
|
|
|
1350
1346
|
*/
|
|
1351
1347
|
originMetaSiteId?: string | null;
|
|
1352
1348
|
}
|
|
1353
|
-
|
|
1349
|
+
interface ServiceRemoved {
|
|
1354
1350
|
/**
|
|
1355
1351
|
* Either UUID or EmbeddedServiceType.
|
|
1356
1352
|
* @maxLength 36
|
|
@@ -1368,7 +1364,7 @@ export interface ServiceRemoved {
|
|
|
1368
1364
|
version?: string | null;
|
|
1369
1365
|
}
|
|
1370
1366
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1371
|
-
|
|
1367
|
+
interface SiteRenamed {
|
|
1372
1368
|
/**
|
|
1373
1369
|
* A new meta site name (URL slug).
|
|
1374
1370
|
* @maxLength 20
|
|
@@ -1385,21 +1381,21 @@ export interface SiteRenamed {
|
|
|
1385
1381
|
*
|
|
1386
1382
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1387
1383
|
*/
|
|
1388
|
-
|
|
1384
|
+
interface SiteHardDeleted {
|
|
1389
1385
|
/** A deletion context. */
|
|
1390
1386
|
deleteContext?: DeleteContext;
|
|
1391
1387
|
}
|
|
1392
|
-
|
|
1388
|
+
interface NamespaceChanged {
|
|
1393
1389
|
/** A previous namespace. */
|
|
1394
1390
|
oldNamespace?: NamespaceWithLiterals;
|
|
1395
1391
|
/** A new namespace. */
|
|
1396
1392
|
newNamespace?: NamespaceWithLiterals;
|
|
1397
1393
|
}
|
|
1398
1394
|
/** Assigned Studio editor */
|
|
1399
|
-
|
|
1395
|
+
interface StudioAssigned {
|
|
1400
1396
|
}
|
|
1401
1397
|
/** Unassigned Studio editor */
|
|
1402
|
-
|
|
1398
|
+
interface StudioUnassigned {
|
|
1403
1399
|
}
|
|
1404
1400
|
/**
|
|
1405
1401
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -1409,13 +1405,13 @@ export interface StudioUnassigned {
|
|
|
1409
1405
|
*
|
|
1410
1406
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1411
1407
|
*/
|
|
1412
|
-
|
|
1408
|
+
interface SiteUrlChanged {
|
|
1413
1409
|
}
|
|
1414
1410
|
/**
|
|
1415
1411
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1416
1412
|
* Consumed by other teams to remove relevant data.
|
|
1417
1413
|
*/
|
|
1418
|
-
|
|
1414
|
+
interface SitePurgedExternally {
|
|
1419
1415
|
/**
|
|
1420
1416
|
* @maxLength 2048
|
|
1421
1417
|
* @maxSize 100
|
|
@@ -1425,28 +1421,28 @@ export interface SitePurgedExternally {
|
|
|
1425
1421
|
appDefId?: string[];
|
|
1426
1422
|
}
|
|
1427
1423
|
/** Assigned Odeditor */
|
|
1428
|
-
|
|
1424
|
+
interface OdeditorAssigned {
|
|
1429
1425
|
}
|
|
1430
1426
|
/** Unassigned Odeditor */
|
|
1431
|
-
|
|
1427
|
+
interface OdeditorUnassigned {
|
|
1432
1428
|
}
|
|
1433
1429
|
/** Assigned Picasso editor */
|
|
1434
|
-
|
|
1430
|
+
interface PicassoAssigned {
|
|
1435
1431
|
}
|
|
1436
1432
|
/** Unassigned Picasso */
|
|
1437
|
-
|
|
1433
|
+
interface PicassoUnassigned {
|
|
1438
1434
|
}
|
|
1439
|
-
|
|
1435
|
+
interface MemberOwnershipTransferred {
|
|
1440
1436
|
fromMember?: Member;
|
|
1441
1437
|
toMember?: Member;
|
|
1442
1438
|
}
|
|
1443
|
-
|
|
1439
|
+
interface MemberIdChanged {
|
|
1444
1440
|
/** @format GUID */
|
|
1445
1441
|
fromId?: string;
|
|
1446
1442
|
/** @format GUID */
|
|
1447
1443
|
toId?: string;
|
|
1448
1444
|
}
|
|
1449
|
-
|
|
1445
|
+
interface MessageEnvelope {
|
|
1450
1446
|
/**
|
|
1451
1447
|
* App instance ID.
|
|
1452
1448
|
* @format GUID
|
|
@@ -1462,7 +1458,7 @@ export interface MessageEnvelope {
|
|
|
1462
1458
|
/** Stringify payload. */
|
|
1463
1459
|
data?: string;
|
|
1464
1460
|
}
|
|
1465
|
-
|
|
1461
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1466
1462
|
/**
|
|
1467
1463
|
* ID of a site visitor that has not logged in to the site.
|
|
1468
1464
|
* @format GUID
|
|
@@ -1487,7 +1483,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1487
1483
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1488
1484
|
}
|
|
1489
1485
|
/** @oneof */
|
|
1490
|
-
|
|
1486
|
+
interface IdentificationDataIdOneOf {
|
|
1491
1487
|
/**
|
|
1492
1488
|
* ID of a site visitor that has not logged in to the site.
|
|
1493
1489
|
* @format GUID
|
|
@@ -1509,7 +1505,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1509
1505
|
*/
|
|
1510
1506
|
appId?: string;
|
|
1511
1507
|
}
|
|
1512
|
-
|
|
1508
|
+
declare enum WebhookIdentityType {
|
|
1513
1509
|
UNKNOWN = "UNKNOWN",
|
|
1514
1510
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1515
1511
|
MEMBER = "MEMBER",
|
|
@@ -1517,4 +1513,240 @@ export declare enum WebhookIdentityType {
|
|
|
1517
1513
|
APP = "APP"
|
|
1518
1514
|
}
|
|
1519
1515
|
/** @enumType */
|
|
1520
|
-
|
|
1516
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1517
|
+
interface BaseEventMetadata {
|
|
1518
|
+
/**
|
|
1519
|
+
* App instance ID.
|
|
1520
|
+
* @format GUID
|
|
1521
|
+
*/
|
|
1522
|
+
instanceId?: string | null;
|
|
1523
|
+
/**
|
|
1524
|
+
* Event type.
|
|
1525
|
+
* @maxLength 150
|
|
1526
|
+
*/
|
|
1527
|
+
eventType?: string;
|
|
1528
|
+
/** The identification type and identity data. */
|
|
1529
|
+
identity?: IdentificationData;
|
|
1530
|
+
}
|
|
1531
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1532
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1533
|
+
_id?: string;
|
|
1534
|
+
/**
|
|
1535
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1536
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1537
|
+
*/
|
|
1538
|
+
entityFqdn?: string;
|
|
1539
|
+
/**
|
|
1540
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1541
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1542
|
+
*/
|
|
1543
|
+
slug?: string;
|
|
1544
|
+
/** ID of the entity associated with the event. */
|
|
1545
|
+
entityId?: string;
|
|
1546
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1547
|
+
eventTime?: Date | null;
|
|
1548
|
+
/**
|
|
1549
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1550
|
+
* (for example, GDPR).
|
|
1551
|
+
*/
|
|
1552
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1553
|
+
/** If present, indicates the action that triggered the event. */
|
|
1554
|
+
originatedFrom?: string | null;
|
|
1555
|
+
/**
|
|
1556
|
+
* 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.
|
|
1557
|
+
* 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.
|
|
1558
|
+
*/
|
|
1559
|
+
entityEventSequence?: string | null;
|
|
1560
|
+
}
|
|
1561
|
+
interface MemberCreatedEnvelope {
|
|
1562
|
+
entity: Member;
|
|
1563
|
+
metadata: EventMetadata;
|
|
1564
|
+
}
|
|
1565
|
+
interface MemberDeletedEnvelope {
|
|
1566
|
+
metadata: EventMetadata;
|
|
1567
|
+
}
|
|
1568
|
+
interface MemberUpdatedEnvelope {
|
|
1569
|
+
entity: Member;
|
|
1570
|
+
metadata: EventMetadata;
|
|
1571
|
+
}
|
|
1572
|
+
interface GetCurrentMemberOptions {
|
|
1573
|
+
/**
|
|
1574
|
+
* Predefined set of fields to return.
|
|
1575
|
+
*
|
|
1576
|
+
* Default: `"PUBLIC"`.
|
|
1577
|
+
* @maxSize 3
|
|
1578
|
+
*/
|
|
1579
|
+
fieldsets?: SetWithLiterals[];
|
|
1580
|
+
}
|
|
1581
|
+
interface GetMemberOptions {
|
|
1582
|
+
/**
|
|
1583
|
+
* Predefined set of fields to return.
|
|
1584
|
+
*
|
|
1585
|
+
* Defaults to `"PUBLIC"`.
|
|
1586
|
+
* @maxSize 3
|
|
1587
|
+
*/
|
|
1588
|
+
fieldsets?: SetWithLiterals[];
|
|
1589
|
+
}
|
|
1590
|
+
interface ListMembersOptions {
|
|
1591
|
+
/** Paging options. */
|
|
1592
|
+
paging?: Paging;
|
|
1593
|
+
/**
|
|
1594
|
+
* Predefined sets of fields to return.
|
|
1595
|
+
*
|
|
1596
|
+
* Default: `"PUBLIC"`.
|
|
1597
|
+
* @maxSize 3
|
|
1598
|
+
*/
|
|
1599
|
+
fieldsets?: SetWithLiterals[];
|
|
1600
|
+
/** Sorting options. */
|
|
1601
|
+
sorting?: Sorting[];
|
|
1602
|
+
}
|
|
1603
|
+
interface QueryMembersOptions {
|
|
1604
|
+
/**
|
|
1605
|
+
* Predefined sets of fields to return.
|
|
1606
|
+
*
|
|
1607
|
+
* Default: `"PUBLIC"`.
|
|
1608
|
+
* @maxSize 3
|
|
1609
|
+
*/
|
|
1610
|
+
fieldsets?: SetWithLiterals[] | undefined;
|
|
1611
|
+
/** Plain text search. */
|
|
1612
|
+
search?: Search | undefined;
|
|
1613
|
+
}
|
|
1614
|
+
interface QueryOffsetResult {
|
|
1615
|
+
currentPage: number | undefined;
|
|
1616
|
+
totalPages: number | undefined;
|
|
1617
|
+
totalCount: number | undefined;
|
|
1618
|
+
hasNext: () => boolean;
|
|
1619
|
+
hasPrev: () => boolean;
|
|
1620
|
+
length: number;
|
|
1621
|
+
pageSize: number;
|
|
1622
|
+
}
|
|
1623
|
+
interface MembersQueryResult extends QueryOffsetResult {
|
|
1624
|
+
items: Member[];
|
|
1625
|
+
query: MembersQueryBuilder;
|
|
1626
|
+
next: () => Promise<MembersQueryResult>;
|
|
1627
|
+
prev: () => Promise<MembersQueryResult>;
|
|
1628
|
+
}
|
|
1629
|
+
interface MembersQueryBuilder {
|
|
1630
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1631
|
+
* @param value - Value to compare against.
|
|
1632
|
+
*/
|
|
1633
|
+
eq: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
1634
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1635
|
+
* @param value - Value to compare against.
|
|
1636
|
+
*/
|
|
1637
|
+
ne: (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
|
+
ge: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: any) => MembersQueryBuilder;
|
|
1642
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1643
|
+
* @param value - Value to compare against.
|
|
1644
|
+
*/
|
|
1645
|
+
gt: (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
|
+
le: (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
|
+
lt: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: any) => MembersQueryBuilder;
|
|
1654
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
1655
|
+
* @param string - String to compare against. Case-insensitive.
|
|
1656
|
+
*/
|
|
1657
|
+
startsWith: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: string) => MembersQueryBuilder;
|
|
1658
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
1659
|
+
* @param values - List of values to compare against.
|
|
1660
|
+
*/
|
|
1661
|
+
hasSome: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any[]) => MembersQueryBuilder;
|
|
1662
|
+
in: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
1663
|
+
exists: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: boolean) => MembersQueryBuilder;
|
|
1664
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
1665
|
+
limit: (limit: number) => MembersQueryBuilder;
|
|
1666
|
+
/** @param skip - Number of items to skip in the query results before returning the results. */
|
|
1667
|
+
skip: (skip: number) => MembersQueryBuilder;
|
|
1668
|
+
find: () => Promise<MembersQueryResult>;
|
|
1669
|
+
}
|
|
1670
|
+
interface DeleteMyMemberOptions {
|
|
1671
|
+
/**
|
|
1672
|
+
* ID of a member receiving the deleted member's content.
|
|
1673
|
+
* @format GUID
|
|
1674
|
+
*/
|
|
1675
|
+
contentAssigneeId?: string | null;
|
|
1676
|
+
}
|
|
1677
|
+
interface BulkDeleteMembersByFilterOptions {
|
|
1678
|
+
/**
|
|
1679
|
+
* ID of a member receiving the deleted member's content.
|
|
1680
|
+
* @format GUID
|
|
1681
|
+
*/
|
|
1682
|
+
contentAssigneeId?: string | null;
|
|
1683
|
+
/** Plain text search. */
|
|
1684
|
+
search?: Search;
|
|
1685
|
+
}
|
|
1686
|
+
interface CreateMemberOptions {
|
|
1687
|
+
/** Member to create. */
|
|
1688
|
+
member?: Member;
|
|
1689
|
+
}
|
|
1690
|
+
interface UpdateMember {
|
|
1691
|
+
/**
|
|
1692
|
+
* Member ID.
|
|
1693
|
+
* @format GUID
|
|
1694
|
+
* @readonly
|
|
1695
|
+
*/
|
|
1696
|
+
_id?: string | null;
|
|
1697
|
+
/**
|
|
1698
|
+
* Email used by a member to log in to the site.
|
|
1699
|
+
* @format EMAIL
|
|
1700
|
+
*/
|
|
1701
|
+
loginEmail?: string | null;
|
|
1702
|
+
/**
|
|
1703
|
+
* Whether the email used by a member has been verified.
|
|
1704
|
+
* @readonly
|
|
1705
|
+
*/
|
|
1706
|
+
loginEmailVerified?: boolean | null;
|
|
1707
|
+
/**
|
|
1708
|
+
* Member site access status.
|
|
1709
|
+
* @readonly
|
|
1710
|
+
*/
|
|
1711
|
+
status?: StatusWithLiterals;
|
|
1712
|
+
/**
|
|
1713
|
+
* Contact ID.
|
|
1714
|
+
* @format GUID
|
|
1715
|
+
* @readonly
|
|
1716
|
+
*/
|
|
1717
|
+
contactId?: string | null;
|
|
1718
|
+
/**
|
|
1719
|
+
* Member's contact information. Contact information is stored in the
|
|
1720
|
+
* [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).
|
|
1721
|
+
*
|
|
1722
|
+
* The full set of contact data can be accessed and managed with the
|
|
1723
|
+
* 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)).
|
|
1724
|
+
*/
|
|
1725
|
+
contact?: Contact;
|
|
1726
|
+
/** Profile display details. */
|
|
1727
|
+
profile?: Profile;
|
|
1728
|
+
/** Member privacy status. */
|
|
1729
|
+
privacyStatus?: PrivacyStatusStatusWithLiterals;
|
|
1730
|
+
/**
|
|
1731
|
+
* Member activity status.
|
|
1732
|
+
* @readonly
|
|
1733
|
+
*/
|
|
1734
|
+
activityStatus?: ActivityStatusStatusWithLiterals;
|
|
1735
|
+
/**
|
|
1736
|
+
* Date and time when the member was created.
|
|
1737
|
+
* @readonly
|
|
1738
|
+
*/
|
|
1739
|
+
_createdDate?: Date | null;
|
|
1740
|
+
/**
|
|
1741
|
+
* Date and time when the member was updated.
|
|
1742
|
+
* @readonly
|
|
1743
|
+
*/
|
|
1744
|
+
_updatedDate?: Date | null;
|
|
1745
|
+
/**
|
|
1746
|
+
* Date and time when the member last logged in to the site.
|
|
1747
|
+
* @readonly
|
|
1748
|
+
*/
|
|
1749
|
+
lastLoginDate?: Date | null;
|
|
1750
|
+
}
|
|
1751
|
+
|
|
1752
|
+
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 };
|