@wix/auto_sdk_members_members 1.0.55 → 1.0.57
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 +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/members-v1-member-members.context.d.ts +46 -0
- package/build/cjs/src/members-v1-member-members.context.js +59 -0
- package/build/cjs/src/members-v1-member-members.context.js.map +1 -0
- package/build/cjs/src/members-v1-member-members.http.d.ts +229 -0
- package/build/cjs/src/members-v1-member-members.http.js +959 -0
- package/build/cjs/src/members-v1-member-members.http.js.map +1 -0
- package/build/cjs/src/members-v1-member-members.meta.d.ts +60 -0
- package/build/cjs/src/members-v1-member-members.meta.js +484 -0
- package/build/cjs/src/members-v1-member-members.meta.js.map +1 -0
- package/build/{index.d.ts → cjs/src/members-v1-member-members.public.d.ts} +33 -70
- package/build/cjs/src/members-v1-member-members.public.js +198 -0
- package/build/cjs/src/members-v1-member-members.public.js.map +1 -0
- package/build/{internal/members-v1-member-members.universal-CzPn3y3P.d.mts → cjs/src/members-v1-member-members.types.d.ts} +216 -407
- package/build/cjs/src/members-v1-member-members.types.js +174 -0
- package/build/cjs/src/members-v1-member-members.types.js.map +1 -0
- package/build/cjs/src/members-v1-member-members.universal.d.ts +2473 -0
- package/build/cjs/src/members-v1-member-members.universal.js +1387 -0
- package/build/cjs/src/members-v1-member-members.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/members-v1-member-members.context.d.ts +46 -0
- package/build/es/src/members-v1-member-members.context.js +46 -0
- package/build/es/src/members-v1-member-members.context.js.map +1 -0
- package/build/es/src/members-v1-member-members.http.d.ts +229 -0
- package/build/es/src/members-v1-member-members.http.js +932 -0
- package/build/es/src/members-v1-member-members.http.js.map +1 -0
- package/build/es/src/members-v1-member-members.meta.d.ts +60 -0
- package/build/es/src/members-v1-member-members.meta.js +434 -0
- package/build/es/src/members-v1-member-members.meta.js.map +1 -0
- package/build/{internal/index.d.ts → es/src/members-v1-member-members.public.d.ts} +33 -70
- package/build/es/src/members-v1-member-members.public.js +161 -0
- package/build/es/src/members-v1-member-members.public.js.map +1 -0
- package/build/{internal/members-v1-member-members.universal-CzPn3y3P.d.ts → es/src/members-v1-member-members.types.d.ts} +216 -407
- package/build/es/src/members-v1-member-members.types.js +171 -0
- package/build/es/src/members-v1-member-members.types.js.map +1 -0
- package/build/es/src/members-v1-member-members.universal.d.ts +2473 -0
- package/build/es/src/members-v1-member-members.universal.js +1337 -0
- package/build/es/src/members-v1-member-members.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/members-v1-member-members.context.d.ts +46 -0
- package/build/internal/cjs/src/members-v1-member-members.context.js +59 -0
- package/build/internal/cjs/src/members-v1-member-members.context.js.map +1 -0
- package/build/internal/cjs/src/members-v1-member-members.http.d.ts +229 -0
- package/build/internal/cjs/src/members-v1-member-members.http.js +959 -0
- package/build/internal/cjs/src/members-v1-member-members.http.js.map +1 -0
- package/build/internal/cjs/src/members-v1-member-members.meta.d.ts +60 -0
- package/build/internal/cjs/src/members-v1-member-members.meta.js +484 -0
- package/build/internal/cjs/src/members-v1-member-members.meta.js.map +1 -0
- package/build/{index.d.mts → internal/cjs/src/members-v1-member-members.public.d.ts} +33 -70
- package/build/internal/cjs/src/members-v1-member-members.public.js +198 -0
- package/build/internal/cjs/src/members-v1-member-members.public.js.map +1 -0
- package/build/{members-v1-member-members.universal-CzPn3y3P.d.mts → internal/cjs/src/members-v1-member-members.types.d.ts} +216 -407
- package/build/internal/cjs/src/members-v1-member-members.types.js +174 -0
- package/build/internal/cjs/src/members-v1-member-members.types.js.map +1 -0
- package/build/internal/cjs/src/members-v1-member-members.universal.d.ts +2473 -0
- package/build/internal/cjs/src/members-v1-member-members.universal.js +1387 -0
- package/build/internal/cjs/src/members-v1-member-members.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/members-v1-member-members.context.d.ts +46 -0
- package/build/internal/es/src/members-v1-member-members.context.js +46 -0
- package/build/internal/es/src/members-v1-member-members.context.js.map +1 -0
- package/build/internal/es/src/members-v1-member-members.http.d.ts +229 -0
- package/build/internal/es/src/members-v1-member-members.http.js +932 -0
- package/build/internal/es/src/members-v1-member-members.http.js.map +1 -0
- package/build/internal/es/src/members-v1-member-members.meta.d.ts +60 -0
- package/build/internal/es/src/members-v1-member-members.meta.js +434 -0
- package/build/internal/es/src/members-v1-member-members.meta.js.map +1 -0
- package/build/internal/{index.d.mts → es/src/members-v1-member-members.public.d.ts} +33 -70
- package/build/internal/es/src/members-v1-member-members.public.js +161 -0
- package/build/internal/es/src/members-v1-member-members.public.js.map +1 -0
- package/build/{members-v1-member-members.universal-CzPn3y3P.d.ts → internal/es/src/members-v1-member-members.types.d.ts} +216 -407
- package/build/internal/es/src/members-v1-member-members.types.js +171 -0
- package/build/internal/es/src/members-v1-member-members.types.js.map +1 -0
- package/build/internal/es/src/members-v1-member-members.universal.d.ts +2473 -0
- package/build/internal/es/src/members-v1-member-members.universal.js +1337 -0
- package/build/internal/es/src/members-v1-member-members.universal.js.map +1 -0
- package/package.json +13 -14
- package/build/index.js +0 -1800
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -1740
- package/build/index.mjs.map +0 -1
- package/build/internal/index.js +0 -1800
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -1740
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -698
- package/build/internal/meta.d.ts +0 -698
- package/build/internal/meta.js +0 -1239
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -1189
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -698
- package/build/meta.d.ts +0 -698
- package/build/meta.js +0 -1239
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -1189
- package/build/meta.mjs.map +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
interface Member {
|
|
1
|
+
export 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 @@ 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
|
-
declare enum Status {
|
|
62
|
+
export 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,7 +72,7 @@ declare enum Status {
|
|
|
72
72
|
OFFLINE = "OFFLINE"
|
|
73
73
|
}
|
|
74
74
|
/** Contact info associated with the member. */
|
|
75
|
-
interface Contact {
|
|
75
|
+
export interface Contact {
|
|
76
76
|
/** Contact's first name. */
|
|
77
77
|
firstName?: string | null;
|
|
78
78
|
/** Contact's last name. */
|
|
@@ -104,16 +104,14 @@ interface Contact {
|
|
|
104
104
|
*/
|
|
105
105
|
jobTitle?: string | null;
|
|
106
106
|
/**
|
|
107
|
-
* Custom fields
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
* > - Only custom fields added to the member profile in the dashboard are available through the Members API. Empty fields are not returned.
|
|
111
|
-
* > - When updating a member, `name` is ignored.
|
|
107
|
+
* Custom fields,
|
|
108
|
+
* where each key is the field key,
|
|
109
|
+
* and each value is the field's value for the member.
|
|
112
110
|
*/
|
|
113
111
|
customFields?: Record<string, CustomField>;
|
|
114
112
|
}
|
|
115
113
|
/** Street address. */
|
|
116
|
-
interface Address extends AddressStreetOneOf {
|
|
114
|
+
export interface Address extends AddressStreetOneOf {
|
|
117
115
|
/** Street address object, with number and name in separate fields. */
|
|
118
116
|
streetAddress?: StreetAddress;
|
|
119
117
|
/**
|
|
@@ -126,7 +124,7 @@ interface Address extends AddressStreetOneOf {
|
|
|
126
124
|
* @format GUID
|
|
127
125
|
* @readonly
|
|
128
126
|
*/
|
|
129
|
-
|
|
127
|
+
id?: string | null;
|
|
130
128
|
/**
|
|
131
129
|
* Free text providing more detailed address information,
|
|
132
130
|
* such as apartment, suite, or floor.
|
|
@@ -148,7 +146,7 @@ interface Address extends AddressStreetOneOf {
|
|
|
148
146
|
postalCode?: string | null;
|
|
149
147
|
}
|
|
150
148
|
/** @oneof */
|
|
151
|
-
interface AddressStreetOneOf {
|
|
149
|
+
export interface AddressStreetOneOf {
|
|
152
150
|
/** Street address object, with number and name in separate fields. */
|
|
153
151
|
streetAddress?: StreetAddress;
|
|
154
152
|
/**
|
|
@@ -157,7 +155,7 @@ interface AddressStreetOneOf {
|
|
|
157
155
|
*/
|
|
158
156
|
addressLine?: string | null;
|
|
159
157
|
}
|
|
160
|
-
interface StreetAddress {
|
|
158
|
+
export interface StreetAddress {
|
|
161
159
|
/**
|
|
162
160
|
* Street number.
|
|
163
161
|
* @maxLength 100
|
|
@@ -169,14 +167,14 @@ interface StreetAddress {
|
|
|
169
167
|
*/
|
|
170
168
|
name?: string;
|
|
171
169
|
}
|
|
172
|
-
interface CustomField {
|
|
170
|
+
export interface CustomField {
|
|
173
171
|
/** Custom field name. */
|
|
174
172
|
name?: string | null;
|
|
175
173
|
/** Custom field value. */
|
|
176
174
|
value?: any;
|
|
177
175
|
}
|
|
178
176
|
/** Member Profile */
|
|
179
|
-
interface Profile {
|
|
177
|
+
export interface Profile {
|
|
180
178
|
/**
|
|
181
179
|
* Name that identifies the member to other members.
|
|
182
180
|
* Displayed on the member's profile page
|
|
@@ -205,12 +203,12 @@ interface Profile {
|
|
|
205
203
|
*/
|
|
206
204
|
title?: string | null;
|
|
207
205
|
}
|
|
208
|
-
interface Image {
|
|
206
|
+
export 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 @@ interface Image {
|
|
|
230
228
|
*/
|
|
231
229
|
offsetY?: number | null;
|
|
232
230
|
}
|
|
233
|
-
declare enum PrivacyStatusStatus {
|
|
231
|
+
export 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. */
|
|
@@ -238,7 +236,7 @@ declare enum PrivacyStatusStatus {
|
|
|
238
236
|
/** Member is visible to everyone. */
|
|
239
237
|
PUBLIC = "PUBLIC"
|
|
240
238
|
}
|
|
241
|
-
declare enum ActivityStatusStatus {
|
|
239
|
+
export declare enum ActivityStatusStatus {
|
|
242
240
|
/** Insufficient permissions to get the status. */
|
|
243
241
|
UNKNOWN = "UNKNOWN",
|
|
244
242
|
/** Member can write forum posts and blog comments. */
|
|
@@ -246,7 +244,7 @@ declare enum ActivityStatusStatus {
|
|
|
246
244
|
/** Member can't write forum posts or blog comments. */
|
|
247
245
|
MUTED = "MUTED"
|
|
248
246
|
}
|
|
249
|
-
interface ExtendedFields {
|
|
247
|
+
export interface ExtendedFields {
|
|
250
248
|
/**
|
|
251
249
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
252
250
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -257,7 +255,7 @@ interface ExtendedFields {
|
|
|
257
255
|
*/
|
|
258
256
|
namespaces?: Record<string, Record<string, any>>;
|
|
259
257
|
}
|
|
260
|
-
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
258
|
+
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
261
259
|
/**
|
|
262
260
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
263
261
|
* @format GUID
|
|
@@ -276,6 +274,8 @@ interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
276
274
|
uri?: URI;
|
|
277
275
|
/** Invalidate by file (for media files such as PDFs) */
|
|
278
276
|
file?: File;
|
|
277
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
278
|
+
customTag?: CustomTag;
|
|
279
279
|
/**
|
|
280
280
|
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
281
281
|
* @maxLength 256
|
|
@@ -286,7 +286,7 @@ interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
286
286
|
hardPurge?: boolean;
|
|
287
287
|
}
|
|
288
288
|
/** @oneof */
|
|
289
|
-
interface InvalidateCacheGetByOneOf {
|
|
289
|
+
export interface InvalidateCacheGetByOneOf {
|
|
290
290
|
/**
|
|
291
291
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
292
292
|
* @format GUID
|
|
@@ -305,8 +305,10 @@ interface InvalidateCacheGetByOneOf {
|
|
|
305
305
|
uri?: URI;
|
|
306
306
|
/** Invalidate by file (for media files such as PDFs) */
|
|
307
307
|
file?: File;
|
|
308
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
309
|
+
customTag?: CustomTag;
|
|
308
310
|
}
|
|
309
|
-
interface App {
|
|
311
|
+
export interface App {
|
|
310
312
|
/**
|
|
311
313
|
* The AppDefId
|
|
312
314
|
* @minLength 1
|
|
@@ -318,7 +320,7 @@ interface App {
|
|
|
318
320
|
*/
|
|
319
321
|
instanceId?: string;
|
|
320
322
|
}
|
|
321
|
-
interface Page {
|
|
323
|
+
export interface Page {
|
|
322
324
|
/**
|
|
323
325
|
* the msid the page is on
|
|
324
326
|
* @format GUID
|
|
@@ -330,7 +332,7 @@ interface Page {
|
|
|
330
332
|
*/
|
|
331
333
|
pageId?: string;
|
|
332
334
|
}
|
|
333
|
-
interface URI {
|
|
335
|
+
export interface URI {
|
|
334
336
|
/**
|
|
335
337
|
* the msid the URI is on
|
|
336
338
|
* @format GUID
|
|
@@ -342,7 +344,7 @@ interface URI {
|
|
|
342
344
|
*/
|
|
343
345
|
uriPath?: string;
|
|
344
346
|
}
|
|
345
|
-
interface File {
|
|
347
|
+
export interface File {
|
|
346
348
|
/**
|
|
347
349
|
* the msid the file is related to
|
|
348
350
|
* @format GUID
|
|
@@ -355,44 +357,57 @@ interface File {
|
|
|
355
357
|
*/
|
|
356
358
|
fileName?: string;
|
|
357
359
|
}
|
|
358
|
-
interface
|
|
360
|
+
export interface CustomTag {
|
|
361
|
+
/**
|
|
362
|
+
* the msid the tag is related to
|
|
363
|
+
* @format GUID
|
|
364
|
+
*/
|
|
365
|
+
metaSiteId?: string;
|
|
366
|
+
/**
|
|
367
|
+
* Tag to invalidate by
|
|
368
|
+
* @minLength 1
|
|
369
|
+
* @maxLength 256
|
|
370
|
+
*/
|
|
371
|
+
tag?: string;
|
|
372
|
+
}
|
|
373
|
+
export interface UpdateMySlugRequest {
|
|
359
374
|
/**
|
|
360
375
|
* New slug.
|
|
361
376
|
* @maxLength 255
|
|
362
377
|
*/
|
|
363
378
|
slug: string;
|
|
364
379
|
}
|
|
365
|
-
interface UpdateMySlugResponse {
|
|
380
|
+
export interface UpdateMySlugResponse {
|
|
366
381
|
/** Updated member. */
|
|
367
382
|
member?: Member;
|
|
368
383
|
}
|
|
369
|
-
interface SlugAlreadyExistsPayload {
|
|
384
|
+
export interface SlugAlreadyExistsPayload {
|
|
370
385
|
slug?: string;
|
|
371
386
|
}
|
|
372
|
-
interface UpdateMemberSlugRequest {
|
|
387
|
+
export interface UpdateMemberSlugRequest {
|
|
373
388
|
/**
|
|
374
389
|
* Member ID.
|
|
375
390
|
* @format GUID
|
|
376
391
|
*/
|
|
377
|
-
|
|
392
|
+
id: string;
|
|
378
393
|
/**
|
|
379
394
|
* New slug.
|
|
380
395
|
* @maxLength 255
|
|
381
396
|
*/
|
|
382
397
|
slug: string;
|
|
383
398
|
}
|
|
384
|
-
interface UpdateMemberSlugResponse {
|
|
399
|
+
export interface UpdateMemberSlugResponse {
|
|
385
400
|
/** Updated member. */
|
|
386
401
|
member?: Member;
|
|
387
402
|
}
|
|
388
|
-
interface JoinCommunityRequest {
|
|
403
|
+
export interface JoinCommunityRequest {
|
|
389
404
|
}
|
|
390
405
|
/** Member profile. */
|
|
391
|
-
interface JoinCommunityResponse {
|
|
406
|
+
export interface JoinCommunityResponse {
|
|
392
407
|
/** The updated member. */
|
|
393
408
|
member?: Member;
|
|
394
409
|
}
|
|
395
|
-
interface MemberJoinedCommunity {
|
|
410
|
+
export interface MemberJoinedCommunity {
|
|
396
411
|
/**
|
|
397
412
|
* ID of the member who joined the community.
|
|
398
413
|
* @format GUID
|
|
@@ -400,14 +415,14 @@ interface MemberJoinedCommunity {
|
|
|
400
415
|
*/
|
|
401
416
|
memberId?: string;
|
|
402
417
|
}
|
|
403
|
-
interface LeaveCommunityRequest {
|
|
418
|
+
export interface LeaveCommunityRequest {
|
|
404
419
|
}
|
|
405
420
|
/** Member profile. */
|
|
406
|
-
interface LeaveCommunityResponse {
|
|
421
|
+
export interface LeaveCommunityResponse {
|
|
407
422
|
/** The updated member. */
|
|
408
423
|
member?: Member;
|
|
409
424
|
}
|
|
410
|
-
interface MemberLeftCommunity {
|
|
425
|
+
export interface MemberLeftCommunity {
|
|
411
426
|
/**
|
|
412
427
|
* ID of the site member who left the community.
|
|
413
428
|
* @format GUID
|
|
@@ -415,7 +430,7 @@ interface MemberLeftCommunity {
|
|
|
415
430
|
*/
|
|
416
431
|
memberId?: string;
|
|
417
432
|
}
|
|
418
|
-
interface GetMyMemberRequest {
|
|
433
|
+
export interface GetMyMemberRequest {
|
|
419
434
|
/**
|
|
420
435
|
* Predefined set of fields to return.
|
|
421
436
|
*
|
|
@@ -424,7 +439,7 @@ interface GetMyMemberRequest {
|
|
|
424
439
|
*/
|
|
425
440
|
fieldsets?: Set[];
|
|
426
441
|
}
|
|
427
|
-
declare enum Set {
|
|
442
|
+
export declare enum Set {
|
|
428
443
|
/**
|
|
429
444
|
* Includes `id`, `contactId`, `createdDate`, `updatedDate` and the `profile` object.
|
|
430
445
|
* `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
|
|
@@ -436,16 +451,16 @@ declare enum Set {
|
|
|
436
451
|
FULL = "FULL"
|
|
437
452
|
}
|
|
438
453
|
/** Member profile. */
|
|
439
|
-
interface GetMyMemberResponse {
|
|
454
|
+
export interface GetMyMemberResponse {
|
|
440
455
|
/** The retrieved member. */
|
|
441
456
|
member?: Member;
|
|
442
457
|
}
|
|
443
|
-
interface GetMemberRequest {
|
|
458
|
+
export interface GetMemberRequest {
|
|
444
459
|
/**
|
|
445
460
|
* Member ID.
|
|
446
461
|
* @format GUID
|
|
447
462
|
*/
|
|
448
|
-
|
|
463
|
+
id: string;
|
|
449
464
|
/**
|
|
450
465
|
* Predefined set of fields to return.
|
|
451
466
|
*
|
|
@@ -454,18 +469,18 @@ interface GetMemberRequest {
|
|
|
454
469
|
*/
|
|
455
470
|
fieldsets?: Set[];
|
|
456
471
|
}
|
|
457
|
-
interface GetMemberResponse {
|
|
472
|
+
export interface GetMemberResponse {
|
|
458
473
|
/** The requested member. */
|
|
459
474
|
member?: Member;
|
|
460
475
|
}
|
|
461
|
-
interface MemberToMemberBlockedPayload {
|
|
476
|
+
export interface MemberToMemberBlockedPayload {
|
|
462
477
|
/**
|
|
463
478
|
* Member ID.
|
|
464
479
|
* @format GUID
|
|
465
480
|
*/
|
|
466
481
|
memberId?: string;
|
|
467
482
|
}
|
|
468
|
-
interface ListMembersRequest {
|
|
483
|
+
export interface ListMembersRequest {
|
|
469
484
|
paging?: Paging;
|
|
470
485
|
/**
|
|
471
486
|
* Predefined sets of fields to return.
|
|
@@ -476,13 +491,13 @@ interface ListMembersRequest {
|
|
|
476
491
|
fieldsets?: Set[];
|
|
477
492
|
sorting?: Sorting[];
|
|
478
493
|
}
|
|
479
|
-
interface Paging {
|
|
494
|
+
export interface Paging {
|
|
480
495
|
/** Number of items to load. */
|
|
481
496
|
limit?: number | null;
|
|
482
497
|
/** Number of items to skip in the current sort order. */
|
|
483
498
|
offset?: number | null;
|
|
484
499
|
}
|
|
485
|
-
interface Sorting {
|
|
500
|
+
export interface Sorting {
|
|
486
501
|
/**
|
|
487
502
|
* Name of the field to sort by.
|
|
488
503
|
* @maxLength 512
|
|
@@ -491,11 +506,11 @@ interface Sorting {
|
|
|
491
506
|
/** Sort order. */
|
|
492
507
|
order?: SortOrder;
|
|
493
508
|
}
|
|
494
|
-
declare enum SortOrder {
|
|
509
|
+
export declare enum SortOrder {
|
|
495
510
|
ASC = "ASC",
|
|
496
511
|
DESC = "DESC"
|
|
497
512
|
}
|
|
498
|
-
interface CursorPaging {
|
|
513
|
+
export interface CursorPaging {
|
|
499
514
|
/**
|
|
500
515
|
* Maximum number of items to return in the results.
|
|
501
516
|
* @max 100
|
|
@@ -510,13 +525,13 @@ interface CursorPaging {
|
|
|
510
525
|
*/
|
|
511
526
|
cursor?: string | null;
|
|
512
527
|
}
|
|
513
|
-
interface ListMembersResponse {
|
|
528
|
+
export interface ListMembersResponse {
|
|
514
529
|
/** List of members. */
|
|
515
530
|
members?: Member[];
|
|
516
531
|
/** Metadata for the paginated results. */
|
|
517
532
|
metadata?: PagingMetadata;
|
|
518
533
|
}
|
|
519
|
-
interface PagingMetadata {
|
|
534
|
+
export interface PagingMetadata {
|
|
520
535
|
/** Number of items returned in the response. */
|
|
521
536
|
count?: number | null;
|
|
522
537
|
/** Offset that was requested. */
|
|
@@ -526,7 +541,7 @@ interface PagingMetadata {
|
|
|
526
541
|
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
527
542
|
tooManyToCount?: boolean | null;
|
|
528
543
|
}
|
|
529
|
-
interface CursorPagingMetadata {
|
|
544
|
+
export interface CursorPagingMetadata {
|
|
530
545
|
/** Number of items returned in the response. */
|
|
531
546
|
count?: number | null;
|
|
532
547
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -539,7 +554,7 @@ interface CursorPagingMetadata {
|
|
|
539
554
|
*/
|
|
540
555
|
hasNext?: boolean | null;
|
|
541
556
|
}
|
|
542
|
-
interface Cursors {
|
|
557
|
+
export interface Cursors {
|
|
543
558
|
/**
|
|
544
559
|
* Cursor string pointing to the next page in the list of results.
|
|
545
560
|
* @maxLength 16000
|
|
@@ -551,7 +566,7 @@ interface Cursors {
|
|
|
551
566
|
*/
|
|
552
567
|
prev?: string | null;
|
|
553
568
|
}
|
|
554
|
-
interface QueryMembersRequest {
|
|
569
|
+
export interface QueryMembersRequest {
|
|
555
570
|
/** Query options. */
|
|
556
571
|
query?: Query;
|
|
557
572
|
/**
|
|
@@ -564,7 +579,7 @@ interface QueryMembersRequest {
|
|
|
564
579
|
/** Plain text search. */
|
|
565
580
|
search?: Search;
|
|
566
581
|
}
|
|
567
|
-
interface Query {
|
|
582
|
+
export interface Query {
|
|
568
583
|
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
569
584
|
filter?: any;
|
|
570
585
|
/** Limit number of results */
|
|
@@ -573,7 +588,7 @@ interface Query {
|
|
|
573
588
|
sorting?: Sorting[];
|
|
574
589
|
}
|
|
575
590
|
/** Free text to match in searchable fields */
|
|
576
|
-
interface Search {
|
|
591
|
+
export interface Search {
|
|
577
592
|
/**
|
|
578
593
|
* Search term or expression.
|
|
579
594
|
* @minLength 1
|
|
@@ -595,24 +610,24 @@ interface Search {
|
|
|
595
610
|
*/
|
|
596
611
|
fields?: string[];
|
|
597
612
|
}
|
|
598
|
-
interface QueryMembersResponse {
|
|
613
|
+
export interface QueryMembersResponse {
|
|
599
614
|
/** List of members that met the query filter criteria. */
|
|
600
615
|
members?: Member[];
|
|
601
616
|
/** Metadata for the paginated results. */
|
|
602
617
|
metadata?: PagingMetadata;
|
|
603
618
|
}
|
|
604
|
-
interface MuteMemberRequest {
|
|
619
|
+
export interface MuteMemberRequest {
|
|
605
620
|
/**
|
|
606
621
|
* ID of the member to mute.
|
|
607
622
|
* @format GUID
|
|
608
623
|
*/
|
|
609
|
-
|
|
624
|
+
id: string;
|
|
610
625
|
}
|
|
611
|
-
interface MuteMemberResponse {
|
|
626
|
+
export interface MuteMemberResponse {
|
|
612
627
|
/** Muted member. */
|
|
613
628
|
member?: Member;
|
|
614
629
|
}
|
|
615
|
-
interface MemberMuted {
|
|
630
|
+
export interface MemberMuted {
|
|
616
631
|
/**
|
|
617
632
|
* ID of the member who got muted.
|
|
618
633
|
* @format GUID
|
|
@@ -620,18 +635,18 @@ interface MemberMuted {
|
|
|
620
635
|
*/
|
|
621
636
|
memberId?: string;
|
|
622
637
|
}
|
|
623
|
-
interface UnmuteMemberRequest {
|
|
638
|
+
export interface UnmuteMemberRequest {
|
|
624
639
|
/**
|
|
625
640
|
* ID of the member to unmute.
|
|
626
641
|
* @format GUID
|
|
627
642
|
*/
|
|
628
|
-
|
|
643
|
+
id: string;
|
|
629
644
|
}
|
|
630
|
-
interface UnmuteMemberResponse {
|
|
645
|
+
export interface UnmuteMemberResponse {
|
|
631
646
|
/** Unmuted member. */
|
|
632
647
|
member?: Member;
|
|
633
648
|
}
|
|
634
|
-
interface MemberUnmuted {
|
|
649
|
+
export interface MemberUnmuted {
|
|
635
650
|
/**
|
|
636
651
|
* ID of the member who got unmuted.
|
|
637
652
|
* @format GUID
|
|
@@ -639,18 +654,18 @@ interface MemberUnmuted {
|
|
|
639
654
|
*/
|
|
640
655
|
memberId?: string;
|
|
641
656
|
}
|
|
642
|
-
interface ApproveMemberRequest {
|
|
657
|
+
export interface ApproveMemberRequest {
|
|
643
658
|
/**
|
|
644
659
|
* ID of the member to approve.
|
|
645
660
|
* @format GUID
|
|
646
661
|
*/
|
|
647
|
-
|
|
662
|
+
id: string;
|
|
648
663
|
}
|
|
649
|
-
interface ApproveMemberResponse {
|
|
664
|
+
export interface ApproveMemberResponse {
|
|
650
665
|
/** Approved member. */
|
|
651
666
|
member?: Member;
|
|
652
667
|
}
|
|
653
|
-
interface MemberApproved {
|
|
668
|
+
export interface MemberApproved {
|
|
654
669
|
/**
|
|
655
670
|
* ID of the member who got approved.
|
|
656
671
|
* @format GUID
|
|
@@ -658,18 +673,18 @@ interface MemberApproved {
|
|
|
658
673
|
*/
|
|
659
674
|
memberId?: string;
|
|
660
675
|
}
|
|
661
|
-
interface BlockMemberRequest {
|
|
676
|
+
export interface BlockMemberRequest {
|
|
662
677
|
/**
|
|
663
678
|
* ID of a member to block.
|
|
664
679
|
* @format GUID
|
|
665
680
|
*/
|
|
666
|
-
|
|
681
|
+
id: string;
|
|
667
682
|
}
|
|
668
|
-
interface BlockMemberResponse {
|
|
683
|
+
export interface BlockMemberResponse {
|
|
669
684
|
/** Blocked member. */
|
|
670
685
|
member?: Member;
|
|
671
686
|
}
|
|
672
|
-
interface MemberBlocked {
|
|
687
|
+
export interface MemberBlocked {
|
|
673
688
|
/**
|
|
674
689
|
* ID of the member who got blocked.
|
|
675
690
|
* @format GUID
|
|
@@ -677,78 +692,78 @@ interface MemberBlocked {
|
|
|
677
692
|
*/
|
|
678
693
|
memberId?: string;
|
|
679
694
|
}
|
|
680
|
-
interface MemberSelfBlockForbiddenPayload {
|
|
695
|
+
export interface MemberSelfBlockForbiddenPayload {
|
|
681
696
|
/**
|
|
682
697
|
* Target's member ID.
|
|
683
698
|
* @format GUID
|
|
684
699
|
*/
|
|
685
700
|
memberId?: string;
|
|
686
701
|
}
|
|
687
|
-
interface OwnerMemberBlockForbiddenPayload {
|
|
702
|
+
export interface OwnerMemberBlockForbiddenPayload {
|
|
688
703
|
/**
|
|
689
704
|
* Owner's member ID.
|
|
690
705
|
* @format GUID
|
|
691
706
|
*/
|
|
692
707
|
memberId?: string;
|
|
693
708
|
}
|
|
694
|
-
interface ActiveSubscriptionMemberBlockForbiddenPayload {
|
|
709
|
+
export interface ActiveSubscriptionMemberBlockForbiddenPayload {
|
|
695
710
|
/**
|
|
696
711
|
* Active subscription member ID.
|
|
697
712
|
* @format GUID
|
|
698
713
|
*/
|
|
699
714
|
memberId?: string;
|
|
700
715
|
}
|
|
701
|
-
interface DisconnectMemberRequest {
|
|
716
|
+
export interface DisconnectMemberRequest {
|
|
702
717
|
/**
|
|
703
718
|
* ID of a member to disconnect.
|
|
704
719
|
* @format GUID
|
|
705
720
|
*/
|
|
706
|
-
|
|
721
|
+
id: string;
|
|
707
722
|
}
|
|
708
|
-
interface DisconnectMemberResponse {
|
|
723
|
+
export interface DisconnectMemberResponse {
|
|
709
724
|
/** Disconnected member. */
|
|
710
725
|
member?: Member;
|
|
711
726
|
}
|
|
712
|
-
interface DeleteMemberRequest {
|
|
727
|
+
export interface DeleteMemberRequest {
|
|
713
728
|
/**
|
|
714
729
|
* ID of a member to delete.
|
|
715
730
|
* @format GUID
|
|
716
731
|
*/
|
|
717
|
-
|
|
732
|
+
id: string;
|
|
718
733
|
}
|
|
719
|
-
interface DeleteMemberResponse {
|
|
734
|
+
export interface DeleteMemberResponse {
|
|
720
735
|
}
|
|
721
|
-
interface ContentReassignmentRequested {
|
|
736
|
+
export interface ContentReassignmentRequested {
|
|
722
737
|
fromMember?: Member;
|
|
723
738
|
toMember?: Member;
|
|
724
739
|
}
|
|
725
|
-
interface ContentDeletionRequested {
|
|
740
|
+
export interface ContentDeletionRequested {
|
|
726
741
|
member?: Member;
|
|
727
742
|
}
|
|
728
|
-
interface OwnerOrContributorDeleteForbiddenPayload {
|
|
743
|
+
export interface OwnerOrContributorDeleteForbiddenPayload {
|
|
729
744
|
/**
|
|
730
745
|
* Owner's or contributor's member ID.
|
|
731
746
|
* @format GUID
|
|
732
747
|
*/
|
|
733
748
|
memberId?: string;
|
|
734
749
|
}
|
|
735
|
-
interface ActiveSubscriptionMemberDeleteForbiddenPayload {
|
|
750
|
+
export interface ActiveSubscriptionMemberDeleteForbiddenPayload {
|
|
736
751
|
/**
|
|
737
752
|
* Active subscription member ID.
|
|
738
753
|
* @format GUID
|
|
739
754
|
*/
|
|
740
755
|
memberId?: string;
|
|
741
756
|
}
|
|
742
|
-
interface DeleteMyMemberRequest {
|
|
757
|
+
export interface DeleteMyMemberRequest {
|
|
743
758
|
/**
|
|
744
759
|
* ID of a member receiving the deleted member's content.
|
|
745
760
|
* @format GUID
|
|
746
761
|
*/
|
|
747
762
|
contentAssigneeId?: string | null;
|
|
748
763
|
}
|
|
749
|
-
interface DeleteMyMemberResponse {
|
|
764
|
+
export interface DeleteMyMemberResponse {
|
|
750
765
|
}
|
|
751
|
-
interface BulkDeleteMembersRequest {
|
|
766
|
+
export interface BulkDeleteMembersRequest {
|
|
752
767
|
/**
|
|
753
768
|
* IDs of members to be deleted.
|
|
754
769
|
* @minSize 1
|
|
@@ -757,18 +772,18 @@ interface BulkDeleteMembersRequest {
|
|
|
757
772
|
*/
|
|
758
773
|
memberIds: string[];
|
|
759
774
|
}
|
|
760
|
-
interface BulkDeleteMembersResponse {
|
|
775
|
+
export interface BulkDeleteMembersResponse {
|
|
761
776
|
/** Result. */
|
|
762
777
|
results?: BulkMemberResult[];
|
|
763
778
|
/** Bulk action result metadata. */
|
|
764
779
|
bulkActionMetadata?: BulkActionMetadata;
|
|
765
780
|
}
|
|
766
|
-
interface ItemMetadata {
|
|
781
|
+
export interface ItemMetadata {
|
|
767
782
|
/**
|
|
768
783
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
769
784
|
* @maxLength 255
|
|
770
785
|
*/
|
|
771
|
-
|
|
786
|
+
id?: string | null;
|
|
772
787
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
773
788
|
originalIndex?: number;
|
|
774
789
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -776,7 +791,7 @@ interface ItemMetadata {
|
|
|
776
791
|
/** Details about the error in case of failure. */
|
|
777
792
|
error?: ApplicationError;
|
|
778
793
|
}
|
|
779
|
-
interface ApplicationError {
|
|
794
|
+
export interface ApplicationError {
|
|
780
795
|
/** Error code. */
|
|
781
796
|
code?: string;
|
|
782
797
|
/** Description of the error. */
|
|
@@ -784,10 +799,10 @@ interface ApplicationError {
|
|
|
784
799
|
/** Data related to the error. */
|
|
785
800
|
data?: Record<string, any> | null;
|
|
786
801
|
}
|
|
787
|
-
interface BulkMemberResult {
|
|
802
|
+
export interface BulkMemberResult {
|
|
788
803
|
itemMetadata?: ItemMetadata;
|
|
789
804
|
}
|
|
790
|
-
interface BulkActionMetadata {
|
|
805
|
+
export interface BulkActionMetadata {
|
|
791
806
|
/** Number of items that were successfully processed. */
|
|
792
807
|
totalSuccesses?: number;
|
|
793
808
|
/** Number of items that couldn't be processed. */
|
|
@@ -795,7 +810,7 @@ interface BulkActionMetadata {
|
|
|
795
810
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
796
811
|
undetailedFailures?: number;
|
|
797
812
|
}
|
|
798
|
-
interface BulkDeleteMembersByFilterRequest {
|
|
813
|
+
export interface BulkDeleteMembersByFilterRequest {
|
|
799
814
|
/** 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. */
|
|
800
815
|
filter: any;
|
|
801
816
|
/**
|
|
@@ -806,114 +821,110 @@ interface BulkDeleteMembersByFilterRequest {
|
|
|
806
821
|
/** Plain text search. */
|
|
807
822
|
search?: Search;
|
|
808
823
|
}
|
|
809
|
-
interface BulkDeleteMembersByFilterResponse {
|
|
824
|
+
export interface BulkDeleteMembersByFilterResponse {
|
|
810
825
|
/**
|
|
811
826
|
* Job ID.
|
|
812
827
|
* 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.
|
|
813
828
|
*/
|
|
814
829
|
jobId?: string;
|
|
815
830
|
}
|
|
816
|
-
interface BulkApproveMembersRequest {
|
|
831
|
+
export interface BulkApproveMembersRequest {
|
|
817
832
|
/** Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details. */
|
|
818
833
|
filter: any;
|
|
819
834
|
}
|
|
820
|
-
interface BulkApproveMembersResponse {
|
|
835
|
+
export interface BulkApproveMembersResponse {
|
|
821
836
|
/**
|
|
822
837
|
* Job ID.
|
|
823
838
|
* 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.
|
|
824
839
|
*/
|
|
825
840
|
jobId?: string;
|
|
826
841
|
}
|
|
827
|
-
interface BulkBlockMembersRequest {
|
|
842
|
+
export interface BulkBlockMembersRequest {
|
|
828
843
|
/** 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. */
|
|
829
844
|
filter: any;
|
|
830
845
|
}
|
|
831
|
-
interface BulkBlockMembersResponse {
|
|
846
|
+
export interface BulkBlockMembersResponse {
|
|
832
847
|
/**
|
|
833
848
|
* Job ID.
|
|
834
849
|
* 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.
|
|
835
850
|
*/
|
|
836
851
|
jobId?: string;
|
|
837
852
|
}
|
|
838
|
-
interface CreateMemberRequest {
|
|
853
|
+
export interface CreateMemberRequest {
|
|
839
854
|
/** Member to create. */
|
|
840
855
|
member?: Member;
|
|
841
856
|
}
|
|
842
|
-
interface CreateMemberResponse {
|
|
857
|
+
export interface CreateMemberResponse {
|
|
843
858
|
/** New member. */
|
|
844
859
|
member?: Member;
|
|
845
860
|
}
|
|
846
|
-
interface UpdateMemberRequest {
|
|
861
|
+
export interface UpdateMemberRequest {
|
|
847
862
|
/** Member info to update. */
|
|
848
863
|
member?: Member;
|
|
849
864
|
}
|
|
850
|
-
interface UpdateMemberResponse {
|
|
865
|
+
export interface UpdateMemberResponse {
|
|
851
866
|
/** Updated member. */
|
|
852
867
|
member?: Member;
|
|
853
868
|
}
|
|
854
|
-
interface InvalidCustomFieldUrlPayload {
|
|
869
|
+
export interface InvalidCustomFieldUrlPayload {
|
|
855
870
|
/** Custom field key and invalid URL. */
|
|
856
871
|
fields?: Record<string, string>;
|
|
857
872
|
}
|
|
858
|
-
interface DeleteMemberPhonesRequest {
|
|
873
|
+
export interface DeleteMemberPhonesRequest {
|
|
859
874
|
/**
|
|
860
875
|
* ID of the member whose phone numbers will be deleted.
|
|
861
876
|
* @format GUID
|
|
862
877
|
*/
|
|
863
|
-
|
|
878
|
+
id: string;
|
|
864
879
|
}
|
|
865
|
-
interface DeleteMemberPhonesResponse {
|
|
880
|
+
export interface DeleteMemberPhonesResponse {
|
|
866
881
|
/** Updated member. */
|
|
867
882
|
member?: Member;
|
|
868
883
|
}
|
|
869
|
-
interface DeleteMemberEmailsRequest {
|
|
884
|
+
export interface DeleteMemberEmailsRequest {
|
|
870
885
|
/**
|
|
871
886
|
* ID of the member whose email addresses will be deleted.
|
|
872
887
|
* @format GUID
|
|
873
888
|
*/
|
|
874
|
-
|
|
889
|
+
id: string;
|
|
875
890
|
}
|
|
876
|
-
interface DeleteMemberEmailsResponse {
|
|
891
|
+
export interface DeleteMemberEmailsResponse {
|
|
877
892
|
/** Updated member. */
|
|
878
893
|
member?: Member;
|
|
879
894
|
}
|
|
880
|
-
interface DeleteMemberAddressesRequest {
|
|
895
|
+
export interface DeleteMemberAddressesRequest {
|
|
881
896
|
/**
|
|
882
897
|
* ID of the member whose street addresses will be deleted.
|
|
883
898
|
* @format GUID
|
|
884
899
|
*/
|
|
885
|
-
|
|
900
|
+
id: string;
|
|
886
901
|
}
|
|
887
|
-
interface DeleteMemberAddressesResponse {
|
|
902
|
+
export interface DeleteMemberAddressesResponse {
|
|
888
903
|
/** Updated member. */
|
|
889
904
|
member?: Member;
|
|
890
905
|
}
|
|
891
|
-
interface Empty {
|
|
906
|
+
export interface Empty {
|
|
892
907
|
}
|
|
893
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
908
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
894
909
|
createdEvent?: EntityCreatedEvent;
|
|
895
910
|
updatedEvent?: EntityUpdatedEvent;
|
|
896
911
|
deletedEvent?: EntityDeletedEvent;
|
|
897
912
|
actionEvent?: ActionEvent;
|
|
913
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
914
|
+
id?: string;
|
|
898
915
|
/**
|
|
899
|
-
*
|
|
900
|
-
*
|
|
901
|
-
*/
|
|
902
|
-
_id?: string;
|
|
903
|
-
/**
|
|
904
|
-
* Assumes actions are also always typed to an entity_type
|
|
905
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
916
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
917
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
906
918
|
*/
|
|
907
919
|
entityFqdn?: string;
|
|
908
920
|
/**
|
|
909
|
-
*
|
|
910
|
-
*
|
|
911
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
921
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
922
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
912
923
|
*/
|
|
913
924
|
slug?: string;
|
|
914
925
|
/** ID of the entity associated with the event. */
|
|
915
926
|
entityId?: string;
|
|
916
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
927
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
917
928
|
eventTime?: Date | null;
|
|
918
929
|
/**
|
|
919
930
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -923,44 +934,42 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
923
934
|
/** If present, indicates the action that triggered the event. */
|
|
924
935
|
originatedFrom?: string | null;
|
|
925
936
|
/**
|
|
926
|
-
* A sequence number
|
|
927
|
-
*
|
|
928
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
929
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
930
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
931
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
937
|
+
* 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.
|
|
938
|
+
* 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.
|
|
932
939
|
*/
|
|
933
940
|
entityEventSequence?: string | null;
|
|
934
941
|
}
|
|
935
942
|
/** @oneof */
|
|
936
|
-
interface DomainEventBodyOneOf {
|
|
943
|
+
export interface DomainEventBodyOneOf {
|
|
937
944
|
createdEvent?: EntityCreatedEvent;
|
|
938
945
|
updatedEvent?: EntityUpdatedEvent;
|
|
939
946
|
deletedEvent?: EntityDeletedEvent;
|
|
940
947
|
actionEvent?: ActionEvent;
|
|
941
948
|
}
|
|
942
|
-
interface EntityCreatedEvent {
|
|
943
|
-
|
|
949
|
+
export interface EntityCreatedEvent {
|
|
950
|
+
entityAsJson?: string;
|
|
951
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
952
|
+
restoreInfo?: RestoreInfo;
|
|
944
953
|
}
|
|
945
|
-
interface RestoreInfo {
|
|
954
|
+
export interface RestoreInfo {
|
|
946
955
|
deletedDate?: Date | null;
|
|
947
956
|
}
|
|
948
|
-
interface EntityUpdatedEvent {
|
|
957
|
+
export interface EntityUpdatedEvent {
|
|
949
958
|
/**
|
|
950
959
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
951
960
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
952
961
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
953
962
|
*/
|
|
954
|
-
|
|
963
|
+
currentEntityAsJson?: string;
|
|
955
964
|
}
|
|
956
|
-
interface EntityDeletedEvent {
|
|
957
|
-
/** Entity that was deleted */
|
|
958
|
-
|
|
965
|
+
export interface EntityDeletedEvent {
|
|
966
|
+
/** Entity that was deleted. */
|
|
967
|
+
deletedEntityAsJson?: string | null;
|
|
959
968
|
}
|
|
960
|
-
interface ActionEvent {
|
|
961
|
-
|
|
969
|
+
export interface ActionEvent {
|
|
970
|
+
bodyAsJson?: string;
|
|
962
971
|
}
|
|
963
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
972
|
+
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
964
973
|
/** Emitted on a meta site creation. */
|
|
965
974
|
siteCreated?: SiteCreated;
|
|
966
975
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -1001,6 +1010,14 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
1001
1010
|
urlChanged?: SiteUrlChanged;
|
|
1002
1011
|
/** Site is marked as PurgedExternally */
|
|
1003
1012
|
sitePurgedExternally?: SitePurgedExternally;
|
|
1013
|
+
/** Emitted when Odeditor is attached. */
|
|
1014
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
1015
|
+
/** Emitted when Odeditor is detached. */
|
|
1016
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
1017
|
+
/** Emitted when Picasso is attached. */
|
|
1018
|
+
picassoAssigned?: PicassoAssigned;
|
|
1019
|
+
/** Emitted when Picasso is detached. */
|
|
1020
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
1004
1021
|
/**
|
|
1005
1022
|
* A meta site id.
|
|
1006
1023
|
* @format GUID
|
|
@@ -1018,7 +1035,7 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
1018
1035
|
assets?: Asset[];
|
|
1019
1036
|
}
|
|
1020
1037
|
/** @oneof */
|
|
1021
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
1038
|
+
export interface MetaSiteSpecialEventPayloadOneOf {
|
|
1022
1039
|
/** Emitted on a meta site creation. */
|
|
1023
1040
|
siteCreated?: SiteCreated;
|
|
1024
1041
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -1059,8 +1076,16 @@ interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
1059
1076
|
urlChanged?: SiteUrlChanged;
|
|
1060
1077
|
/** Site is marked as PurgedExternally */
|
|
1061
1078
|
sitePurgedExternally?: SitePurgedExternally;
|
|
1079
|
+
/** Emitted when Odeditor is attached. */
|
|
1080
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
1081
|
+
/** Emitted when Odeditor is detached. */
|
|
1082
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
1083
|
+
/** Emitted when Picasso is attached. */
|
|
1084
|
+
picassoAssigned?: PicassoAssigned;
|
|
1085
|
+
/** Emitted when Picasso is detached. */
|
|
1086
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
1062
1087
|
}
|
|
1063
|
-
interface Asset {
|
|
1088
|
+
export interface Asset {
|
|
1064
1089
|
/**
|
|
1065
1090
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1066
1091
|
* @maxLength 36
|
|
@@ -1074,14 +1099,14 @@ interface Asset {
|
|
|
1074
1099
|
/** An application state. */
|
|
1075
1100
|
state?: State;
|
|
1076
1101
|
}
|
|
1077
|
-
declare enum State {
|
|
1102
|
+
export declare enum State {
|
|
1078
1103
|
UNKNOWN = "UNKNOWN",
|
|
1079
1104
|
ENABLED = "ENABLED",
|
|
1080
1105
|
DISABLED = "DISABLED",
|
|
1081
1106
|
PENDING = "PENDING",
|
|
1082
1107
|
DEMO = "DEMO"
|
|
1083
1108
|
}
|
|
1084
|
-
interface SiteCreated {
|
|
1109
|
+
export interface SiteCreated {
|
|
1085
1110
|
/**
|
|
1086
1111
|
* A template identifier (empty if not created from a template).
|
|
1087
1112
|
* @maxLength 36
|
|
@@ -1110,7 +1135,7 @@ interface SiteCreated {
|
|
|
1110
1135
|
/** A namespace. */
|
|
1111
1136
|
namespace?: Namespace;
|
|
1112
1137
|
}
|
|
1113
|
-
declare enum SiteCreatedContext {
|
|
1138
|
+
export declare enum SiteCreatedContext {
|
|
1114
1139
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1115
1140
|
OTHER = "OTHER",
|
|
1116
1141
|
/** A meta site was created from template. */
|
|
@@ -1124,7 +1149,7 @@ declare enum SiteCreatedContext {
|
|
|
1124
1149
|
/** deprecated A meta site was created for Flash editor. */
|
|
1125
1150
|
FLASH = "FLASH"
|
|
1126
1151
|
}
|
|
1127
|
-
declare enum Namespace {
|
|
1152
|
+
export declare enum Namespace {
|
|
1128
1153
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1129
1154
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1130
1155
|
WIX = "WIX",
|
|
@@ -1207,7 +1232,7 @@ declare enum Namespace {
|
|
|
1207
1232
|
MIMIR = "MIMIR"
|
|
1208
1233
|
}
|
|
1209
1234
|
/** Site transferred to another user. */
|
|
1210
|
-
interface SiteTransferred {
|
|
1235
|
+
export interface SiteTransferred {
|
|
1211
1236
|
/**
|
|
1212
1237
|
* A previous owner id (user that transfers meta site).
|
|
1213
1238
|
* @format GUID
|
|
@@ -1220,11 +1245,11 @@ interface SiteTransferred {
|
|
|
1220
1245
|
newOwnerId?: string;
|
|
1221
1246
|
}
|
|
1222
1247
|
/** Soft deletion of the meta site. Could be restored. */
|
|
1223
|
-
interface SiteDeleted {
|
|
1248
|
+
export interface SiteDeleted {
|
|
1224
1249
|
/** A deletion context. */
|
|
1225
1250
|
deleteContext?: DeleteContext;
|
|
1226
1251
|
}
|
|
1227
|
-
interface DeleteContext {
|
|
1252
|
+
export interface DeleteContext {
|
|
1228
1253
|
/** When the meta site was deleted. */
|
|
1229
1254
|
dateDeleted?: Date | null;
|
|
1230
1255
|
/** A status. */
|
|
@@ -1240,7 +1265,7 @@ interface DeleteContext {
|
|
|
1240
1265
|
*/
|
|
1241
1266
|
initiatorId?: string | null;
|
|
1242
1267
|
}
|
|
1243
|
-
declare enum DeleteStatus {
|
|
1268
|
+
export declare enum DeleteStatus {
|
|
1244
1269
|
UNKNOWN = "UNKNOWN",
|
|
1245
1270
|
TRASH = "TRASH",
|
|
1246
1271
|
DELETED = "DELETED",
|
|
@@ -1248,12 +1273,12 @@ declare enum DeleteStatus {
|
|
|
1248
1273
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1249
1274
|
}
|
|
1250
1275
|
/** Restoration of the meta site. */
|
|
1251
|
-
interface SiteUndeleted {
|
|
1276
|
+
export interface SiteUndeleted {
|
|
1252
1277
|
}
|
|
1253
1278
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1254
|
-
interface SitePublished {
|
|
1279
|
+
export interface SitePublished {
|
|
1255
1280
|
}
|
|
1256
|
-
interface SiteUnpublished {
|
|
1281
|
+
export interface SiteUnpublished {
|
|
1257
1282
|
/**
|
|
1258
1283
|
* A list of URLs previously associated with the meta site.
|
|
1259
1284
|
* @maxLength 4000
|
|
@@ -1261,9 +1286,9 @@ interface SiteUnpublished {
|
|
|
1261
1286
|
*/
|
|
1262
1287
|
urls?: string[];
|
|
1263
1288
|
}
|
|
1264
|
-
interface SiteMarkedAsTemplate {
|
|
1289
|
+
export interface SiteMarkedAsTemplate {
|
|
1265
1290
|
}
|
|
1266
|
-
interface SiteMarkedAsWixSite {
|
|
1291
|
+
export interface SiteMarkedAsWixSite {
|
|
1267
1292
|
}
|
|
1268
1293
|
/**
|
|
1269
1294
|
* Represents a service provisioned a site.
|
|
@@ -1280,7 +1305,7 @@ interface SiteMarkedAsWixSite {
|
|
|
1280
1305
|
* changes made to the original template afterward.
|
|
1281
1306
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1282
1307
|
*/
|
|
1283
|
-
interface ServiceProvisioned {
|
|
1308
|
+
export interface ServiceProvisioned {
|
|
1284
1309
|
/**
|
|
1285
1310
|
* Either UUID or EmbeddedServiceType.
|
|
1286
1311
|
* @maxLength 36
|
|
@@ -1307,7 +1332,7 @@ interface ServiceProvisioned {
|
|
|
1307
1332
|
*/
|
|
1308
1333
|
originMetaSiteId?: string | null;
|
|
1309
1334
|
}
|
|
1310
|
-
interface ServiceRemoved {
|
|
1335
|
+
export interface ServiceRemoved {
|
|
1311
1336
|
/**
|
|
1312
1337
|
* Either UUID or EmbeddedServiceType.
|
|
1313
1338
|
* @maxLength 36
|
|
@@ -1325,7 +1350,7 @@ interface ServiceRemoved {
|
|
|
1325
1350
|
version?: string | null;
|
|
1326
1351
|
}
|
|
1327
1352
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1328
|
-
interface SiteRenamed {
|
|
1353
|
+
export interface SiteRenamed {
|
|
1329
1354
|
/**
|
|
1330
1355
|
* A new meta site name (URL slug).
|
|
1331
1356
|
* @maxLength 20
|
|
@@ -1342,21 +1367,21 @@ interface SiteRenamed {
|
|
|
1342
1367
|
*
|
|
1343
1368
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1344
1369
|
*/
|
|
1345
|
-
interface SiteHardDeleted {
|
|
1370
|
+
export interface SiteHardDeleted {
|
|
1346
1371
|
/** A deletion context. */
|
|
1347
1372
|
deleteContext?: DeleteContext;
|
|
1348
1373
|
}
|
|
1349
|
-
interface NamespaceChanged {
|
|
1374
|
+
export interface NamespaceChanged {
|
|
1350
1375
|
/** A previous namespace. */
|
|
1351
1376
|
oldNamespace?: Namespace;
|
|
1352
1377
|
/** A new namespace. */
|
|
1353
1378
|
newNamespace?: Namespace;
|
|
1354
1379
|
}
|
|
1355
1380
|
/** Assigned Studio editor */
|
|
1356
|
-
interface StudioAssigned {
|
|
1381
|
+
export interface StudioAssigned {
|
|
1357
1382
|
}
|
|
1358
1383
|
/** Unassigned Studio editor */
|
|
1359
|
-
interface StudioUnassigned {
|
|
1384
|
+
export interface StudioUnassigned {
|
|
1360
1385
|
}
|
|
1361
1386
|
/**
|
|
1362
1387
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -1366,13 +1391,13 @@ interface StudioUnassigned {
|
|
|
1366
1391
|
*
|
|
1367
1392
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1368
1393
|
*/
|
|
1369
|
-
interface SiteUrlChanged {
|
|
1394
|
+
export interface SiteUrlChanged {
|
|
1370
1395
|
}
|
|
1371
1396
|
/**
|
|
1372
1397
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1373
1398
|
* Consumed by other teams to remove relevant data.
|
|
1374
1399
|
*/
|
|
1375
|
-
interface SitePurgedExternally {
|
|
1400
|
+
export interface SitePurgedExternally {
|
|
1376
1401
|
/**
|
|
1377
1402
|
* @maxLength 2048
|
|
1378
1403
|
* @maxSize 100
|
|
@@ -1381,17 +1406,29 @@ interface SitePurgedExternally {
|
|
|
1381
1406
|
*/
|
|
1382
1407
|
appDefId?: string[];
|
|
1383
1408
|
}
|
|
1384
|
-
|
|
1409
|
+
/** Assigned Odeditor */
|
|
1410
|
+
export interface OdeditorAssigned {
|
|
1411
|
+
}
|
|
1412
|
+
/** Unassigned Odeditor */
|
|
1413
|
+
export interface OdeditorUnassigned {
|
|
1414
|
+
}
|
|
1415
|
+
/** Assigned Picasso editor */
|
|
1416
|
+
export interface PicassoAssigned {
|
|
1417
|
+
}
|
|
1418
|
+
/** Unassigned Picasso */
|
|
1419
|
+
export interface PicassoUnassigned {
|
|
1420
|
+
}
|
|
1421
|
+
export interface MemberOwnershipTransferred {
|
|
1385
1422
|
fromMember?: Member;
|
|
1386
1423
|
toMember?: Member;
|
|
1387
1424
|
}
|
|
1388
|
-
interface MemberIdChanged {
|
|
1425
|
+
export interface MemberIdChanged {
|
|
1389
1426
|
/** @format GUID */
|
|
1390
1427
|
fromId?: string;
|
|
1391
1428
|
/** @format GUID */
|
|
1392
1429
|
toId?: string;
|
|
1393
1430
|
}
|
|
1394
|
-
interface MessageEnvelope {
|
|
1431
|
+
export interface MessageEnvelope {
|
|
1395
1432
|
/**
|
|
1396
1433
|
* App instance ID.
|
|
1397
1434
|
* @format GUID
|
|
@@ -1407,7 +1444,7 @@ interface MessageEnvelope {
|
|
|
1407
1444
|
/** Stringify payload. */
|
|
1408
1445
|
data?: string;
|
|
1409
1446
|
}
|
|
1410
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1447
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1411
1448
|
/**
|
|
1412
1449
|
* ID of a site visitor that has not logged in to the site.
|
|
1413
1450
|
* @format GUID
|
|
@@ -1432,7 +1469,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1432
1469
|
identityType?: WebhookIdentityType;
|
|
1433
1470
|
}
|
|
1434
1471
|
/** @oneof */
|
|
1435
|
-
interface IdentificationDataIdOneOf {
|
|
1472
|
+
export interface IdentificationDataIdOneOf {
|
|
1436
1473
|
/**
|
|
1437
1474
|
* ID of a site visitor that has not logged in to the site.
|
|
1438
1475
|
* @format GUID
|
|
@@ -1454,238 +1491,10 @@ interface IdentificationDataIdOneOf {
|
|
|
1454
1491
|
*/
|
|
1455
1492
|
appId?: string;
|
|
1456
1493
|
}
|
|
1457
|
-
declare enum WebhookIdentityType {
|
|
1494
|
+
export declare enum WebhookIdentityType {
|
|
1458
1495
|
UNKNOWN = "UNKNOWN",
|
|
1459
1496
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1460
1497
|
MEMBER = "MEMBER",
|
|
1461
1498
|
WIX_USER = "WIX_USER",
|
|
1462
1499
|
APP = "APP"
|
|
1463
1500
|
}
|
|
1464
|
-
interface BaseEventMetadata {
|
|
1465
|
-
/**
|
|
1466
|
-
* App instance ID.
|
|
1467
|
-
* @format GUID
|
|
1468
|
-
*/
|
|
1469
|
-
instanceId?: string | null;
|
|
1470
|
-
/**
|
|
1471
|
-
* Event type.
|
|
1472
|
-
* @maxLength 150
|
|
1473
|
-
*/
|
|
1474
|
-
eventType?: string;
|
|
1475
|
-
/** The identification type and identity data. */
|
|
1476
|
-
identity?: IdentificationData;
|
|
1477
|
-
}
|
|
1478
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
1479
|
-
/**
|
|
1480
|
-
* Unique event ID.
|
|
1481
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1482
|
-
*/
|
|
1483
|
-
_id?: string;
|
|
1484
|
-
/**
|
|
1485
|
-
* Assumes actions are also always typed to an entity_type
|
|
1486
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1487
|
-
*/
|
|
1488
|
-
entityFqdn?: string;
|
|
1489
|
-
/**
|
|
1490
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1491
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1492
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1493
|
-
*/
|
|
1494
|
-
slug?: string;
|
|
1495
|
-
/** ID of the entity associated with the event. */
|
|
1496
|
-
entityId?: string;
|
|
1497
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1498
|
-
eventTime?: Date | null;
|
|
1499
|
-
/**
|
|
1500
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1501
|
-
* (for example, GDPR).
|
|
1502
|
-
*/
|
|
1503
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1504
|
-
/** If present, indicates the action that triggered the event. */
|
|
1505
|
-
originatedFrom?: string | null;
|
|
1506
|
-
/**
|
|
1507
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
1508
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1509
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1510
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1511
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1512
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1513
|
-
*/
|
|
1514
|
-
entityEventSequence?: string | null;
|
|
1515
|
-
}
|
|
1516
|
-
interface MemberCreatedEnvelope {
|
|
1517
|
-
entity: Member;
|
|
1518
|
-
metadata: EventMetadata;
|
|
1519
|
-
}
|
|
1520
|
-
interface MemberDeletedEnvelope {
|
|
1521
|
-
metadata: EventMetadata;
|
|
1522
|
-
}
|
|
1523
|
-
interface MemberUpdatedEnvelope {
|
|
1524
|
-
entity: Member;
|
|
1525
|
-
metadata: EventMetadata;
|
|
1526
|
-
}
|
|
1527
|
-
interface GetCurrentMemberOptions {
|
|
1528
|
-
/**
|
|
1529
|
-
* Predefined set of fields to return.
|
|
1530
|
-
*
|
|
1531
|
-
* Default: `"PUBLIC"`.
|
|
1532
|
-
* @maxSize 3
|
|
1533
|
-
*/
|
|
1534
|
-
fieldsets?: Set[];
|
|
1535
|
-
}
|
|
1536
|
-
interface GetMemberOptions {
|
|
1537
|
-
/**
|
|
1538
|
-
* Predefined set of fields to return.
|
|
1539
|
-
*
|
|
1540
|
-
* Defaults to `"PUBLIC"`.
|
|
1541
|
-
* @maxSize 3
|
|
1542
|
-
*/
|
|
1543
|
-
fieldsets?: Set[];
|
|
1544
|
-
}
|
|
1545
|
-
interface ListMembersOptions {
|
|
1546
|
-
/** Paging options. */
|
|
1547
|
-
paging?: Paging;
|
|
1548
|
-
/**
|
|
1549
|
-
* Predefined sets of fields to return.
|
|
1550
|
-
*
|
|
1551
|
-
* Default: `"PUBLIC"`.
|
|
1552
|
-
* @maxSize 3
|
|
1553
|
-
*/
|
|
1554
|
-
fieldsets?: Set[];
|
|
1555
|
-
/** Sorting options. */
|
|
1556
|
-
sorting?: Sorting[];
|
|
1557
|
-
}
|
|
1558
|
-
interface QueryMembersOptions {
|
|
1559
|
-
/**
|
|
1560
|
-
* Predefined sets of fields to return.
|
|
1561
|
-
*
|
|
1562
|
-
* Default: `"PUBLIC"`.
|
|
1563
|
-
* @maxSize 3
|
|
1564
|
-
*/
|
|
1565
|
-
fieldsets?: Set[] | undefined;
|
|
1566
|
-
/** Plain text search. */
|
|
1567
|
-
search?: Search | undefined;
|
|
1568
|
-
}
|
|
1569
|
-
interface QueryOffsetResult {
|
|
1570
|
-
currentPage: number | undefined;
|
|
1571
|
-
totalPages: number | undefined;
|
|
1572
|
-
totalCount: number | undefined;
|
|
1573
|
-
hasNext: () => boolean;
|
|
1574
|
-
hasPrev: () => boolean;
|
|
1575
|
-
length: number;
|
|
1576
|
-
pageSize: number;
|
|
1577
|
-
}
|
|
1578
|
-
interface MembersQueryResult extends QueryOffsetResult {
|
|
1579
|
-
items: Member[];
|
|
1580
|
-
query: MembersQueryBuilder;
|
|
1581
|
-
next: () => Promise<MembersQueryResult>;
|
|
1582
|
-
prev: () => Promise<MembersQueryResult>;
|
|
1583
|
-
}
|
|
1584
|
-
interface MembersQueryBuilder {
|
|
1585
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
1586
|
-
* @param value - Value to compare against.
|
|
1587
|
-
*/
|
|
1588
|
-
eq: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
1589
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
1590
|
-
* @param value - Value to compare against.
|
|
1591
|
-
*/
|
|
1592
|
-
ne: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
1593
|
-
/** @param propertyName - Property whose value is compared with `string`.
|
|
1594
|
-
* @param string - String to compare against. Case-insensitive.
|
|
1595
|
-
*/
|
|
1596
|
-
startsWith: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: string) => MembersQueryBuilder;
|
|
1597
|
-
/** @param propertyName - Property whose value is compared with `values`.
|
|
1598
|
-
* @param values - List of values to compare against.
|
|
1599
|
-
*/
|
|
1600
|
-
hasSome: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any[]) => MembersQueryBuilder;
|
|
1601
|
-
in: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
1602
|
-
exists: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: boolean) => MembersQueryBuilder;
|
|
1603
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
1604
|
-
limit: (limit: number) => MembersQueryBuilder;
|
|
1605
|
-
/** @param skip - Number of items to skip in the query results before returning the results. */
|
|
1606
|
-
skip: (skip: number) => MembersQueryBuilder;
|
|
1607
|
-
find: () => Promise<MembersQueryResult>;
|
|
1608
|
-
}
|
|
1609
|
-
interface DeleteMyMemberOptions {
|
|
1610
|
-
/**
|
|
1611
|
-
* ID of a member receiving the deleted member's content.
|
|
1612
|
-
* @format GUID
|
|
1613
|
-
*/
|
|
1614
|
-
contentAssigneeId?: string | null;
|
|
1615
|
-
}
|
|
1616
|
-
interface BulkDeleteMembersByFilterOptions {
|
|
1617
|
-
/**
|
|
1618
|
-
* ID of a member receiving the deleted member's content.
|
|
1619
|
-
* @format GUID
|
|
1620
|
-
*/
|
|
1621
|
-
contentAssigneeId?: string | null;
|
|
1622
|
-
/** Plain text search. */
|
|
1623
|
-
search?: Search;
|
|
1624
|
-
}
|
|
1625
|
-
interface CreateMemberOptions {
|
|
1626
|
-
/** Member to create. */
|
|
1627
|
-
member?: Member;
|
|
1628
|
-
}
|
|
1629
|
-
interface UpdateMember {
|
|
1630
|
-
/**
|
|
1631
|
-
* Member ID.
|
|
1632
|
-
* @format GUID
|
|
1633
|
-
* @readonly
|
|
1634
|
-
*/
|
|
1635
|
-
_id?: string | null;
|
|
1636
|
-
/**
|
|
1637
|
-
* Email used by a member to log in to the site.
|
|
1638
|
-
* @format EMAIL
|
|
1639
|
-
*/
|
|
1640
|
-
loginEmail?: string | null;
|
|
1641
|
-
/**
|
|
1642
|
-
* Whether the email used by a member has been verified.
|
|
1643
|
-
* @readonly
|
|
1644
|
-
*/
|
|
1645
|
-
loginEmailVerified?: boolean | null;
|
|
1646
|
-
/**
|
|
1647
|
-
* Member site access status.
|
|
1648
|
-
* @readonly
|
|
1649
|
-
*/
|
|
1650
|
-
status?: Status;
|
|
1651
|
-
/**
|
|
1652
|
-
* Contact ID.
|
|
1653
|
-
* @format GUID
|
|
1654
|
-
* @readonly
|
|
1655
|
-
*/
|
|
1656
|
-
contactId?: string | null;
|
|
1657
|
-
/**
|
|
1658
|
-
* Member's contact information. Contact information is stored in the
|
|
1659
|
-
* [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).
|
|
1660
|
-
*
|
|
1661
|
-
* The full set of contact data can be accessed and managed with the
|
|
1662
|
-
* 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)).
|
|
1663
|
-
*/
|
|
1664
|
-
contact?: Contact;
|
|
1665
|
-
/** Profile display details. */
|
|
1666
|
-
profile?: Profile;
|
|
1667
|
-
/** Member privacy status. */
|
|
1668
|
-
privacyStatus?: PrivacyStatusStatus;
|
|
1669
|
-
/**
|
|
1670
|
-
* Member activity status.
|
|
1671
|
-
* @readonly
|
|
1672
|
-
*/
|
|
1673
|
-
activityStatus?: ActivityStatusStatus;
|
|
1674
|
-
/**
|
|
1675
|
-
* Date and time when the member was created.
|
|
1676
|
-
* @readonly
|
|
1677
|
-
*/
|
|
1678
|
-
_createdDate?: Date | null;
|
|
1679
|
-
/**
|
|
1680
|
-
* Date and time when the member was updated.
|
|
1681
|
-
* @readonly
|
|
1682
|
-
*/
|
|
1683
|
-
_updatedDate?: Date | null;
|
|
1684
|
-
/**
|
|
1685
|
-
* Date and time when the member last logged in to the site.
|
|
1686
|
-
* @readonly
|
|
1687
|
-
*/
|
|
1688
|
-
lastLoginDate?: Date | null;
|
|
1689
|
-
}
|
|
1690
|
-
|
|
1691
|
-
export { type SlugAlreadyExistsPayload as $, type ApproveMemberResponse as A, type BlockMemberResponse as B, type CreateMemberOptions as C, type DisconnectMemberResponse as D, type AddressStreetOneOf as E, type StreetAddress as F, type GetCurrentMemberOptions as G, type CustomField as H, type Profile as I, type JoinCommunityResponse as J, type Image as K, type LeaveCommunityResponse as L, type Member as M, Namespace as N, type ExtendedFields as O, PrivacyStatusStatus as P, type QueryMembersOptions as Q, type InvalidateCache as R, Status as S, type InvalidateCacheGetByOneOf as T, type UpdateMySlugResponse as U, type App as V, WebhookIdentityType as W, type Page as X, type URI as Y, type File as Z, type UpdateMySlugRequest as _, type UpdateMemberSlugResponse as a, type ActionEvent as a$, type UpdateMemberSlugRequest as a0, type JoinCommunityRequest as a1, type MemberJoinedCommunity as a2, type LeaveCommunityRequest as a3, type MemberLeftCommunity as a4, type GetMyMemberRequest as a5, type GetMemberRequest as a6, type GetMemberResponse as a7, type MemberToMemberBlockedPayload as a8, type ListMembersRequest as a9, type OwnerOrContributorDeleteForbiddenPayload as aA, type ActiveSubscriptionMemberDeleteForbiddenPayload as aB, type DeleteMyMemberRequest as aC, type DeleteMyMemberResponse as aD, type BulkDeleteMembersRequest as aE, type ItemMetadata as aF, type ApplicationError as aG, type BulkMemberResult as aH, type BulkActionMetadata as aI, type BulkDeleteMembersByFilterRequest as aJ, type BulkApproveMembersRequest as aK, type BulkBlockMembersRequest as aL, type CreateMemberRequest as aM, type CreateMemberResponse as aN, type UpdateMemberRequest as aO, type UpdateMemberResponse as aP, type InvalidCustomFieldUrlPayload as aQ, type DeleteMemberPhonesRequest as aR, type DeleteMemberEmailsRequest as aS, type DeleteMemberAddressesRequest as aT, type Empty as aU, type DomainEvent as aV, type DomainEventBodyOneOf as aW, type EntityCreatedEvent as aX, type RestoreInfo as aY, type EntityUpdatedEvent as aZ, type EntityDeletedEvent as a_, type Paging as aa, type Sorting as ab, type CursorPaging as ac, type PagingMetadata as ad, type CursorPagingMetadata as ae, type Cursors as af, type QueryMembersRequest as ag, type Query as ah, type Search as ai, type QueryMembersResponse as aj, type MuteMemberRequest as ak, type MemberMuted as al, type UnmuteMemberRequest as am, type MemberUnmuted as an, type ApproveMemberRequest as ao, type MemberApproved as ap, type BlockMemberRequest as aq, type MemberBlocked as ar, type MemberSelfBlockForbiddenPayload as as, type OwnerMemberBlockForbiddenPayload as at, type ActiveSubscriptionMemberBlockForbiddenPayload as au, type DisconnectMemberRequest as av, type DeleteMemberRequest as aw, type DeleteMemberResponse as ax, type ContentReassignmentRequested as ay, type ContentDeletionRequested as az, type GetMyMemberResponse as b, type MetaSiteSpecialEvent as b0, type MetaSiteSpecialEventPayloadOneOf as b1, type Asset as b2, type SiteCreated as b3, type SiteTransferred as b4, type SiteDeleted as b5, type DeleteContext as b6, type SiteUndeleted as b7, type SitePublished as b8, type SiteUnpublished as b9, type SiteMarkedAsTemplate as ba, type SiteMarkedAsWixSite as bb, type ServiceProvisioned as bc, type ServiceRemoved as bd, type SiteRenamed as be, type SiteHardDeleted as bf, type NamespaceChanged as bg, type StudioAssigned as bh, type StudioUnassigned as bi, type SiteUrlChanged as bj, type SitePurgedExternally as bk, type MemberOwnershipTransferred as bl, type MemberIdChanged as bm, type MessageEnvelope as bn, type IdentificationData as bo, type IdentificationDataIdOneOf as bp, type BaseEventMetadata as bq, type EventMetadata as br, type MemberCreatedEnvelope as bs, type MemberDeletedEnvelope as bt, type MemberUpdatedEnvelope as bu, type MembersQueryResult as bv, 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, ActivityStatusStatus as s, Set as t, SortOrder as u, State as v, SiteCreatedContext as w, DeleteStatus as x, type Contact as y, type Address as z };
|