@wix/groups 1.0.83 → 1.0.85
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/context/package.json +2 -1
- package/meta/package.json +2 -1
- package/package.json +19 -13
- package/type-bundles/context.bundle.d.ts +3154 -0
- package/type-bundles/index.bundle.d.ts +5110 -0
- package/type-bundles/meta.bundle.d.ts +4950 -0
|
@@ -0,0 +1,4950 @@
|
|
|
1
|
+
interface Group$5 {
|
|
2
|
+
/**
|
|
3
|
+
* Group ID.
|
|
4
|
+
* @readonly
|
|
5
|
+
*/
|
|
6
|
+
id?: string | null;
|
|
7
|
+
/** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */
|
|
8
|
+
slug?: string | null;
|
|
9
|
+
/**
|
|
10
|
+
* __Deprecated.__ Use `privacyStatus` instead.
|
|
11
|
+
* This property will be removed on June 30, 2022.
|
|
12
|
+
* @deprecated
|
|
13
|
+
*/
|
|
14
|
+
privacyLevel?: PrivacyStatus$5;
|
|
15
|
+
/**
|
|
16
|
+
* Group privacy status.
|
|
17
|
+
* - `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.
|
|
18
|
+
* - `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.
|
|
19
|
+
* - `SECRET` - Only admins and members can see the group. New members can only be added by other members.
|
|
20
|
+
*/
|
|
21
|
+
privacyStatus?: PrivacyStatus$5;
|
|
22
|
+
/**
|
|
23
|
+
* __Deprecated.__ Use `name` instead.
|
|
24
|
+
* This property will be removed on June 30, 2022.
|
|
25
|
+
* @deprecated
|
|
26
|
+
*/
|
|
27
|
+
title?: string | null;
|
|
28
|
+
/** Group name. */
|
|
29
|
+
name?: string | null;
|
|
30
|
+
/** Group description in DraftJS format. */
|
|
31
|
+
description?: string | null;
|
|
32
|
+
/** Group teaser. */
|
|
33
|
+
teaser?: string | null;
|
|
34
|
+
/**
|
|
35
|
+
* __Deprecated.__
|
|
36
|
+
* For `details.logo`, use `coverImage` instead.
|
|
37
|
+
* For `details.membersTitle`, `memberTitle` instead.
|
|
38
|
+
* This property will be removed on June 30, 2022.
|
|
39
|
+
* @deprecated
|
|
40
|
+
*/
|
|
41
|
+
details?: GroupDetails$5;
|
|
42
|
+
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
43
|
+
memberTitle?: string | null;
|
|
44
|
+
/** Cover image. You cannot upload your own cover image. */
|
|
45
|
+
coverImage?: CoverImage$5;
|
|
46
|
+
/** Group specific settings. Available to the site owners under `Admin Tools` in the dashboard. */
|
|
47
|
+
settings?: GroupSettings$5;
|
|
48
|
+
/**
|
|
49
|
+
* Total count of current group members.
|
|
50
|
+
* @readonly
|
|
51
|
+
*/
|
|
52
|
+
membersCount?: number | null;
|
|
53
|
+
/**
|
|
54
|
+
* __Deprecated.__ Use `ownerId` instead.
|
|
55
|
+
* This property will be removed on June 30, 2022.
|
|
56
|
+
* @readonly
|
|
57
|
+
* @deprecated
|
|
58
|
+
*/
|
|
59
|
+
createdBy?: Identity$5;
|
|
60
|
+
/**
|
|
61
|
+
* Group owner.
|
|
62
|
+
* @readonly
|
|
63
|
+
*/
|
|
64
|
+
ownerId?: string | null;
|
|
65
|
+
/**
|
|
66
|
+
* Group creation date and time.
|
|
67
|
+
* @readonly
|
|
68
|
+
*/
|
|
69
|
+
createdDate?: Date;
|
|
70
|
+
/**
|
|
71
|
+
* Date and time of the latest group update.
|
|
72
|
+
* @readonly
|
|
73
|
+
*/
|
|
74
|
+
updatedDate?: Date;
|
|
75
|
+
/**
|
|
76
|
+
* __Deprecated.__ Use `lastActivityDate` instead.
|
|
77
|
+
* This property will be removed on June 30, 2022.
|
|
78
|
+
* @readonly
|
|
79
|
+
* @deprecated
|
|
80
|
+
*/
|
|
81
|
+
recentActivityDate?: Date;
|
|
82
|
+
/**
|
|
83
|
+
* Date and time of the most recent group activity, for example a post or comment.
|
|
84
|
+
* @readonly
|
|
85
|
+
*/
|
|
86
|
+
lastActivityDate?: Date;
|
|
87
|
+
}
|
|
88
|
+
declare enum Type$2 {
|
|
89
|
+
UNKNOWN = "UNKNOWN",
|
|
90
|
+
ADMIN_APPROVAL = "ADMIN_APPROVAL",
|
|
91
|
+
PAID_PLANS = "PAID_PLANS",
|
|
92
|
+
EVENTS = "EVENTS"
|
|
93
|
+
}
|
|
94
|
+
interface Logo$5 {
|
|
95
|
+
/** Logo image ID (for internal use). */
|
|
96
|
+
mediaId?: string | null;
|
|
97
|
+
/** Logo image width. */
|
|
98
|
+
width?: number | null;
|
|
99
|
+
/** Logo image height. */
|
|
100
|
+
height?: number | null;
|
|
101
|
+
}
|
|
102
|
+
interface Image$5 {
|
|
103
|
+
/** Image ID (for internal use). */
|
|
104
|
+
mediaId?: string | null;
|
|
105
|
+
/** Image width. */
|
|
106
|
+
width?: number | null;
|
|
107
|
+
/** Image height. */
|
|
108
|
+
height?: number | null;
|
|
109
|
+
}
|
|
110
|
+
interface Position$5 {
|
|
111
|
+
/** horizontal coordinate */
|
|
112
|
+
x?: number;
|
|
113
|
+
/** vertical coordinate */
|
|
114
|
+
y?: number;
|
|
115
|
+
}
|
|
116
|
+
declare enum AllowPolicy$2 {
|
|
117
|
+
UNKNOWN = "UNKNOWN",
|
|
118
|
+
OWNER_AND_ADMINS = "OWNER_AND_ADMINS",
|
|
119
|
+
OWNER = "OWNER",
|
|
120
|
+
ALL_MEMBERS = "ALL_MEMBERS"
|
|
121
|
+
}
|
|
122
|
+
interface OnboardingStepSettings$5 {
|
|
123
|
+
stepKey?: StepKey$5;
|
|
124
|
+
visible?: boolean;
|
|
125
|
+
}
|
|
126
|
+
declare enum StepKey$5 {
|
|
127
|
+
UNKNOWN = "UNKNOWN",
|
|
128
|
+
CREATE_POST = "CREATE_POST",
|
|
129
|
+
REACT_TO_POST = "REACT_TO_POST",
|
|
130
|
+
INVITE_MEMBERS = "INVITE_MEMBERS"
|
|
131
|
+
}
|
|
132
|
+
declare enum PrivacyStatus$5 {
|
|
133
|
+
UNKNOWN = "UNKNOWN",
|
|
134
|
+
/** Anyone can see the group in the group list and view its content. Anyone can join. */
|
|
135
|
+
PUBLIC = "PUBLIC",
|
|
136
|
+
/** Anyone can see the group in the group list, but only group members can see its content. In order to join a group, a group join request must be submitted. */
|
|
137
|
+
PRIVATE = "PRIVATE",
|
|
138
|
+
/** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */
|
|
139
|
+
SECRET = "SECRET"
|
|
140
|
+
}
|
|
141
|
+
interface GroupDetails$5 {
|
|
142
|
+
/** Group logo. You cannot upload your own logo. */
|
|
143
|
+
logo?: Logo$5;
|
|
144
|
+
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
145
|
+
membersTitle?: string | null;
|
|
146
|
+
}
|
|
147
|
+
interface CoverImage$5 {
|
|
148
|
+
/** Cover image. */
|
|
149
|
+
image?: Image$5;
|
|
150
|
+
/** Position of the corner of the cover image (or logo). */
|
|
151
|
+
position?: Position$5;
|
|
152
|
+
/** Position of the corner of the cover image (or logo) for mobile browser. */
|
|
153
|
+
mobilePosition?: Position$5;
|
|
154
|
+
}
|
|
155
|
+
interface GroupSettings$5 {
|
|
156
|
+
/**
|
|
157
|
+
* __Deprecated.__ Use `allowedToInviteMembers` instead.
|
|
158
|
+
* Whether regular members are permitted to invite new members.
|
|
159
|
+
* If `false`, only admins can invite members. Defaults to `true`.
|
|
160
|
+
* @deprecated
|
|
161
|
+
*/
|
|
162
|
+
membersCanInvite?: boolean | null;
|
|
163
|
+
/**
|
|
164
|
+
* __Deprecated.__ Use `allowedToApproveJoinRequests` instead.
|
|
165
|
+
* Whether all group members are permitted to approve join group requests.
|
|
166
|
+
* If `false`, member approval is limited to the admins.
|
|
167
|
+
* @deprecated
|
|
168
|
+
*/
|
|
169
|
+
membersCanApprove?: boolean | null;
|
|
170
|
+
/**
|
|
171
|
+
* __Deprecated.__ Use `welcomeMemberPostEnabled` instead.
|
|
172
|
+
* This property will be removed on June 30, 2022.
|
|
173
|
+
* @deprecated
|
|
174
|
+
*/
|
|
175
|
+
memberWelcomePostEnabled?: boolean | null;
|
|
176
|
+
/** Whether a daily post about new members is enabled. */
|
|
177
|
+
welcomeMemberPostEnabled?: boolean | null;
|
|
178
|
+
/** Whether an automatic post about changing the group details is enabled. */
|
|
179
|
+
groupDetailsChangedPostEnabled?: boolean | null;
|
|
180
|
+
/** Whether all members can see the full member list. */
|
|
181
|
+
showMemberList?: boolean | null;
|
|
182
|
+
onboardingStepsSettings?: OnboardingStepSettings$5[];
|
|
183
|
+
}
|
|
184
|
+
interface Identity$5 {
|
|
185
|
+
/** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
186
|
+
id?: string | null;
|
|
187
|
+
identityType?: IdentityType$5;
|
|
188
|
+
}
|
|
189
|
+
declare enum IdentityType$5 {
|
|
190
|
+
USER = "USER",
|
|
191
|
+
MEMBER = "MEMBER"
|
|
192
|
+
}
|
|
193
|
+
interface CreateGroupRequest$1 {
|
|
194
|
+
/** Group to create. */
|
|
195
|
+
group: Group$5;
|
|
196
|
+
/** ID of the member who created the group. This member will automatically become an admin. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
197
|
+
creatorId?: string | null;
|
|
198
|
+
/** Content Type */
|
|
199
|
+
contentType?: ContentType$1;
|
|
200
|
+
}
|
|
201
|
+
declare enum ContentType$1 {
|
|
202
|
+
PLAIN_TEXT = "PLAIN_TEXT",
|
|
203
|
+
DRAFTJS = "DRAFTJS",
|
|
204
|
+
RICH_CONTENT = "RICH_CONTENT"
|
|
205
|
+
}
|
|
206
|
+
interface CreateGroupResponse$1 {
|
|
207
|
+
/** Created group. */
|
|
208
|
+
group?: Group$5;
|
|
209
|
+
}
|
|
210
|
+
interface UpdateGroupRequest$1 {
|
|
211
|
+
/** Group to update. */
|
|
212
|
+
group: Group$5;
|
|
213
|
+
/** Content Type */
|
|
214
|
+
contentType?: ContentType$1;
|
|
215
|
+
}
|
|
216
|
+
interface UpdateGroupResponse$1 {
|
|
217
|
+
/** Updated group. */
|
|
218
|
+
group?: Group$5;
|
|
219
|
+
}
|
|
220
|
+
interface DeleteGroupRequest$1 {
|
|
221
|
+
/** ID of the group to delete. */
|
|
222
|
+
groupId: string;
|
|
223
|
+
}
|
|
224
|
+
interface DeleteGroupResponse$1 {
|
|
225
|
+
/** Deleted group. */
|
|
226
|
+
group?: Group$5;
|
|
227
|
+
}
|
|
228
|
+
interface GetGroupRequest$1 {
|
|
229
|
+
/** ID of the group to retrieve. */
|
|
230
|
+
groupId: string;
|
|
231
|
+
/** Content type (PLAIN_TEXT returns content as it is) */
|
|
232
|
+
contentType?: ContentType$1;
|
|
233
|
+
}
|
|
234
|
+
interface GetGroupResponse$1 {
|
|
235
|
+
/** Retrieved group. */
|
|
236
|
+
group?: Group$5;
|
|
237
|
+
}
|
|
238
|
+
interface GetGroupBySlugRequest$1 {
|
|
239
|
+
/** Unique part of the group's URL, for example `group-1` in `https:/example.com/groups/group-1`. Pass only the slug. Case-sensitive. */
|
|
240
|
+
slug: string;
|
|
241
|
+
autoInviteId?: string | null;
|
|
242
|
+
/** Content type (PLAIN_TEXT returns content as it is) */
|
|
243
|
+
contentType?: ContentType$1;
|
|
244
|
+
}
|
|
245
|
+
interface GetGroupBySlugResponse$1 {
|
|
246
|
+
/** Retrieved group. */
|
|
247
|
+
group?: Group$5;
|
|
248
|
+
}
|
|
249
|
+
interface ListGroupsRequest$1 {
|
|
250
|
+
/** Number of items to load. Maximum `100`. */
|
|
251
|
+
limit?: number | null;
|
|
252
|
+
/** Number of items to skip in the current sort order. */
|
|
253
|
+
offset?: number | null;
|
|
254
|
+
/** Content type (PLAIN_TEXT returns content as it is) */
|
|
255
|
+
contentType?: ContentType$1;
|
|
256
|
+
}
|
|
257
|
+
interface ListGroupsResponse$1 {
|
|
258
|
+
/** Retrieved Groups. */
|
|
259
|
+
groups?: Group$5[];
|
|
260
|
+
metadata?: PagingMetadata$d;
|
|
261
|
+
}
|
|
262
|
+
interface PagingMetadata$d {
|
|
263
|
+
/** Number of items returned in the response. */
|
|
264
|
+
count?: number | null;
|
|
265
|
+
/** Offset that was requested. */
|
|
266
|
+
offset?: number | null;
|
|
267
|
+
/** Total number of items that match the query. */
|
|
268
|
+
total?: number | null;
|
|
269
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
270
|
+
tooManyToCount?: boolean | null;
|
|
271
|
+
}
|
|
272
|
+
interface QueryGroupsRequest$1 {
|
|
273
|
+
query?: Query$b;
|
|
274
|
+
/** Content type (PLAIN_TEXT returns content as it is) */
|
|
275
|
+
contentType?: ContentType$1;
|
|
276
|
+
}
|
|
277
|
+
interface Query$b {
|
|
278
|
+
/**
|
|
279
|
+
* Filter object in the following format:
|
|
280
|
+
* `"filter" : {
|
|
281
|
+
* "fieldName1": "value1",
|
|
282
|
+
* "fieldName2":{"$operator":"value2"}
|
|
283
|
+
* }`
|
|
284
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
285
|
+
*/
|
|
286
|
+
filter?: any;
|
|
287
|
+
/**
|
|
288
|
+
* Sort object in the following format:
|
|
289
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
290
|
+
*/
|
|
291
|
+
sort?: Sorting$b[];
|
|
292
|
+
/** Paging options to limit and skip the number of items. */
|
|
293
|
+
paging?: Paging$d;
|
|
294
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
295
|
+
fields?: string[];
|
|
296
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
297
|
+
fieldsets?: string[];
|
|
298
|
+
}
|
|
299
|
+
interface Sorting$b {
|
|
300
|
+
/** Name of the field to sort by. */
|
|
301
|
+
fieldName?: string;
|
|
302
|
+
/** Sort order. */
|
|
303
|
+
order?: SortOrder$b;
|
|
304
|
+
}
|
|
305
|
+
declare enum SortOrder$b {
|
|
306
|
+
ASC = "ASC",
|
|
307
|
+
DESC = "DESC"
|
|
308
|
+
}
|
|
309
|
+
interface Paging$d {
|
|
310
|
+
/** Number of items to load. */
|
|
311
|
+
limit?: number | null;
|
|
312
|
+
/** Number of items to skip in the current sort order. */
|
|
313
|
+
offset?: number | null;
|
|
314
|
+
}
|
|
315
|
+
interface QueryGroupsResponse$1 {
|
|
316
|
+
/** Retrieved groups. */
|
|
317
|
+
groups?: Group$5[];
|
|
318
|
+
metadata?: PagingMetadata$d;
|
|
319
|
+
}
|
|
320
|
+
interface CreateGroupResponseNonNullableFields$1 {
|
|
321
|
+
group?: {
|
|
322
|
+
privacyLevel: PrivacyStatus$5;
|
|
323
|
+
privacyStatus: PrivacyStatus$5;
|
|
324
|
+
accessRestriction?: {
|
|
325
|
+
events?: {
|
|
326
|
+
eventIds: string[];
|
|
327
|
+
};
|
|
328
|
+
type: Type$2;
|
|
329
|
+
};
|
|
330
|
+
details?: {
|
|
331
|
+
logoPosition?: {
|
|
332
|
+
x: number;
|
|
333
|
+
y: number;
|
|
334
|
+
};
|
|
335
|
+
mobileLogoPosition?: {
|
|
336
|
+
x: number;
|
|
337
|
+
y: number;
|
|
338
|
+
};
|
|
339
|
+
};
|
|
340
|
+
coverImage?: {
|
|
341
|
+
position?: {
|
|
342
|
+
x: number;
|
|
343
|
+
y: number;
|
|
344
|
+
};
|
|
345
|
+
mobilePosition?: {
|
|
346
|
+
x: number;
|
|
347
|
+
y: number;
|
|
348
|
+
};
|
|
349
|
+
};
|
|
350
|
+
settings?: {
|
|
351
|
+
allowedToInviteMembers: AllowPolicy$2;
|
|
352
|
+
allowedToApproveJoinRequests: AllowPolicy$2;
|
|
353
|
+
allowedToAddMembers: AllowPolicy$2;
|
|
354
|
+
allowedToCreatePosts: AllowPolicy$2;
|
|
355
|
+
allowedToCommentPosts: AllowPolicy$2;
|
|
356
|
+
onboardingStepsSettings: {
|
|
357
|
+
stepKey: StepKey$5;
|
|
358
|
+
visible: boolean;
|
|
359
|
+
}[];
|
|
360
|
+
};
|
|
361
|
+
createdBy?: {
|
|
362
|
+
identityType: IdentityType$5;
|
|
363
|
+
};
|
|
364
|
+
};
|
|
365
|
+
}
|
|
366
|
+
interface UpdateGroupResponseNonNullableFields$1 {
|
|
367
|
+
group?: {
|
|
368
|
+
privacyLevel: PrivacyStatus$5;
|
|
369
|
+
privacyStatus: PrivacyStatus$5;
|
|
370
|
+
accessRestriction?: {
|
|
371
|
+
events?: {
|
|
372
|
+
eventIds: string[];
|
|
373
|
+
};
|
|
374
|
+
type: Type$2;
|
|
375
|
+
};
|
|
376
|
+
details?: {
|
|
377
|
+
logoPosition?: {
|
|
378
|
+
x: number;
|
|
379
|
+
y: number;
|
|
380
|
+
};
|
|
381
|
+
mobileLogoPosition?: {
|
|
382
|
+
x: number;
|
|
383
|
+
y: number;
|
|
384
|
+
};
|
|
385
|
+
};
|
|
386
|
+
coverImage?: {
|
|
387
|
+
position?: {
|
|
388
|
+
x: number;
|
|
389
|
+
y: number;
|
|
390
|
+
};
|
|
391
|
+
mobilePosition?: {
|
|
392
|
+
x: number;
|
|
393
|
+
y: number;
|
|
394
|
+
};
|
|
395
|
+
};
|
|
396
|
+
settings?: {
|
|
397
|
+
allowedToInviteMembers: AllowPolicy$2;
|
|
398
|
+
allowedToApproveJoinRequests: AllowPolicy$2;
|
|
399
|
+
allowedToAddMembers: AllowPolicy$2;
|
|
400
|
+
allowedToCreatePosts: AllowPolicy$2;
|
|
401
|
+
allowedToCommentPosts: AllowPolicy$2;
|
|
402
|
+
onboardingStepsSettings: {
|
|
403
|
+
stepKey: StepKey$5;
|
|
404
|
+
visible: boolean;
|
|
405
|
+
}[];
|
|
406
|
+
};
|
|
407
|
+
createdBy?: {
|
|
408
|
+
identityType: IdentityType$5;
|
|
409
|
+
};
|
|
410
|
+
};
|
|
411
|
+
}
|
|
412
|
+
interface DeleteGroupResponseNonNullableFields$1 {
|
|
413
|
+
group?: {
|
|
414
|
+
privacyLevel: PrivacyStatus$5;
|
|
415
|
+
privacyStatus: PrivacyStatus$5;
|
|
416
|
+
accessRestriction?: {
|
|
417
|
+
events?: {
|
|
418
|
+
eventIds: string[];
|
|
419
|
+
};
|
|
420
|
+
type: Type$2;
|
|
421
|
+
};
|
|
422
|
+
details?: {
|
|
423
|
+
logoPosition?: {
|
|
424
|
+
x: number;
|
|
425
|
+
y: number;
|
|
426
|
+
};
|
|
427
|
+
mobileLogoPosition?: {
|
|
428
|
+
x: number;
|
|
429
|
+
y: number;
|
|
430
|
+
};
|
|
431
|
+
};
|
|
432
|
+
coverImage?: {
|
|
433
|
+
position?: {
|
|
434
|
+
x: number;
|
|
435
|
+
y: number;
|
|
436
|
+
};
|
|
437
|
+
mobilePosition?: {
|
|
438
|
+
x: number;
|
|
439
|
+
y: number;
|
|
440
|
+
};
|
|
441
|
+
};
|
|
442
|
+
settings?: {
|
|
443
|
+
allowedToInviteMembers: AllowPolicy$2;
|
|
444
|
+
allowedToApproveJoinRequests: AllowPolicy$2;
|
|
445
|
+
allowedToAddMembers: AllowPolicy$2;
|
|
446
|
+
allowedToCreatePosts: AllowPolicy$2;
|
|
447
|
+
allowedToCommentPosts: AllowPolicy$2;
|
|
448
|
+
onboardingStepsSettings: {
|
|
449
|
+
stepKey: StepKey$5;
|
|
450
|
+
visible: boolean;
|
|
451
|
+
}[];
|
|
452
|
+
};
|
|
453
|
+
createdBy?: {
|
|
454
|
+
identityType: IdentityType$5;
|
|
455
|
+
};
|
|
456
|
+
};
|
|
457
|
+
}
|
|
458
|
+
interface GetGroupResponseNonNullableFields$1 {
|
|
459
|
+
group?: {
|
|
460
|
+
privacyLevel: PrivacyStatus$5;
|
|
461
|
+
privacyStatus: PrivacyStatus$5;
|
|
462
|
+
accessRestriction?: {
|
|
463
|
+
events?: {
|
|
464
|
+
eventIds: string[];
|
|
465
|
+
};
|
|
466
|
+
type: Type$2;
|
|
467
|
+
};
|
|
468
|
+
details?: {
|
|
469
|
+
logoPosition?: {
|
|
470
|
+
x: number;
|
|
471
|
+
y: number;
|
|
472
|
+
};
|
|
473
|
+
mobileLogoPosition?: {
|
|
474
|
+
x: number;
|
|
475
|
+
y: number;
|
|
476
|
+
};
|
|
477
|
+
};
|
|
478
|
+
coverImage?: {
|
|
479
|
+
position?: {
|
|
480
|
+
x: number;
|
|
481
|
+
y: number;
|
|
482
|
+
};
|
|
483
|
+
mobilePosition?: {
|
|
484
|
+
x: number;
|
|
485
|
+
y: number;
|
|
486
|
+
};
|
|
487
|
+
};
|
|
488
|
+
settings?: {
|
|
489
|
+
allowedToInviteMembers: AllowPolicy$2;
|
|
490
|
+
allowedToApproveJoinRequests: AllowPolicy$2;
|
|
491
|
+
allowedToAddMembers: AllowPolicy$2;
|
|
492
|
+
allowedToCreatePosts: AllowPolicy$2;
|
|
493
|
+
allowedToCommentPosts: AllowPolicy$2;
|
|
494
|
+
onboardingStepsSettings: {
|
|
495
|
+
stepKey: StepKey$5;
|
|
496
|
+
visible: boolean;
|
|
497
|
+
}[];
|
|
498
|
+
};
|
|
499
|
+
createdBy?: {
|
|
500
|
+
identityType: IdentityType$5;
|
|
501
|
+
};
|
|
502
|
+
};
|
|
503
|
+
}
|
|
504
|
+
interface GetGroupBySlugResponseNonNullableFields$1 {
|
|
505
|
+
group?: {
|
|
506
|
+
privacyLevel: PrivacyStatus$5;
|
|
507
|
+
privacyStatus: PrivacyStatus$5;
|
|
508
|
+
accessRestriction?: {
|
|
509
|
+
events?: {
|
|
510
|
+
eventIds: string[];
|
|
511
|
+
};
|
|
512
|
+
type: Type$2;
|
|
513
|
+
};
|
|
514
|
+
details?: {
|
|
515
|
+
logoPosition?: {
|
|
516
|
+
x: number;
|
|
517
|
+
y: number;
|
|
518
|
+
};
|
|
519
|
+
mobileLogoPosition?: {
|
|
520
|
+
x: number;
|
|
521
|
+
y: number;
|
|
522
|
+
};
|
|
523
|
+
};
|
|
524
|
+
coverImage?: {
|
|
525
|
+
position?: {
|
|
526
|
+
x: number;
|
|
527
|
+
y: number;
|
|
528
|
+
};
|
|
529
|
+
mobilePosition?: {
|
|
530
|
+
x: number;
|
|
531
|
+
y: number;
|
|
532
|
+
};
|
|
533
|
+
};
|
|
534
|
+
settings?: {
|
|
535
|
+
allowedToInviteMembers: AllowPolicy$2;
|
|
536
|
+
allowedToApproveJoinRequests: AllowPolicy$2;
|
|
537
|
+
allowedToAddMembers: AllowPolicy$2;
|
|
538
|
+
allowedToCreatePosts: AllowPolicy$2;
|
|
539
|
+
allowedToCommentPosts: AllowPolicy$2;
|
|
540
|
+
onboardingStepsSettings: {
|
|
541
|
+
stepKey: StepKey$5;
|
|
542
|
+
visible: boolean;
|
|
543
|
+
}[];
|
|
544
|
+
};
|
|
545
|
+
createdBy?: {
|
|
546
|
+
identityType: IdentityType$5;
|
|
547
|
+
};
|
|
548
|
+
};
|
|
549
|
+
}
|
|
550
|
+
interface ListGroupsResponseNonNullableFields$1 {
|
|
551
|
+
groups: {
|
|
552
|
+
privacyLevel: PrivacyStatus$5;
|
|
553
|
+
privacyStatus: PrivacyStatus$5;
|
|
554
|
+
accessRestriction?: {
|
|
555
|
+
events?: {
|
|
556
|
+
eventIds: string[];
|
|
557
|
+
};
|
|
558
|
+
type: Type$2;
|
|
559
|
+
};
|
|
560
|
+
details?: {
|
|
561
|
+
logoPosition?: {
|
|
562
|
+
x: number;
|
|
563
|
+
y: number;
|
|
564
|
+
};
|
|
565
|
+
mobileLogoPosition?: {
|
|
566
|
+
x: number;
|
|
567
|
+
y: number;
|
|
568
|
+
};
|
|
569
|
+
};
|
|
570
|
+
coverImage?: {
|
|
571
|
+
position?: {
|
|
572
|
+
x: number;
|
|
573
|
+
y: number;
|
|
574
|
+
};
|
|
575
|
+
mobilePosition?: {
|
|
576
|
+
x: number;
|
|
577
|
+
y: number;
|
|
578
|
+
};
|
|
579
|
+
};
|
|
580
|
+
settings?: {
|
|
581
|
+
allowedToInviteMembers: AllowPolicy$2;
|
|
582
|
+
allowedToApproveJoinRequests: AllowPolicy$2;
|
|
583
|
+
allowedToAddMembers: AllowPolicy$2;
|
|
584
|
+
allowedToCreatePosts: AllowPolicy$2;
|
|
585
|
+
allowedToCommentPosts: AllowPolicy$2;
|
|
586
|
+
onboardingStepsSettings: {
|
|
587
|
+
stepKey: StepKey$5;
|
|
588
|
+
visible: boolean;
|
|
589
|
+
}[];
|
|
590
|
+
};
|
|
591
|
+
createdBy?: {
|
|
592
|
+
identityType: IdentityType$5;
|
|
593
|
+
};
|
|
594
|
+
}[];
|
|
595
|
+
}
|
|
596
|
+
interface QueryGroupsResponseNonNullableFields$1 {
|
|
597
|
+
groups: {
|
|
598
|
+
privacyLevel: PrivacyStatus$5;
|
|
599
|
+
privacyStatus: PrivacyStatus$5;
|
|
600
|
+
accessRestriction?: {
|
|
601
|
+
events?: {
|
|
602
|
+
eventIds: string[];
|
|
603
|
+
};
|
|
604
|
+
type: Type$2;
|
|
605
|
+
};
|
|
606
|
+
details?: {
|
|
607
|
+
logoPosition?: {
|
|
608
|
+
x: number;
|
|
609
|
+
y: number;
|
|
610
|
+
};
|
|
611
|
+
mobileLogoPosition?: {
|
|
612
|
+
x: number;
|
|
613
|
+
y: number;
|
|
614
|
+
};
|
|
615
|
+
};
|
|
616
|
+
coverImage?: {
|
|
617
|
+
position?: {
|
|
618
|
+
x: number;
|
|
619
|
+
y: number;
|
|
620
|
+
};
|
|
621
|
+
mobilePosition?: {
|
|
622
|
+
x: number;
|
|
623
|
+
y: number;
|
|
624
|
+
};
|
|
625
|
+
};
|
|
626
|
+
settings?: {
|
|
627
|
+
allowedToInviteMembers: AllowPolicy$2;
|
|
628
|
+
allowedToApproveJoinRequests: AllowPolicy$2;
|
|
629
|
+
allowedToAddMembers: AllowPolicy$2;
|
|
630
|
+
allowedToCreatePosts: AllowPolicy$2;
|
|
631
|
+
allowedToCommentPosts: AllowPolicy$2;
|
|
632
|
+
onboardingStepsSettings: {
|
|
633
|
+
stepKey: StepKey$5;
|
|
634
|
+
visible: boolean;
|
|
635
|
+
}[];
|
|
636
|
+
};
|
|
637
|
+
createdBy?: {
|
|
638
|
+
identityType: IdentityType$5;
|
|
639
|
+
};
|
|
640
|
+
}[];
|
|
641
|
+
}
|
|
642
|
+
|
|
643
|
+
interface Group$4 {
|
|
644
|
+
/**
|
|
645
|
+
* Group ID.
|
|
646
|
+
* @readonly
|
|
647
|
+
*/
|
|
648
|
+
_id?: string | null;
|
|
649
|
+
/** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */
|
|
650
|
+
slug?: string | null;
|
|
651
|
+
/**
|
|
652
|
+
* @internal
|
|
653
|
+
* @internal
|
|
654
|
+
* @deprecated
|
|
655
|
+
*/
|
|
656
|
+
privacyLevel?: PrivacyStatus$4;
|
|
657
|
+
/**
|
|
658
|
+
* Group privacy status.
|
|
659
|
+
* - `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.
|
|
660
|
+
* - `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.
|
|
661
|
+
* - `SECRET` - Only admins and members can see the group. New members can only be added by other members.
|
|
662
|
+
*/
|
|
663
|
+
privacyStatus?: PrivacyStatus$4;
|
|
664
|
+
/**
|
|
665
|
+
* @internal
|
|
666
|
+
* @internal
|
|
667
|
+
* @deprecated
|
|
668
|
+
*/
|
|
669
|
+
title?: string | null;
|
|
670
|
+
/** Group name. */
|
|
671
|
+
name?: string | null;
|
|
672
|
+
/** Group description in DraftJS format. */
|
|
673
|
+
description?: string | null;
|
|
674
|
+
/** Group teaser. */
|
|
675
|
+
teaser?: string | null;
|
|
676
|
+
/**
|
|
677
|
+
* @internal
|
|
678
|
+
* @internal
|
|
679
|
+
* @deprecated
|
|
680
|
+
*/
|
|
681
|
+
details?: GroupDetails$4;
|
|
682
|
+
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
683
|
+
memberTitle?: string | null;
|
|
684
|
+
/** Cover image. You cannot upload your own cover image. */
|
|
685
|
+
coverImage?: CoverImage$4;
|
|
686
|
+
/** Group specific settings. Available to the site owners under `Admin Tools` in the dashboard. */
|
|
687
|
+
settings?: GroupSettings$4;
|
|
688
|
+
/**
|
|
689
|
+
* Total count of current group members.
|
|
690
|
+
* @readonly
|
|
691
|
+
*/
|
|
692
|
+
membersCount?: number | null;
|
|
693
|
+
/**
|
|
694
|
+
* @internal
|
|
695
|
+
* @internal
|
|
696
|
+
* @readonly
|
|
697
|
+
* @deprecated
|
|
698
|
+
*/
|
|
699
|
+
createdBy?: Identity$4;
|
|
700
|
+
/**
|
|
701
|
+
* Group owner.
|
|
702
|
+
* @readonly
|
|
703
|
+
*/
|
|
704
|
+
ownerId?: string | null;
|
|
705
|
+
/**
|
|
706
|
+
* Group creation date and time.
|
|
707
|
+
* @readonly
|
|
708
|
+
*/
|
|
709
|
+
_createdDate?: Date;
|
|
710
|
+
/**
|
|
711
|
+
* Date and time of the latest group update.
|
|
712
|
+
* @readonly
|
|
713
|
+
*/
|
|
714
|
+
_updatedDate?: Date;
|
|
715
|
+
/**
|
|
716
|
+
* @internal
|
|
717
|
+
* @internal
|
|
718
|
+
* @readonly
|
|
719
|
+
* @deprecated
|
|
720
|
+
*/
|
|
721
|
+
recentActivityDate?: Date;
|
|
722
|
+
/**
|
|
723
|
+
* Date and time of the most recent group activity, for example a post or comment.
|
|
724
|
+
* @readonly
|
|
725
|
+
*/
|
|
726
|
+
lastActivityDate?: Date;
|
|
727
|
+
}
|
|
728
|
+
interface Logo$4 {
|
|
729
|
+
/** Logo image ID (for internal use). */
|
|
730
|
+
mediaId?: string | null;
|
|
731
|
+
/** Logo image width. */
|
|
732
|
+
width?: number | null;
|
|
733
|
+
/** Logo image height. */
|
|
734
|
+
height?: number | null;
|
|
735
|
+
}
|
|
736
|
+
interface Image$4 {
|
|
737
|
+
/** Image ID (for internal use). */
|
|
738
|
+
mediaId?: string | null;
|
|
739
|
+
/** Image width. */
|
|
740
|
+
width?: number | null;
|
|
741
|
+
/** Image height. */
|
|
742
|
+
height?: number | null;
|
|
743
|
+
}
|
|
744
|
+
interface Position$4 {
|
|
745
|
+
/** horizontal coordinate */
|
|
746
|
+
x?: number;
|
|
747
|
+
/** vertical coordinate */
|
|
748
|
+
y?: number;
|
|
749
|
+
}
|
|
750
|
+
interface OnboardingStepSettings$4 {
|
|
751
|
+
stepKey?: StepKey$4;
|
|
752
|
+
visible?: boolean;
|
|
753
|
+
}
|
|
754
|
+
declare enum StepKey$4 {
|
|
755
|
+
UNKNOWN = "UNKNOWN",
|
|
756
|
+
CREATE_POST = "CREATE_POST",
|
|
757
|
+
REACT_TO_POST = "REACT_TO_POST",
|
|
758
|
+
INVITE_MEMBERS = "INVITE_MEMBERS"
|
|
759
|
+
}
|
|
760
|
+
declare enum PrivacyStatus$4 {
|
|
761
|
+
UNKNOWN = "UNKNOWN",
|
|
762
|
+
/** Anyone can see the group in the group list and view its content. Anyone can join. */
|
|
763
|
+
PUBLIC = "PUBLIC",
|
|
764
|
+
/** Anyone can see the group in the group list, but only group members can see its content. In order to join a group, a group join request must be submitted. */
|
|
765
|
+
PRIVATE = "PRIVATE",
|
|
766
|
+
/** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */
|
|
767
|
+
SECRET = "SECRET"
|
|
768
|
+
}
|
|
769
|
+
interface GroupDetails$4 {
|
|
770
|
+
/** Group logo. You cannot upload your own logo. */
|
|
771
|
+
logo?: Logo$4;
|
|
772
|
+
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
773
|
+
membersTitle?: string | null;
|
|
774
|
+
}
|
|
775
|
+
interface CoverImage$4 {
|
|
776
|
+
/** Cover image. */
|
|
777
|
+
image?: Image$4;
|
|
778
|
+
/** Position of the corner of the cover image (or logo). */
|
|
779
|
+
position?: Position$4;
|
|
780
|
+
/** Position of the corner of the cover image (or logo) for mobile browser. */
|
|
781
|
+
mobilePosition?: Position$4;
|
|
782
|
+
}
|
|
783
|
+
interface GroupSettings$4 {
|
|
784
|
+
/**
|
|
785
|
+
* __Deprecated.__ Use `allowedToInviteMembers` instead.
|
|
786
|
+
* Whether regular members are permitted to invite new members.
|
|
787
|
+
* If `false`, only admins can invite members. Defaults to `true`.
|
|
788
|
+
* @deprecated
|
|
789
|
+
*/
|
|
790
|
+
membersCanInvite?: boolean | null;
|
|
791
|
+
/**
|
|
792
|
+
* __Deprecated.__ Use `allowedToApproveJoinRequests` instead.
|
|
793
|
+
* Whether all group members are permitted to approve join group requests.
|
|
794
|
+
* If `false`, member approval is limited to the admins.
|
|
795
|
+
* @deprecated
|
|
796
|
+
*/
|
|
797
|
+
membersCanApprove?: boolean | null;
|
|
798
|
+
/**
|
|
799
|
+
* @internal
|
|
800
|
+
* @internal
|
|
801
|
+
* @deprecated
|
|
802
|
+
*/
|
|
803
|
+
memberWelcomePostEnabled?: boolean | null;
|
|
804
|
+
/** Whether a daily post about new members is enabled. */
|
|
805
|
+
welcomeMemberPostEnabled?: boolean | null;
|
|
806
|
+
/** Whether an automatic post about changing the group details is enabled. */
|
|
807
|
+
groupDetailsChangedPostEnabled?: boolean | null;
|
|
808
|
+
/** Whether all members can see the full member list. */
|
|
809
|
+
showMemberList?: boolean | null;
|
|
810
|
+
onboardingStepsSettings?: OnboardingStepSettings$4[];
|
|
811
|
+
}
|
|
812
|
+
interface Identity$4 {
|
|
813
|
+
/** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
814
|
+
_id?: string | null;
|
|
815
|
+
identityType?: IdentityType$4;
|
|
816
|
+
}
|
|
817
|
+
declare enum IdentityType$4 {
|
|
818
|
+
USER = "USER",
|
|
819
|
+
MEMBER = "MEMBER"
|
|
820
|
+
}
|
|
821
|
+
interface CreateGroupRequest {
|
|
822
|
+
/** Group to create. */
|
|
823
|
+
group: Group$4;
|
|
824
|
+
/** ID of the member who created the group. This member will automatically become an admin. */
|
|
825
|
+
creatorId?: string | null;
|
|
826
|
+
/** Content Type */
|
|
827
|
+
contentType?: ContentType;
|
|
828
|
+
}
|
|
829
|
+
declare enum ContentType {
|
|
830
|
+
PLAIN_TEXT = "PLAIN_TEXT",
|
|
831
|
+
DRAFTJS = "DRAFTJS",
|
|
832
|
+
RICH_CONTENT = "RICH_CONTENT"
|
|
833
|
+
}
|
|
834
|
+
interface CreateGroupResponse {
|
|
835
|
+
/** Created group. */
|
|
836
|
+
group?: Group$4;
|
|
837
|
+
}
|
|
838
|
+
interface UpdateGroupRequest {
|
|
839
|
+
/** Group to update. */
|
|
840
|
+
group: Group$4;
|
|
841
|
+
/** Content Type */
|
|
842
|
+
contentType?: ContentType;
|
|
843
|
+
}
|
|
844
|
+
interface UpdateGroupResponse {
|
|
845
|
+
/** Updated group. */
|
|
846
|
+
group?: Group$4;
|
|
847
|
+
}
|
|
848
|
+
interface DeleteGroupRequest {
|
|
849
|
+
/** ID of the group to delete. */
|
|
850
|
+
groupId: string;
|
|
851
|
+
}
|
|
852
|
+
interface DeleteGroupResponse {
|
|
853
|
+
/** Deleted group. */
|
|
854
|
+
group?: Group$4;
|
|
855
|
+
}
|
|
856
|
+
interface GetGroupRequest {
|
|
857
|
+
/** ID of the group to retrieve. */
|
|
858
|
+
groupId: string;
|
|
859
|
+
/** Content type (PLAIN_TEXT returns content as it is) */
|
|
860
|
+
contentType?: ContentType;
|
|
861
|
+
}
|
|
862
|
+
interface GetGroupResponse {
|
|
863
|
+
/** Retrieved group. */
|
|
864
|
+
group?: Group$4;
|
|
865
|
+
}
|
|
866
|
+
interface GetGroupBySlugRequest {
|
|
867
|
+
/** Unique part of the group's URL, for example `group-1` in `https:/example.com/groups/group-1`. Pass only the slug. Case-sensitive. */
|
|
868
|
+
slug: string;
|
|
869
|
+
autoInviteId?: string | null;
|
|
870
|
+
/** Content type (PLAIN_TEXT returns content as it is) */
|
|
871
|
+
contentType?: ContentType;
|
|
872
|
+
}
|
|
873
|
+
interface GetGroupBySlugResponse {
|
|
874
|
+
/** Retrieved group. */
|
|
875
|
+
group?: Group$4;
|
|
876
|
+
}
|
|
877
|
+
interface ListGroupsRequest {
|
|
878
|
+
/** Number of items to load. Maximum `100`. */
|
|
879
|
+
limit?: number | null;
|
|
880
|
+
/** Number of items to skip in the current sort order. */
|
|
881
|
+
offset?: number | null;
|
|
882
|
+
/** Content type (PLAIN_TEXT returns content as it is) */
|
|
883
|
+
contentType?: ContentType;
|
|
884
|
+
}
|
|
885
|
+
interface ListGroupsResponse {
|
|
886
|
+
/** Retrieved Groups. */
|
|
887
|
+
groups?: Group$4[];
|
|
888
|
+
metadata?: PagingMetadata$c;
|
|
889
|
+
}
|
|
890
|
+
interface PagingMetadata$c {
|
|
891
|
+
/** Number of items returned in the response. */
|
|
892
|
+
count?: number | null;
|
|
893
|
+
/** Offset that was requested. */
|
|
894
|
+
offset?: number | null;
|
|
895
|
+
/** Total number of items that match the query. */
|
|
896
|
+
total?: number | null;
|
|
897
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
898
|
+
tooManyToCount?: boolean | null;
|
|
899
|
+
}
|
|
900
|
+
interface QueryGroupsRequest {
|
|
901
|
+
query?: Query$a;
|
|
902
|
+
/** Content type (PLAIN_TEXT returns content as it is) */
|
|
903
|
+
contentType?: ContentType;
|
|
904
|
+
}
|
|
905
|
+
interface Query$a {
|
|
906
|
+
/**
|
|
907
|
+
* Filter object in the following format:
|
|
908
|
+
* `"filter" : {
|
|
909
|
+
* "fieldName1": "value1",
|
|
910
|
+
* "fieldName2":{"$operator":"value2"}
|
|
911
|
+
* }`
|
|
912
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
913
|
+
*/
|
|
914
|
+
filter?: any;
|
|
915
|
+
/**
|
|
916
|
+
* Sort object in the following format:
|
|
917
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
918
|
+
*/
|
|
919
|
+
sort?: Sorting$a[];
|
|
920
|
+
/** Paging options to limit and skip the number of items. */
|
|
921
|
+
paging?: Paging$c;
|
|
922
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
923
|
+
fields?: string[];
|
|
924
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
925
|
+
fieldsets?: string[];
|
|
926
|
+
}
|
|
927
|
+
interface Sorting$a {
|
|
928
|
+
/** Name of the field to sort by. */
|
|
929
|
+
fieldName?: string;
|
|
930
|
+
/** Sort order. */
|
|
931
|
+
order?: SortOrder$a;
|
|
932
|
+
}
|
|
933
|
+
declare enum SortOrder$a {
|
|
934
|
+
ASC = "ASC",
|
|
935
|
+
DESC = "DESC"
|
|
936
|
+
}
|
|
937
|
+
interface Paging$c {
|
|
938
|
+
/** Number of items to load. */
|
|
939
|
+
limit?: number | null;
|
|
940
|
+
/** Number of items to skip in the current sort order. */
|
|
941
|
+
offset?: number | null;
|
|
942
|
+
}
|
|
943
|
+
interface QueryGroupsResponse {
|
|
944
|
+
/** Retrieved groups. */
|
|
945
|
+
groups?: Group$4[];
|
|
946
|
+
metadata?: PagingMetadata$c;
|
|
947
|
+
}
|
|
948
|
+
interface CreateGroupResponseNonNullableFields {
|
|
949
|
+
group?: {
|
|
950
|
+
privacyLevel: PrivacyStatus$4;
|
|
951
|
+
privacyStatus: PrivacyStatus$4;
|
|
952
|
+
coverImage?: {
|
|
953
|
+
position?: {
|
|
954
|
+
x: number;
|
|
955
|
+
y: number;
|
|
956
|
+
};
|
|
957
|
+
mobilePosition?: {
|
|
958
|
+
x: number;
|
|
959
|
+
y: number;
|
|
960
|
+
};
|
|
961
|
+
};
|
|
962
|
+
settings?: {
|
|
963
|
+
onboardingStepsSettings: {
|
|
964
|
+
stepKey: StepKey$4;
|
|
965
|
+
visible: boolean;
|
|
966
|
+
}[];
|
|
967
|
+
};
|
|
968
|
+
createdBy?: {
|
|
969
|
+
identityType: IdentityType$4;
|
|
970
|
+
};
|
|
971
|
+
};
|
|
972
|
+
}
|
|
973
|
+
interface UpdateGroupResponseNonNullableFields {
|
|
974
|
+
group?: {
|
|
975
|
+
privacyLevel: PrivacyStatus$4;
|
|
976
|
+
privacyStatus: PrivacyStatus$4;
|
|
977
|
+
coverImage?: {
|
|
978
|
+
position?: {
|
|
979
|
+
x: number;
|
|
980
|
+
y: number;
|
|
981
|
+
};
|
|
982
|
+
mobilePosition?: {
|
|
983
|
+
x: number;
|
|
984
|
+
y: number;
|
|
985
|
+
};
|
|
986
|
+
};
|
|
987
|
+
settings?: {
|
|
988
|
+
onboardingStepsSettings: {
|
|
989
|
+
stepKey: StepKey$4;
|
|
990
|
+
visible: boolean;
|
|
991
|
+
}[];
|
|
992
|
+
};
|
|
993
|
+
createdBy?: {
|
|
994
|
+
identityType: IdentityType$4;
|
|
995
|
+
};
|
|
996
|
+
};
|
|
997
|
+
}
|
|
998
|
+
interface DeleteGroupResponseNonNullableFields {
|
|
999
|
+
group?: {
|
|
1000
|
+
privacyLevel: PrivacyStatus$4;
|
|
1001
|
+
privacyStatus: PrivacyStatus$4;
|
|
1002
|
+
coverImage?: {
|
|
1003
|
+
position?: {
|
|
1004
|
+
x: number;
|
|
1005
|
+
y: number;
|
|
1006
|
+
};
|
|
1007
|
+
mobilePosition?: {
|
|
1008
|
+
x: number;
|
|
1009
|
+
y: number;
|
|
1010
|
+
};
|
|
1011
|
+
};
|
|
1012
|
+
settings?: {
|
|
1013
|
+
onboardingStepsSettings: {
|
|
1014
|
+
stepKey: StepKey$4;
|
|
1015
|
+
visible: boolean;
|
|
1016
|
+
}[];
|
|
1017
|
+
};
|
|
1018
|
+
createdBy?: {
|
|
1019
|
+
identityType: IdentityType$4;
|
|
1020
|
+
};
|
|
1021
|
+
};
|
|
1022
|
+
}
|
|
1023
|
+
interface GetGroupResponseNonNullableFields {
|
|
1024
|
+
group?: {
|
|
1025
|
+
privacyLevel: PrivacyStatus$4;
|
|
1026
|
+
privacyStatus: PrivacyStatus$4;
|
|
1027
|
+
coverImage?: {
|
|
1028
|
+
position?: {
|
|
1029
|
+
x: number;
|
|
1030
|
+
y: number;
|
|
1031
|
+
};
|
|
1032
|
+
mobilePosition?: {
|
|
1033
|
+
x: number;
|
|
1034
|
+
y: number;
|
|
1035
|
+
};
|
|
1036
|
+
};
|
|
1037
|
+
settings?: {
|
|
1038
|
+
onboardingStepsSettings: {
|
|
1039
|
+
stepKey: StepKey$4;
|
|
1040
|
+
visible: boolean;
|
|
1041
|
+
}[];
|
|
1042
|
+
};
|
|
1043
|
+
createdBy?: {
|
|
1044
|
+
identityType: IdentityType$4;
|
|
1045
|
+
};
|
|
1046
|
+
};
|
|
1047
|
+
}
|
|
1048
|
+
interface GetGroupBySlugResponseNonNullableFields {
|
|
1049
|
+
group?: {
|
|
1050
|
+
privacyLevel: PrivacyStatus$4;
|
|
1051
|
+
privacyStatus: PrivacyStatus$4;
|
|
1052
|
+
coverImage?: {
|
|
1053
|
+
position?: {
|
|
1054
|
+
x: number;
|
|
1055
|
+
y: number;
|
|
1056
|
+
};
|
|
1057
|
+
mobilePosition?: {
|
|
1058
|
+
x: number;
|
|
1059
|
+
y: number;
|
|
1060
|
+
};
|
|
1061
|
+
};
|
|
1062
|
+
settings?: {
|
|
1063
|
+
onboardingStepsSettings: {
|
|
1064
|
+
stepKey: StepKey$4;
|
|
1065
|
+
visible: boolean;
|
|
1066
|
+
}[];
|
|
1067
|
+
};
|
|
1068
|
+
createdBy?: {
|
|
1069
|
+
identityType: IdentityType$4;
|
|
1070
|
+
};
|
|
1071
|
+
};
|
|
1072
|
+
}
|
|
1073
|
+
interface ListGroupsResponseNonNullableFields {
|
|
1074
|
+
groups: {
|
|
1075
|
+
privacyLevel: PrivacyStatus$4;
|
|
1076
|
+
privacyStatus: PrivacyStatus$4;
|
|
1077
|
+
coverImage?: {
|
|
1078
|
+
position?: {
|
|
1079
|
+
x: number;
|
|
1080
|
+
y: number;
|
|
1081
|
+
};
|
|
1082
|
+
mobilePosition?: {
|
|
1083
|
+
x: number;
|
|
1084
|
+
y: number;
|
|
1085
|
+
};
|
|
1086
|
+
};
|
|
1087
|
+
settings?: {
|
|
1088
|
+
onboardingStepsSettings: {
|
|
1089
|
+
stepKey: StepKey$4;
|
|
1090
|
+
visible: boolean;
|
|
1091
|
+
}[];
|
|
1092
|
+
};
|
|
1093
|
+
createdBy?: {
|
|
1094
|
+
identityType: IdentityType$4;
|
|
1095
|
+
};
|
|
1096
|
+
}[];
|
|
1097
|
+
}
|
|
1098
|
+
interface QueryGroupsResponseNonNullableFields {
|
|
1099
|
+
groups: {
|
|
1100
|
+
privacyLevel: PrivacyStatus$4;
|
|
1101
|
+
privacyStatus: PrivacyStatus$4;
|
|
1102
|
+
coverImage?: {
|
|
1103
|
+
position?: {
|
|
1104
|
+
x: number;
|
|
1105
|
+
y: number;
|
|
1106
|
+
};
|
|
1107
|
+
mobilePosition?: {
|
|
1108
|
+
x: number;
|
|
1109
|
+
y: number;
|
|
1110
|
+
};
|
|
1111
|
+
};
|
|
1112
|
+
settings?: {
|
|
1113
|
+
onboardingStepsSettings: {
|
|
1114
|
+
stepKey: StepKey$4;
|
|
1115
|
+
visible: boolean;
|
|
1116
|
+
}[];
|
|
1117
|
+
};
|
|
1118
|
+
createdBy?: {
|
|
1119
|
+
identityType: IdentityType$4;
|
|
1120
|
+
};
|
|
1121
|
+
}[];
|
|
1122
|
+
}
|
|
1123
|
+
|
|
1124
|
+
type __PublicMethodMetaInfo$8<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1125
|
+
getUrl: (context: any) => string;
|
|
1126
|
+
httpMethod: K;
|
|
1127
|
+
path: string;
|
|
1128
|
+
pathParams: M;
|
|
1129
|
+
__requestType: T;
|
|
1130
|
+
__originalRequestType: S;
|
|
1131
|
+
__responseType: Q;
|
|
1132
|
+
__originalResponseType: R;
|
|
1133
|
+
};
|
|
1134
|
+
declare function createGroup(): __PublicMethodMetaInfo$8<'POST', {}, CreateGroupRequest, CreateGroupRequest$1, CreateGroupResponse & CreateGroupResponseNonNullableFields, CreateGroupResponse$1 & CreateGroupResponseNonNullableFields$1>;
|
|
1135
|
+
declare function updateGroup(): __PublicMethodMetaInfo$8<'PATCH', {
|
|
1136
|
+
groupId: string;
|
|
1137
|
+
}, UpdateGroupRequest, UpdateGroupRequest$1, UpdateGroupResponse & UpdateGroupResponseNonNullableFields, UpdateGroupResponse$1 & UpdateGroupResponseNonNullableFields$1>;
|
|
1138
|
+
declare function deleteGroup(): __PublicMethodMetaInfo$8<'DELETE', {
|
|
1139
|
+
groupId: string;
|
|
1140
|
+
}, DeleteGroupRequest, DeleteGroupRequest$1, DeleteGroupResponse & DeleteGroupResponseNonNullableFields, DeleteGroupResponse$1 & DeleteGroupResponseNonNullableFields$1>;
|
|
1141
|
+
declare function getGroup(): __PublicMethodMetaInfo$8<'GET', {
|
|
1142
|
+
groupId: string;
|
|
1143
|
+
}, GetGroupRequest, GetGroupRequest$1, GetGroupResponse & GetGroupResponseNonNullableFields, GetGroupResponse$1 & GetGroupResponseNonNullableFields$1>;
|
|
1144
|
+
declare function getGroupBySlug(): __PublicMethodMetaInfo$8<'GET', {
|
|
1145
|
+
slug: string;
|
|
1146
|
+
}, GetGroupBySlugRequest, GetGroupBySlugRequest$1, GetGroupBySlugResponse & GetGroupBySlugResponseNonNullableFields, GetGroupBySlugResponse$1 & GetGroupBySlugResponseNonNullableFields$1>;
|
|
1147
|
+
declare function listGroups(): __PublicMethodMetaInfo$8<'GET', {}, ListGroupsRequest, ListGroupsRequest$1, ListGroupsResponse & ListGroupsResponseNonNullableFields, ListGroupsResponse$1 & ListGroupsResponseNonNullableFields$1>;
|
|
1148
|
+
declare function queryGroups(): __PublicMethodMetaInfo$8<'POST', {}, QueryGroupsRequest, QueryGroupsRequest$1, QueryGroupsResponse & QueryGroupsResponseNonNullableFields, QueryGroupsResponse$1 & QueryGroupsResponseNonNullableFields$1>;
|
|
1149
|
+
|
|
1150
|
+
declare const meta$8_createGroup: typeof createGroup;
|
|
1151
|
+
declare const meta$8_deleteGroup: typeof deleteGroup;
|
|
1152
|
+
declare const meta$8_getGroup: typeof getGroup;
|
|
1153
|
+
declare const meta$8_getGroupBySlug: typeof getGroupBySlug;
|
|
1154
|
+
declare const meta$8_listGroups: typeof listGroups;
|
|
1155
|
+
declare const meta$8_queryGroups: typeof queryGroups;
|
|
1156
|
+
declare const meta$8_updateGroup: typeof updateGroup;
|
|
1157
|
+
declare namespace meta$8 {
|
|
1158
|
+
export { type __PublicMethodMetaInfo$8 as __PublicMethodMetaInfo, meta$8_createGroup as createGroup, meta$8_deleteGroup as deleteGroup, meta$8_getGroup as getGroup, meta$8_getGroupBySlug as getGroupBySlug, meta$8_listGroups as listGroups, meta$8_queryGroups as queryGroups, meta$8_updateGroup as updateGroup };
|
|
1159
|
+
}
|
|
1160
|
+
|
|
1161
|
+
interface GroupMember$1 {
|
|
1162
|
+
/**
|
|
1163
|
+
* __Deprecated.__ Use `memberId` instead.
|
|
1164
|
+
* This property will be removed on June 30, 2022.
|
|
1165
|
+
* @readonly
|
|
1166
|
+
* @deprecated
|
|
1167
|
+
*/
|
|
1168
|
+
siteMemberId?: string;
|
|
1169
|
+
/**
|
|
1170
|
+
* Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.
|
|
1171
|
+
* @readonly
|
|
1172
|
+
*/
|
|
1173
|
+
memberId?: string;
|
|
1174
|
+
/** Group Member Role. */
|
|
1175
|
+
role?: GroupRole$3;
|
|
1176
|
+
/**
|
|
1177
|
+
* Date and time the group Member joined the group.
|
|
1178
|
+
* @readonly
|
|
1179
|
+
*/
|
|
1180
|
+
joinedDate?: Date;
|
|
1181
|
+
}
|
|
1182
|
+
/**
|
|
1183
|
+
* A group member may have multiple roles in a single group.
|
|
1184
|
+
* Currently, only `MEMBER` and `ADMIN` roles are supported, but more roles may be available in the future.
|
|
1185
|
+
*/
|
|
1186
|
+
interface GroupRole$3 {
|
|
1187
|
+
/**
|
|
1188
|
+
* Member's role.
|
|
1189
|
+
* - `MEMBER` - Regular group member.
|
|
1190
|
+
* - `ADMIN` - Group administrator.
|
|
1191
|
+
*/
|
|
1192
|
+
value?: Role$3;
|
|
1193
|
+
}
|
|
1194
|
+
declare enum Role$3 {
|
|
1195
|
+
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
1196
|
+
/** Regular group member. */
|
|
1197
|
+
MEMBER = "MEMBER",
|
|
1198
|
+
/** Group administrator. */
|
|
1199
|
+
ADMIN = "ADMIN"
|
|
1200
|
+
}
|
|
1201
|
+
interface AddGroupMembersRequest$1 {
|
|
1202
|
+
/** Group ID. */
|
|
1203
|
+
groupId: string;
|
|
1204
|
+
/**
|
|
1205
|
+
* __Deprecated.__ Use `memberIds` instead.
|
|
1206
|
+
* This parameter will be removed on June 30, 2022.
|
|
1207
|
+
* @deprecated
|
|
1208
|
+
*/
|
|
1209
|
+
siteMemberIds?: string[];
|
|
1210
|
+
/** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
|
|
1211
|
+
memberIds?: string[];
|
|
1212
|
+
}
|
|
1213
|
+
interface AddGroupMembersResponse$1 {
|
|
1214
|
+
/** New members. */
|
|
1215
|
+
members?: GroupMember$1[];
|
|
1216
|
+
}
|
|
1217
|
+
interface RemoveGroupMembersRequest$1 {
|
|
1218
|
+
/** Group ID. */
|
|
1219
|
+
groupId: string;
|
|
1220
|
+
/**
|
|
1221
|
+
* __Deprecated.__ Use `memberIds` instead.
|
|
1222
|
+
* This parameter will be removed on June 30, 2022.
|
|
1223
|
+
* @deprecated
|
|
1224
|
+
*/
|
|
1225
|
+
siteMemberIds?: string[];
|
|
1226
|
+
/** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
|
|
1227
|
+
memberIds?: string[];
|
|
1228
|
+
}
|
|
1229
|
+
interface RemoveGroupMembersResponse$1 {
|
|
1230
|
+
}
|
|
1231
|
+
interface ListGroupMembersRequest$1 {
|
|
1232
|
+
/** Group ID. */
|
|
1233
|
+
groupId: string;
|
|
1234
|
+
/** Number of items to load. Maximum `100.` */
|
|
1235
|
+
limit?: number | null;
|
|
1236
|
+
/** Number of items to skip in the current sort order. */
|
|
1237
|
+
offset?: number | null;
|
|
1238
|
+
}
|
|
1239
|
+
interface ListGroupMembersResponse$1 {
|
|
1240
|
+
/** Retrieved members. */
|
|
1241
|
+
members?: GroupMember$1[];
|
|
1242
|
+
/** Paging information. */
|
|
1243
|
+
metadata?: PagingMetadata$b;
|
|
1244
|
+
}
|
|
1245
|
+
interface PagingMetadata$b {
|
|
1246
|
+
/** Number of items returned in the response. */
|
|
1247
|
+
count?: number | null;
|
|
1248
|
+
/** Offset that was requested. */
|
|
1249
|
+
offset?: number | null;
|
|
1250
|
+
/** Total number of items that match the query. */
|
|
1251
|
+
total?: number | null;
|
|
1252
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1253
|
+
tooManyToCount?: boolean | null;
|
|
1254
|
+
}
|
|
1255
|
+
interface QueryGroupMembersRequest$1 {
|
|
1256
|
+
/** Group ID. */
|
|
1257
|
+
groupId: string;
|
|
1258
|
+
query?: Query$9;
|
|
1259
|
+
}
|
|
1260
|
+
interface Query$9 {
|
|
1261
|
+
/**
|
|
1262
|
+
* Filter object in the following format:
|
|
1263
|
+
* `"filter" : {
|
|
1264
|
+
* "fieldName1": "value1",
|
|
1265
|
+
* "fieldName2":{"$operator":"value2"}
|
|
1266
|
+
* }`
|
|
1267
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
1268
|
+
*/
|
|
1269
|
+
filter?: any;
|
|
1270
|
+
/**
|
|
1271
|
+
* Sort object in the following format:
|
|
1272
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1273
|
+
*/
|
|
1274
|
+
sort?: Sorting$9[];
|
|
1275
|
+
/** Paging options to limit and skip the number of items. */
|
|
1276
|
+
paging?: Paging$b;
|
|
1277
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1278
|
+
fields?: string[];
|
|
1279
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1280
|
+
fieldsets?: string[];
|
|
1281
|
+
}
|
|
1282
|
+
interface Sorting$9 {
|
|
1283
|
+
/** Name of the field to sort by. */
|
|
1284
|
+
fieldName?: string;
|
|
1285
|
+
/** Sort order. */
|
|
1286
|
+
order?: SortOrder$9;
|
|
1287
|
+
}
|
|
1288
|
+
declare enum SortOrder$9 {
|
|
1289
|
+
ASC = "ASC",
|
|
1290
|
+
DESC = "DESC"
|
|
1291
|
+
}
|
|
1292
|
+
interface Paging$b {
|
|
1293
|
+
/** Number of items to load. */
|
|
1294
|
+
limit?: number | null;
|
|
1295
|
+
/** Number of items to skip in the current sort order. */
|
|
1296
|
+
offset?: number | null;
|
|
1297
|
+
}
|
|
1298
|
+
interface QueryGroupMembersResponse$1 {
|
|
1299
|
+
/** Group members. */
|
|
1300
|
+
members?: GroupMember$1[];
|
|
1301
|
+
/** Paging information. */
|
|
1302
|
+
metadata?: PagingMetadata$b;
|
|
1303
|
+
}
|
|
1304
|
+
interface ListMembershipsRequest$1 {
|
|
1305
|
+
/** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
|
|
1306
|
+
memberId: string | null;
|
|
1307
|
+
/** Number of items to load. */
|
|
1308
|
+
limit?: number | null;
|
|
1309
|
+
/** Number of items to skip in the current sort order. */
|
|
1310
|
+
offset?: number | null;
|
|
1311
|
+
}
|
|
1312
|
+
interface ListMembershipsResponse$1 {
|
|
1313
|
+
/** Site member's memberships. */
|
|
1314
|
+
memberships?: Membership$1[];
|
|
1315
|
+
/** Paging information. */
|
|
1316
|
+
metadata?: PagingMetadata$b;
|
|
1317
|
+
}
|
|
1318
|
+
interface Membership$1 {
|
|
1319
|
+
/**
|
|
1320
|
+
* Group ID.
|
|
1321
|
+
* @readonly
|
|
1322
|
+
*/
|
|
1323
|
+
groupId?: string;
|
|
1324
|
+
/**
|
|
1325
|
+
* Membership status with Group
|
|
1326
|
+
* - `JOINED` - Site member is a group member.
|
|
1327
|
+
* - `PENDING` - Site member has submitted a Join Request for this group that is still `PENDING`.
|
|
1328
|
+
*/
|
|
1329
|
+
status?: MembershipStatus$1;
|
|
1330
|
+
/** Group member role. When membership status is not `JOINED`, this is empty. */
|
|
1331
|
+
role?: GroupRole$3;
|
|
1332
|
+
}
|
|
1333
|
+
declare enum MembershipStatus$1 {
|
|
1334
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
1335
|
+
/** Site member is a group member. */
|
|
1336
|
+
JOINED = "JOINED",
|
|
1337
|
+
/** Site member has join group request with `PENDING` status for this group. */
|
|
1338
|
+
PENDING = "PENDING"
|
|
1339
|
+
}
|
|
1340
|
+
interface QueryMembershipsRequest$1 {
|
|
1341
|
+
/**
|
|
1342
|
+
* __Deprecated.__ Use the `memberId` path parameter instead.
|
|
1343
|
+
* This parameter will be removed on June 30, 2022.
|
|
1344
|
+
* @deprecated
|
|
1345
|
+
*/
|
|
1346
|
+
siteMemberId?: string | null;
|
|
1347
|
+
/** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
|
|
1348
|
+
memberId: string | null;
|
|
1349
|
+
query?: Query$9;
|
|
1350
|
+
}
|
|
1351
|
+
interface QueryMembershipsResponse$1 {
|
|
1352
|
+
/** Site member's memberships. */
|
|
1353
|
+
memberships?: Membership$1[];
|
|
1354
|
+
/** Paging information. */
|
|
1355
|
+
metadata?: PagingMetadata$b;
|
|
1356
|
+
}
|
|
1357
|
+
interface AddGroupMembersResponseNonNullableFields$1 {
|
|
1358
|
+
members: {
|
|
1359
|
+
siteMemberId: string;
|
|
1360
|
+
memberId: string;
|
|
1361
|
+
role?: {
|
|
1362
|
+
value: Role$3;
|
|
1363
|
+
};
|
|
1364
|
+
}[];
|
|
1365
|
+
}
|
|
1366
|
+
interface ListGroupMembersResponseNonNullableFields$1 {
|
|
1367
|
+
members: {
|
|
1368
|
+
siteMemberId: string;
|
|
1369
|
+
memberId: string;
|
|
1370
|
+
role?: {
|
|
1371
|
+
value: Role$3;
|
|
1372
|
+
};
|
|
1373
|
+
}[];
|
|
1374
|
+
}
|
|
1375
|
+
interface QueryGroupMembersResponseNonNullableFields$1 {
|
|
1376
|
+
members: {
|
|
1377
|
+
siteMemberId: string;
|
|
1378
|
+
memberId: string;
|
|
1379
|
+
role?: {
|
|
1380
|
+
value: Role$3;
|
|
1381
|
+
};
|
|
1382
|
+
}[];
|
|
1383
|
+
}
|
|
1384
|
+
interface ListMembershipsResponseNonNullableFields$1 {
|
|
1385
|
+
memberships: {
|
|
1386
|
+
groupId: string;
|
|
1387
|
+
status: MembershipStatus$1;
|
|
1388
|
+
role?: {
|
|
1389
|
+
value: Role$3;
|
|
1390
|
+
};
|
|
1391
|
+
}[];
|
|
1392
|
+
}
|
|
1393
|
+
interface QueryMembershipsResponseNonNullableFields$1 {
|
|
1394
|
+
memberships: {
|
|
1395
|
+
groupId: string;
|
|
1396
|
+
status: MembershipStatus$1;
|
|
1397
|
+
role?: {
|
|
1398
|
+
value: Role$3;
|
|
1399
|
+
};
|
|
1400
|
+
}[];
|
|
1401
|
+
}
|
|
1402
|
+
|
|
1403
|
+
interface GroupMember {
|
|
1404
|
+
/**
|
|
1405
|
+
* @internal
|
|
1406
|
+
* @internal
|
|
1407
|
+
* @readonly
|
|
1408
|
+
* @deprecated
|
|
1409
|
+
*/
|
|
1410
|
+
siteMemberId?: string;
|
|
1411
|
+
/**
|
|
1412
|
+
* Site member ID.
|
|
1413
|
+
* @readonly
|
|
1414
|
+
*/
|
|
1415
|
+
memberId?: string;
|
|
1416
|
+
/** Group Member Role. */
|
|
1417
|
+
role?: GroupRole$2;
|
|
1418
|
+
/**
|
|
1419
|
+
* Date and time the group Member joined the group.
|
|
1420
|
+
* @readonly
|
|
1421
|
+
*/
|
|
1422
|
+
joinedDate?: Date;
|
|
1423
|
+
}
|
|
1424
|
+
/**
|
|
1425
|
+
* A group member may have multiple roles in a single group.
|
|
1426
|
+
* Currently, only `MEMBER` and `ADMIN` roles are supported, but more roles may be available in the future.
|
|
1427
|
+
*/
|
|
1428
|
+
interface GroupRole$2 {
|
|
1429
|
+
/**
|
|
1430
|
+
* Group member role. One of:
|
|
1431
|
+
* - `"MEMBER"` - Regular group member.
|
|
1432
|
+
* - `"ADMIN"` - Group administrator.
|
|
1433
|
+
*/
|
|
1434
|
+
value?: Role$2;
|
|
1435
|
+
}
|
|
1436
|
+
declare enum Role$2 {
|
|
1437
|
+
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
1438
|
+
/** Regular group member. */
|
|
1439
|
+
MEMBER = "MEMBER",
|
|
1440
|
+
/** Group administrator. */
|
|
1441
|
+
ADMIN = "ADMIN"
|
|
1442
|
+
}
|
|
1443
|
+
interface AddGroupMembersRequest {
|
|
1444
|
+
/** Group ID. */
|
|
1445
|
+
groupId: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* @internal
|
|
1448
|
+
* @internal
|
|
1449
|
+
* @deprecated
|
|
1450
|
+
*/
|
|
1451
|
+
siteMemberIds?: string[];
|
|
1452
|
+
/**
|
|
1453
|
+
* IDs of the site members to add to the group.
|
|
1454
|
+
*
|
|
1455
|
+
*
|
|
1456
|
+
*/
|
|
1457
|
+
memberIds?: string[];
|
|
1458
|
+
}
|
|
1459
|
+
interface AddGroupMembersResponse {
|
|
1460
|
+
/** New members. */
|
|
1461
|
+
members?: GroupMember[];
|
|
1462
|
+
}
|
|
1463
|
+
interface RemoveGroupMembersRequest {
|
|
1464
|
+
/** Group ID. */
|
|
1465
|
+
groupId: string;
|
|
1466
|
+
/**
|
|
1467
|
+
* @internal
|
|
1468
|
+
* @internal
|
|
1469
|
+
* @deprecated
|
|
1470
|
+
*/
|
|
1471
|
+
siteMemberIds?: string[];
|
|
1472
|
+
/** IDs of the site members to remove from the group. */
|
|
1473
|
+
memberIds?: string[];
|
|
1474
|
+
}
|
|
1475
|
+
interface RemoveGroupMembersResponse {
|
|
1476
|
+
}
|
|
1477
|
+
interface ListGroupMembersRequest {
|
|
1478
|
+
/** Group ID. */
|
|
1479
|
+
groupId: string;
|
|
1480
|
+
/** Number of items to load. Maximum `100.` */
|
|
1481
|
+
limit?: number | null;
|
|
1482
|
+
/** Number of group members to skip in the list. */
|
|
1483
|
+
offset?: number | null;
|
|
1484
|
+
}
|
|
1485
|
+
interface ListGroupMembersResponse {
|
|
1486
|
+
/** Retrieved members. */
|
|
1487
|
+
members?: GroupMember[];
|
|
1488
|
+
/** Paging information. */
|
|
1489
|
+
metadata?: PagingMetadata$a;
|
|
1490
|
+
}
|
|
1491
|
+
interface PagingMetadata$a {
|
|
1492
|
+
/** Number of items returned in the response. */
|
|
1493
|
+
count?: number | null;
|
|
1494
|
+
/** Offset that was requested. */
|
|
1495
|
+
offset?: number | null;
|
|
1496
|
+
/** Total number of items that match the query. */
|
|
1497
|
+
total?: number | null;
|
|
1498
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1499
|
+
tooManyToCount?: boolean | null;
|
|
1500
|
+
}
|
|
1501
|
+
interface QueryGroupMembersRequest {
|
|
1502
|
+
/** Group ID. */
|
|
1503
|
+
groupId: string;
|
|
1504
|
+
query?: Query$8;
|
|
1505
|
+
}
|
|
1506
|
+
interface Query$8 {
|
|
1507
|
+
/**
|
|
1508
|
+
* Filter object in the following format:
|
|
1509
|
+
* `"filter" : {
|
|
1510
|
+
* "fieldName1": "value1",
|
|
1511
|
+
* "fieldName2":{"$operator":"value2"}
|
|
1512
|
+
* }`
|
|
1513
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
1514
|
+
*/
|
|
1515
|
+
filter?: any;
|
|
1516
|
+
/**
|
|
1517
|
+
* Sort object in the following format:
|
|
1518
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1519
|
+
*/
|
|
1520
|
+
sort?: Sorting$8[];
|
|
1521
|
+
/** Paging options to limit and skip the number of items. */
|
|
1522
|
+
paging?: Paging$a;
|
|
1523
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1524
|
+
fields?: string[];
|
|
1525
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1526
|
+
fieldsets?: string[];
|
|
1527
|
+
}
|
|
1528
|
+
interface Sorting$8 {
|
|
1529
|
+
/** Name of the field to sort by. */
|
|
1530
|
+
fieldName?: string;
|
|
1531
|
+
/** Sort order. */
|
|
1532
|
+
order?: SortOrder$8;
|
|
1533
|
+
}
|
|
1534
|
+
declare enum SortOrder$8 {
|
|
1535
|
+
ASC = "ASC",
|
|
1536
|
+
DESC = "DESC"
|
|
1537
|
+
}
|
|
1538
|
+
interface Paging$a {
|
|
1539
|
+
/** Number of items to load. */
|
|
1540
|
+
limit?: number | null;
|
|
1541
|
+
/** Number of items to skip in the current sort order. */
|
|
1542
|
+
offset?: number | null;
|
|
1543
|
+
}
|
|
1544
|
+
interface QueryGroupMembersResponse {
|
|
1545
|
+
/** Group members. */
|
|
1546
|
+
members?: GroupMember[];
|
|
1547
|
+
/** Paging information. */
|
|
1548
|
+
metadata?: PagingMetadata$a;
|
|
1549
|
+
}
|
|
1550
|
+
interface ListMembershipsRequest {
|
|
1551
|
+
/** Site member ID. */
|
|
1552
|
+
memberId: string | null;
|
|
1553
|
+
/** Number of items to load. */
|
|
1554
|
+
limit?: number | null;
|
|
1555
|
+
/** Number of memberships to skip in the list. */
|
|
1556
|
+
offset?: number | null;
|
|
1557
|
+
}
|
|
1558
|
+
interface ListMembershipsResponse {
|
|
1559
|
+
/** Site member's memberships. */
|
|
1560
|
+
memberships?: Membership[];
|
|
1561
|
+
/** Paging information. */
|
|
1562
|
+
metadata?: PagingMetadata$a;
|
|
1563
|
+
}
|
|
1564
|
+
interface Membership {
|
|
1565
|
+
/**
|
|
1566
|
+
* Group ID.
|
|
1567
|
+
* @readonly
|
|
1568
|
+
*/
|
|
1569
|
+
groupId?: string;
|
|
1570
|
+
/**
|
|
1571
|
+
* Membership status with Group
|
|
1572
|
+
* - `"JOINED"` - Site member is a group member.
|
|
1573
|
+
* - `"PENDING"` - Site member has submitted a Join Request for this group that is still `"PENDING"`.
|
|
1574
|
+
*/
|
|
1575
|
+
status?: MembershipStatus;
|
|
1576
|
+
/** Group member role. When membership status is not `JOINED`, this is empty. */
|
|
1577
|
+
role?: GroupRole$2;
|
|
1578
|
+
}
|
|
1579
|
+
declare enum MembershipStatus {
|
|
1580
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
1581
|
+
/** Site member is a group member. */
|
|
1582
|
+
JOINED = "JOINED",
|
|
1583
|
+
/** Site member has join group request with `PENDING` status for this group. */
|
|
1584
|
+
PENDING = "PENDING"
|
|
1585
|
+
}
|
|
1586
|
+
interface QueryMembershipsRequest {
|
|
1587
|
+
/**
|
|
1588
|
+
* @internal
|
|
1589
|
+
* @internal
|
|
1590
|
+
* @deprecated
|
|
1591
|
+
*/
|
|
1592
|
+
siteMemberId?: string | null;
|
|
1593
|
+
/** Site member ID. */
|
|
1594
|
+
memberId: string | null;
|
|
1595
|
+
query?: Query$8;
|
|
1596
|
+
}
|
|
1597
|
+
interface QueryMembershipsResponse {
|
|
1598
|
+
/** Site member's memberships. */
|
|
1599
|
+
memberships?: Membership[];
|
|
1600
|
+
/** Paging information. */
|
|
1601
|
+
metadata?: PagingMetadata$a;
|
|
1602
|
+
}
|
|
1603
|
+
interface AddGroupMembersResponseNonNullableFields {
|
|
1604
|
+
members: {
|
|
1605
|
+
siteMemberId: string;
|
|
1606
|
+
memberId: string;
|
|
1607
|
+
role?: {
|
|
1608
|
+
value: Role$2;
|
|
1609
|
+
};
|
|
1610
|
+
}[];
|
|
1611
|
+
}
|
|
1612
|
+
interface ListGroupMembersResponseNonNullableFields {
|
|
1613
|
+
members: {
|
|
1614
|
+
siteMemberId: string;
|
|
1615
|
+
memberId: string;
|
|
1616
|
+
role?: {
|
|
1617
|
+
value: Role$2;
|
|
1618
|
+
};
|
|
1619
|
+
}[];
|
|
1620
|
+
}
|
|
1621
|
+
interface QueryGroupMembersResponseNonNullableFields {
|
|
1622
|
+
members: {
|
|
1623
|
+
siteMemberId: string;
|
|
1624
|
+
memberId: string;
|
|
1625
|
+
role?: {
|
|
1626
|
+
value: Role$2;
|
|
1627
|
+
};
|
|
1628
|
+
}[];
|
|
1629
|
+
}
|
|
1630
|
+
interface ListMembershipsResponseNonNullableFields {
|
|
1631
|
+
memberships: {
|
|
1632
|
+
groupId: string;
|
|
1633
|
+
status: MembershipStatus;
|
|
1634
|
+
role?: {
|
|
1635
|
+
value: Role$2;
|
|
1636
|
+
};
|
|
1637
|
+
}[];
|
|
1638
|
+
}
|
|
1639
|
+
interface QueryMembershipsResponseNonNullableFields {
|
|
1640
|
+
memberships: {
|
|
1641
|
+
groupId: string;
|
|
1642
|
+
status: MembershipStatus;
|
|
1643
|
+
role?: {
|
|
1644
|
+
value: Role$2;
|
|
1645
|
+
};
|
|
1646
|
+
}[];
|
|
1647
|
+
}
|
|
1648
|
+
|
|
1649
|
+
type __PublicMethodMetaInfo$7<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1650
|
+
getUrl: (context: any) => string;
|
|
1651
|
+
httpMethod: K;
|
|
1652
|
+
path: string;
|
|
1653
|
+
pathParams: M;
|
|
1654
|
+
__requestType: T;
|
|
1655
|
+
__originalRequestType: S;
|
|
1656
|
+
__responseType: Q;
|
|
1657
|
+
__originalResponseType: R;
|
|
1658
|
+
};
|
|
1659
|
+
declare function addGroupMembers(): __PublicMethodMetaInfo$7<'POST', {
|
|
1660
|
+
groupId: string;
|
|
1661
|
+
}, AddGroupMembersRequest, AddGroupMembersRequest$1, AddGroupMembersResponse & AddGroupMembersResponseNonNullableFields, AddGroupMembersResponse$1 & AddGroupMembersResponseNonNullableFields$1>;
|
|
1662
|
+
declare function removeGroupMembers(): __PublicMethodMetaInfo$7<'DELETE', {
|
|
1663
|
+
groupId: string;
|
|
1664
|
+
}, RemoveGroupMembersRequest, RemoveGroupMembersRequest$1, RemoveGroupMembersResponse, RemoveGroupMembersResponse$1>;
|
|
1665
|
+
declare function listGroupMembers(): __PublicMethodMetaInfo$7<'GET', {
|
|
1666
|
+
groupId: string;
|
|
1667
|
+
}, ListGroupMembersRequest, ListGroupMembersRequest$1, ListGroupMembersResponse & ListGroupMembersResponseNonNullableFields, ListGroupMembersResponse$1 & ListGroupMembersResponseNonNullableFields$1>;
|
|
1668
|
+
declare function queryGroupMembers(): __PublicMethodMetaInfo$7<'POST', {
|
|
1669
|
+
groupId: string;
|
|
1670
|
+
}, QueryGroupMembersRequest, QueryGroupMembersRequest$1, QueryGroupMembersResponse & QueryGroupMembersResponseNonNullableFields, QueryGroupMembersResponse$1 & QueryGroupMembersResponseNonNullableFields$1>;
|
|
1671
|
+
declare function listMemberships(): __PublicMethodMetaInfo$7<'GET', {
|
|
1672
|
+
memberId: string;
|
|
1673
|
+
}, ListMembershipsRequest, ListMembershipsRequest$1, ListMembershipsResponse & ListMembershipsResponseNonNullableFields, ListMembershipsResponse$1 & ListMembershipsResponseNonNullableFields$1>;
|
|
1674
|
+
declare function queryMemberships(): __PublicMethodMetaInfo$7<'POST', {
|
|
1675
|
+
memberId: string;
|
|
1676
|
+
}, QueryMembershipsRequest, QueryMembershipsRequest$1, QueryMembershipsResponse & QueryMembershipsResponseNonNullableFields, QueryMembershipsResponse$1 & QueryMembershipsResponseNonNullableFields$1>;
|
|
1677
|
+
|
|
1678
|
+
declare const meta$7_addGroupMembers: typeof addGroupMembers;
|
|
1679
|
+
declare const meta$7_listGroupMembers: typeof listGroupMembers;
|
|
1680
|
+
declare const meta$7_listMemberships: typeof listMemberships;
|
|
1681
|
+
declare const meta$7_queryGroupMembers: typeof queryGroupMembers;
|
|
1682
|
+
declare const meta$7_queryMemberships: typeof queryMemberships;
|
|
1683
|
+
declare const meta$7_removeGroupMembers: typeof removeGroupMembers;
|
|
1684
|
+
declare namespace meta$7 {
|
|
1685
|
+
export { type __PublicMethodMetaInfo$7 as __PublicMethodMetaInfo, meta$7_addGroupMembers as addGroupMembers, meta$7_listGroupMembers as listGroupMembers, meta$7_listMemberships as listMemberships, meta$7_queryGroupMembers as queryGroupMembers, meta$7_queryMemberships as queryMemberships, meta$7_removeGroupMembers as removeGroupMembers };
|
|
1686
|
+
}
|
|
1687
|
+
|
|
1688
|
+
/**
|
|
1689
|
+
* >**Notes:**
|
|
1690
|
+
* > + Site owners may set that members are not permitted to create groups in the Wix Groups application settings.
|
|
1691
|
+
* > + In this situation, site members have to submit a Group Request to create a new group.
|
|
1692
|
+
* > + Group Requests can be approved or rejected by an admin.
|
|
1693
|
+
* > + After a Group Request has been approved, the new group is added to the Group List in the Wix Groups app home page.
|
|
1694
|
+
* > + See [Introduction](https://dev.wix.com/api/rest/wix-groups/groups/introduction#wix-groups_groups_introduction_terminology) for more details.
|
|
1695
|
+
*/
|
|
1696
|
+
interface GroupRequest$1 {
|
|
1697
|
+
/**
|
|
1698
|
+
* Group request ID
|
|
1699
|
+
* @readonly
|
|
1700
|
+
*/
|
|
1701
|
+
id?: string | null;
|
|
1702
|
+
/** Group requested for creation. */
|
|
1703
|
+
group?: Group$3;
|
|
1704
|
+
/**
|
|
1705
|
+
* Status of group request.
|
|
1706
|
+
* - `PENDING` - Pending group request.
|
|
1707
|
+
* - `APPROVED` - Approved group request.
|
|
1708
|
+
* - `REJECTED` - Rejected group request.
|
|
1709
|
+
* - `CANCELED` - Canceled group request.
|
|
1710
|
+
*/
|
|
1711
|
+
status?: RequestStatus$7;
|
|
1712
|
+
/** Group request details. */
|
|
1713
|
+
requestDetails?: RequestDetails$7;
|
|
1714
|
+
}
|
|
1715
|
+
interface Group$3 {
|
|
1716
|
+
/**
|
|
1717
|
+
* Group ID.
|
|
1718
|
+
* @readonly
|
|
1719
|
+
*/
|
|
1720
|
+
id?: string | null;
|
|
1721
|
+
/** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */
|
|
1722
|
+
slug?: string | null;
|
|
1723
|
+
/**
|
|
1724
|
+
* __Deprecated.__ Use `privacyStatus` instead.
|
|
1725
|
+
* This property will be removed on June 30, 2022.
|
|
1726
|
+
* @deprecated
|
|
1727
|
+
*/
|
|
1728
|
+
privacyLevel?: PrivacyStatus$3;
|
|
1729
|
+
/**
|
|
1730
|
+
* Group privacy status.
|
|
1731
|
+
* - `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.
|
|
1732
|
+
* - `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.
|
|
1733
|
+
* - `SECRET` - Only admins and members can see the group. New members can only be added by other members.
|
|
1734
|
+
*/
|
|
1735
|
+
privacyStatus?: PrivacyStatus$3;
|
|
1736
|
+
/**
|
|
1737
|
+
* __Deprecated.__ Use `name` instead.
|
|
1738
|
+
* This property will be removed on June 30, 2022.
|
|
1739
|
+
* @deprecated
|
|
1740
|
+
*/
|
|
1741
|
+
title?: string | null;
|
|
1742
|
+
/** Group name. */
|
|
1743
|
+
name?: string | null;
|
|
1744
|
+
/** Group description in DraftJS format. */
|
|
1745
|
+
description?: string | null;
|
|
1746
|
+
/** Group teaser. */
|
|
1747
|
+
teaser?: string | null;
|
|
1748
|
+
/**
|
|
1749
|
+
* __Deprecated.__
|
|
1750
|
+
* For `details.logo`, use `coverImage` instead.
|
|
1751
|
+
* For `details.membersTitle`, `memberTitle` instead.
|
|
1752
|
+
* This property will be removed on June 30, 2022.
|
|
1753
|
+
* @deprecated
|
|
1754
|
+
*/
|
|
1755
|
+
details?: GroupDetails$3;
|
|
1756
|
+
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
1757
|
+
memberTitle?: string | null;
|
|
1758
|
+
/** Cover image. You cannot upload your own cover image. */
|
|
1759
|
+
coverImage?: CoverImage$3;
|
|
1760
|
+
/** Group specific settings. Available to the site owners under `Admin Tools` in the dashboard. */
|
|
1761
|
+
settings?: GroupSettings$3;
|
|
1762
|
+
/**
|
|
1763
|
+
* Total count of current group members.
|
|
1764
|
+
* @readonly
|
|
1765
|
+
*/
|
|
1766
|
+
membersCount?: number | null;
|
|
1767
|
+
/**
|
|
1768
|
+
* __Deprecated.__ Use `ownerId` instead.
|
|
1769
|
+
* This property will be removed on June 30, 2022.
|
|
1770
|
+
* @readonly
|
|
1771
|
+
* @deprecated
|
|
1772
|
+
*/
|
|
1773
|
+
createdBy?: Identity$3;
|
|
1774
|
+
/**
|
|
1775
|
+
* Group owner.
|
|
1776
|
+
* @readonly
|
|
1777
|
+
*/
|
|
1778
|
+
ownerId?: string | null;
|
|
1779
|
+
/**
|
|
1780
|
+
* Group creation date and time.
|
|
1781
|
+
* @readonly
|
|
1782
|
+
*/
|
|
1783
|
+
createdDate?: Date;
|
|
1784
|
+
/**
|
|
1785
|
+
* Date and time of the latest group update.
|
|
1786
|
+
* @readonly
|
|
1787
|
+
*/
|
|
1788
|
+
updatedDate?: Date;
|
|
1789
|
+
/**
|
|
1790
|
+
* __Deprecated.__ Use `lastActivityDate` instead.
|
|
1791
|
+
* This property will be removed on June 30, 2022.
|
|
1792
|
+
* @readonly
|
|
1793
|
+
* @deprecated
|
|
1794
|
+
*/
|
|
1795
|
+
recentActivityDate?: Date;
|
|
1796
|
+
/**
|
|
1797
|
+
* Date and time of the most recent group activity, for example a post or comment.
|
|
1798
|
+
* @readonly
|
|
1799
|
+
*/
|
|
1800
|
+
lastActivityDate?: Date;
|
|
1801
|
+
}
|
|
1802
|
+
declare enum Type$1 {
|
|
1803
|
+
UNKNOWN = "UNKNOWN",
|
|
1804
|
+
ADMIN_APPROVAL = "ADMIN_APPROVAL",
|
|
1805
|
+
PAID_PLANS = "PAID_PLANS",
|
|
1806
|
+
EVENTS = "EVENTS"
|
|
1807
|
+
}
|
|
1808
|
+
interface Logo$3 {
|
|
1809
|
+
/** Logo image ID (for internal use). */
|
|
1810
|
+
mediaId?: string | null;
|
|
1811
|
+
/** Logo image width. */
|
|
1812
|
+
width?: number | null;
|
|
1813
|
+
/** Logo image height. */
|
|
1814
|
+
height?: number | null;
|
|
1815
|
+
}
|
|
1816
|
+
interface Image$3 {
|
|
1817
|
+
/** Image ID (for internal use). */
|
|
1818
|
+
mediaId?: string | null;
|
|
1819
|
+
/** Image width. */
|
|
1820
|
+
width?: number | null;
|
|
1821
|
+
/** Image height. */
|
|
1822
|
+
height?: number | null;
|
|
1823
|
+
}
|
|
1824
|
+
interface Position$3 {
|
|
1825
|
+
/** horizontal coordinate */
|
|
1826
|
+
x?: number;
|
|
1827
|
+
/** vertical coordinate */
|
|
1828
|
+
y?: number;
|
|
1829
|
+
}
|
|
1830
|
+
declare enum AllowPolicy$1 {
|
|
1831
|
+
UNKNOWN = "UNKNOWN",
|
|
1832
|
+
OWNER_AND_ADMINS = "OWNER_AND_ADMINS",
|
|
1833
|
+
OWNER = "OWNER",
|
|
1834
|
+
ALL_MEMBERS = "ALL_MEMBERS"
|
|
1835
|
+
}
|
|
1836
|
+
interface OnboardingStepSettings$3 {
|
|
1837
|
+
stepKey?: StepKey$3;
|
|
1838
|
+
visible?: boolean;
|
|
1839
|
+
}
|
|
1840
|
+
declare enum StepKey$3 {
|
|
1841
|
+
UNKNOWN = "UNKNOWN",
|
|
1842
|
+
CREATE_POST = "CREATE_POST",
|
|
1843
|
+
REACT_TO_POST = "REACT_TO_POST",
|
|
1844
|
+
INVITE_MEMBERS = "INVITE_MEMBERS"
|
|
1845
|
+
}
|
|
1846
|
+
declare enum PrivacyStatus$3 {
|
|
1847
|
+
UNKNOWN = "UNKNOWN",
|
|
1848
|
+
/** Anyone can see the group in the group list and view its content. Anyone can join. */
|
|
1849
|
+
PUBLIC = "PUBLIC",
|
|
1850
|
+
/** Anyone can see the group in the group list, but only group members can see its content. In order to join a group, a group join request must be submitted. */
|
|
1851
|
+
PRIVATE = "PRIVATE",
|
|
1852
|
+
/** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */
|
|
1853
|
+
SECRET = "SECRET"
|
|
1854
|
+
}
|
|
1855
|
+
interface GroupDetails$3 {
|
|
1856
|
+
/** Group logo. You cannot upload your own logo. */
|
|
1857
|
+
logo?: Logo$3;
|
|
1858
|
+
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
1859
|
+
membersTitle?: string | null;
|
|
1860
|
+
}
|
|
1861
|
+
interface CoverImage$3 {
|
|
1862
|
+
/** Cover image. */
|
|
1863
|
+
image?: Image$3;
|
|
1864
|
+
/** Position of the corner of the cover image (or logo). */
|
|
1865
|
+
position?: Position$3;
|
|
1866
|
+
/** Position of the corner of the cover image (or logo) for mobile browser. */
|
|
1867
|
+
mobilePosition?: Position$3;
|
|
1868
|
+
}
|
|
1869
|
+
interface GroupSettings$3 {
|
|
1870
|
+
/**
|
|
1871
|
+
* __Deprecated.__ Use `allowedToInviteMembers` instead.
|
|
1872
|
+
* Whether regular members are permitted to invite new members.
|
|
1873
|
+
* If `false`, only admins can invite members. Defaults to `true`.
|
|
1874
|
+
* @deprecated
|
|
1875
|
+
*/
|
|
1876
|
+
membersCanInvite?: boolean | null;
|
|
1877
|
+
/**
|
|
1878
|
+
* __Deprecated.__ Use `allowedToApproveJoinRequests` instead.
|
|
1879
|
+
* Whether all group members are permitted to approve join group requests.
|
|
1880
|
+
* If `false`, member approval is limited to the admins.
|
|
1881
|
+
* @deprecated
|
|
1882
|
+
*/
|
|
1883
|
+
membersCanApprove?: boolean | null;
|
|
1884
|
+
/**
|
|
1885
|
+
* __Deprecated.__ Use `welcomeMemberPostEnabled` instead.
|
|
1886
|
+
* This property will be removed on June 30, 2022.
|
|
1887
|
+
* @deprecated
|
|
1888
|
+
*/
|
|
1889
|
+
memberWelcomePostEnabled?: boolean | null;
|
|
1890
|
+
/** Whether a daily post about new members is enabled. */
|
|
1891
|
+
welcomeMemberPostEnabled?: boolean | null;
|
|
1892
|
+
/** Whether an automatic post about changing the group details is enabled. */
|
|
1893
|
+
groupDetailsChangedPostEnabled?: boolean | null;
|
|
1894
|
+
/** Whether all members can see the full member list. */
|
|
1895
|
+
showMemberList?: boolean | null;
|
|
1896
|
+
onboardingStepsSettings?: OnboardingStepSettings$3[];
|
|
1897
|
+
}
|
|
1898
|
+
interface Identity$3 {
|
|
1899
|
+
/** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
1900
|
+
id?: string | null;
|
|
1901
|
+
identityType?: IdentityType$3;
|
|
1902
|
+
}
|
|
1903
|
+
declare enum IdentityType$3 {
|
|
1904
|
+
USER = "USER",
|
|
1905
|
+
MEMBER = "MEMBER"
|
|
1906
|
+
}
|
|
1907
|
+
declare enum RequestStatus$7 {
|
|
1908
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
1909
|
+
/** Pending request. */
|
|
1910
|
+
PENDING = "PENDING",
|
|
1911
|
+
/** Approved request. */
|
|
1912
|
+
APPROVED = "APPROVED",
|
|
1913
|
+
/** Rejected request. */
|
|
1914
|
+
REJECTED = "REJECTED",
|
|
1915
|
+
/** Cancelled request. */
|
|
1916
|
+
CANCELLED = "CANCELLED",
|
|
1917
|
+
/** Canceled request. */
|
|
1918
|
+
CANCELED = "CANCELED"
|
|
1919
|
+
}
|
|
1920
|
+
interface RequestDetails$7 {
|
|
1921
|
+
/** Reason the request has been rejected. */
|
|
1922
|
+
rejectionReason?: string | null;
|
|
1923
|
+
}
|
|
1924
|
+
interface ApproveGroupRequestsRequest$1 {
|
|
1925
|
+
/** Group Request IDs to approve. Limited to `100`. */
|
|
1926
|
+
groupRequestIds?: string[];
|
|
1927
|
+
}
|
|
1928
|
+
interface ApproveGroupRequestsResponse$1 {
|
|
1929
|
+
/** Approved Group Requests. */
|
|
1930
|
+
groupRequest?: GroupRequest$1[];
|
|
1931
|
+
}
|
|
1932
|
+
interface RejectGroupRequestsRequest$1 {
|
|
1933
|
+
/** Rejection data. */
|
|
1934
|
+
rejections?: Rejection$7[];
|
|
1935
|
+
}
|
|
1936
|
+
interface Rejection$7 {
|
|
1937
|
+
/** ID of the Group Request to reject. */
|
|
1938
|
+
groupRequestId?: string;
|
|
1939
|
+
/** Rejection reason. Free text displayed to the creator of the rejected Group Request. Limited to 1,000 characters. */
|
|
1940
|
+
reason?: string | null;
|
|
1941
|
+
}
|
|
1942
|
+
interface RejectGroupRequestsResponse$1 {
|
|
1943
|
+
/** Rejected Group Requests. */
|
|
1944
|
+
groupRequest?: GroupRequest$1[];
|
|
1945
|
+
}
|
|
1946
|
+
interface ListGroupRequestsRequest$1 {
|
|
1947
|
+
/** Number of items to load. Maximum `100`. */
|
|
1948
|
+
limit?: number | null;
|
|
1949
|
+
/** Number of items to skip in the current sort order. */
|
|
1950
|
+
offset?: number | null;
|
|
1951
|
+
}
|
|
1952
|
+
interface ListGroupRequestsResponse$1 {
|
|
1953
|
+
/** Group Requests. */
|
|
1954
|
+
groupRequests?: GroupRequest$1[];
|
|
1955
|
+
metadata?: PagingMetadata$9;
|
|
1956
|
+
}
|
|
1957
|
+
interface PagingMetadata$9 {
|
|
1958
|
+
/** Number of items returned in the response. */
|
|
1959
|
+
count?: number | null;
|
|
1960
|
+
/** Offset that was requested. */
|
|
1961
|
+
offset?: number | null;
|
|
1962
|
+
/** Total number of items that match the query. */
|
|
1963
|
+
total?: number | null;
|
|
1964
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1965
|
+
tooManyToCount?: boolean | null;
|
|
1966
|
+
}
|
|
1967
|
+
interface QueryGroupRequestsRequest$1 {
|
|
1968
|
+
query?: Query$7;
|
|
1969
|
+
}
|
|
1970
|
+
interface Query$7 {
|
|
1971
|
+
/**
|
|
1972
|
+
* Filter object in the following format:
|
|
1973
|
+
* `"filter" : {
|
|
1974
|
+
* "fieldName1": "value1",
|
|
1975
|
+
* "fieldName2":{"$operator":"value2"}
|
|
1976
|
+
* }`
|
|
1977
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
1978
|
+
*/
|
|
1979
|
+
filter?: any;
|
|
1980
|
+
/**
|
|
1981
|
+
* Sort object in the following format:
|
|
1982
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1983
|
+
*/
|
|
1984
|
+
sort?: Sorting$7[];
|
|
1985
|
+
/** Paging options to limit and skip the number of items. */
|
|
1986
|
+
paging?: Paging$9;
|
|
1987
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1988
|
+
fields?: string[];
|
|
1989
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
1990
|
+
fieldsets?: string[];
|
|
1991
|
+
}
|
|
1992
|
+
interface Sorting$7 {
|
|
1993
|
+
/** Name of the field to sort by. */
|
|
1994
|
+
fieldName?: string;
|
|
1995
|
+
/** Sort order. */
|
|
1996
|
+
order?: SortOrder$7;
|
|
1997
|
+
}
|
|
1998
|
+
declare enum SortOrder$7 {
|
|
1999
|
+
ASC = "ASC",
|
|
2000
|
+
DESC = "DESC"
|
|
2001
|
+
}
|
|
2002
|
+
interface Paging$9 {
|
|
2003
|
+
/** Number of items to load. */
|
|
2004
|
+
limit?: number | null;
|
|
2005
|
+
/** Number of items to skip in the current sort order. */
|
|
2006
|
+
offset?: number | null;
|
|
2007
|
+
}
|
|
2008
|
+
interface QueryGroupRequestsResponse$1 {
|
|
2009
|
+
/** Retrieved Group Requests. */
|
|
2010
|
+
groupRequests?: GroupRequest$1[];
|
|
2011
|
+
metadata?: PagingMetadata$9;
|
|
2012
|
+
}
|
|
2013
|
+
interface ApproveGroupRequestsResponseNonNullableFields$1 {
|
|
2014
|
+
groupRequest: {
|
|
2015
|
+
group?: {
|
|
2016
|
+
privacyLevel: PrivacyStatus$3;
|
|
2017
|
+
privacyStatus: PrivacyStatus$3;
|
|
2018
|
+
accessRestriction?: {
|
|
2019
|
+
events?: {
|
|
2020
|
+
eventIds: string[];
|
|
2021
|
+
};
|
|
2022
|
+
type: Type$1;
|
|
2023
|
+
};
|
|
2024
|
+
details?: {
|
|
2025
|
+
logoPosition?: {
|
|
2026
|
+
x: number;
|
|
2027
|
+
y: number;
|
|
2028
|
+
};
|
|
2029
|
+
mobileLogoPosition?: {
|
|
2030
|
+
x: number;
|
|
2031
|
+
y: number;
|
|
2032
|
+
};
|
|
2033
|
+
};
|
|
2034
|
+
coverImage?: {
|
|
2035
|
+
position?: {
|
|
2036
|
+
x: number;
|
|
2037
|
+
y: number;
|
|
2038
|
+
};
|
|
2039
|
+
mobilePosition?: {
|
|
2040
|
+
x: number;
|
|
2041
|
+
y: number;
|
|
2042
|
+
};
|
|
2043
|
+
};
|
|
2044
|
+
settings?: {
|
|
2045
|
+
allowedToInviteMembers: AllowPolicy$1;
|
|
2046
|
+
allowedToApproveJoinRequests: AllowPolicy$1;
|
|
2047
|
+
allowedToAddMembers: AllowPolicy$1;
|
|
2048
|
+
allowedToCreatePosts: AllowPolicy$1;
|
|
2049
|
+
allowedToCommentPosts: AllowPolicy$1;
|
|
2050
|
+
onboardingStepsSettings: {
|
|
2051
|
+
stepKey: StepKey$3;
|
|
2052
|
+
visible: boolean;
|
|
2053
|
+
}[];
|
|
2054
|
+
};
|
|
2055
|
+
createdBy?: {
|
|
2056
|
+
identityType: IdentityType$3;
|
|
2057
|
+
};
|
|
2058
|
+
};
|
|
2059
|
+
status: RequestStatus$7;
|
|
2060
|
+
}[];
|
|
2061
|
+
}
|
|
2062
|
+
interface RejectGroupRequestsResponseNonNullableFields$1 {
|
|
2063
|
+
groupRequest: {
|
|
2064
|
+
group?: {
|
|
2065
|
+
privacyLevel: PrivacyStatus$3;
|
|
2066
|
+
privacyStatus: PrivacyStatus$3;
|
|
2067
|
+
accessRestriction?: {
|
|
2068
|
+
events?: {
|
|
2069
|
+
eventIds: string[];
|
|
2070
|
+
};
|
|
2071
|
+
type: Type$1;
|
|
2072
|
+
};
|
|
2073
|
+
details?: {
|
|
2074
|
+
logoPosition?: {
|
|
2075
|
+
x: number;
|
|
2076
|
+
y: number;
|
|
2077
|
+
};
|
|
2078
|
+
mobileLogoPosition?: {
|
|
2079
|
+
x: number;
|
|
2080
|
+
y: number;
|
|
2081
|
+
};
|
|
2082
|
+
};
|
|
2083
|
+
coverImage?: {
|
|
2084
|
+
position?: {
|
|
2085
|
+
x: number;
|
|
2086
|
+
y: number;
|
|
2087
|
+
};
|
|
2088
|
+
mobilePosition?: {
|
|
2089
|
+
x: number;
|
|
2090
|
+
y: number;
|
|
2091
|
+
};
|
|
2092
|
+
};
|
|
2093
|
+
settings?: {
|
|
2094
|
+
allowedToInviteMembers: AllowPolicy$1;
|
|
2095
|
+
allowedToApproveJoinRequests: AllowPolicy$1;
|
|
2096
|
+
allowedToAddMembers: AllowPolicy$1;
|
|
2097
|
+
allowedToCreatePosts: AllowPolicy$1;
|
|
2098
|
+
allowedToCommentPosts: AllowPolicy$1;
|
|
2099
|
+
onboardingStepsSettings: {
|
|
2100
|
+
stepKey: StepKey$3;
|
|
2101
|
+
visible: boolean;
|
|
2102
|
+
}[];
|
|
2103
|
+
};
|
|
2104
|
+
createdBy?: {
|
|
2105
|
+
identityType: IdentityType$3;
|
|
2106
|
+
};
|
|
2107
|
+
};
|
|
2108
|
+
status: RequestStatus$7;
|
|
2109
|
+
}[];
|
|
2110
|
+
}
|
|
2111
|
+
interface ListGroupRequestsResponseNonNullableFields$1 {
|
|
2112
|
+
groupRequests: {
|
|
2113
|
+
group?: {
|
|
2114
|
+
privacyLevel: PrivacyStatus$3;
|
|
2115
|
+
privacyStatus: PrivacyStatus$3;
|
|
2116
|
+
accessRestriction?: {
|
|
2117
|
+
events?: {
|
|
2118
|
+
eventIds: string[];
|
|
2119
|
+
};
|
|
2120
|
+
type: Type$1;
|
|
2121
|
+
};
|
|
2122
|
+
details?: {
|
|
2123
|
+
logoPosition?: {
|
|
2124
|
+
x: number;
|
|
2125
|
+
y: number;
|
|
2126
|
+
};
|
|
2127
|
+
mobileLogoPosition?: {
|
|
2128
|
+
x: number;
|
|
2129
|
+
y: number;
|
|
2130
|
+
};
|
|
2131
|
+
};
|
|
2132
|
+
coverImage?: {
|
|
2133
|
+
position?: {
|
|
2134
|
+
x: number;
|
|
2135
|
+
y: number;
|
|
2136
|
+
};
|
|
2137
|
+
mobilePosition?: {
|
|
2138
|
+
x: number;
|
|
2139
|
+
y: number;
|
|
2140
|
+
};
|
|
2141
|
+
};
|
|
2142
|
+
settings?: {
|
|
2143
|
+
allowedToInviteMembers: AllowPolicy$1;
|
|
2144
|
+
allowedToApproveJoinRequests: AllowPolicy$1;
|
|
2145
|
+
allowedToAddMembers: AllowPolicy$1;
|
|
2146
|
+
allowedToCreatePosts: AllowPolicy$1;
|
|
2147
|
+
allowedToCommentPosts: AllowPolicy$1;
|
|
2148
|
+
onboardingStepsSettings: {
|
|
2149
|
+
stepKey: StepKey$3;
|
|
2150
|
+
visible: boolean;
|
|
2151
|
+
}[];
|
|
2152
|
+
};
|
|
2153
|
+
createdBy?: {
|
|
2154
|
+
identityType: IdentityType$3;
|
|
2155
|
+
};
|
|
2156
|
+
};
|
|
2157
|
+
status: RequestStatus$7;
|
|
2158
|
+
}[];
|
|
2159
|
+
}
|
|
2160
|
+
interface QueryGroupRequestsResponseNonNullableFields$1 {
|
|
2161
|
+
groupRequests: {
|
|
2162
|
+
group?: {
|
|
2163
|
+
privacyLevel: PrivacyStatus$3;
|
|
2164
|
+
privacyStatus: PrivacyStatus$3;
|
|
2165
|
+
accessRestriction?: {
|
|
2166
|
+
events?: {
|
|
2167
|
+
eventIds: string[];
|
|
2168
|
+
};
|
|
2169
|
+
type: Type$1;
|
|
2170
|
+
};
|
|
2171
|
+
details?: {
|
|
2172
|
+
logoPosition?: {
|
|
2173
|
+
x: number;
|
|
2174
|
+
y: number;
|
|
2175
|
+
};
|
|
2176
|
+
mobileLogoPosition?: {
|
|
2177
|
+
x: number;
|
|
2178
|
+
y: number;
|
|
2179
|
+
};
|
|
2180
|
+
};
|
|
2181
|
+
coverImage?: {
|
|
2182
|
+
position?: {
|
|
2183
|
+
x: number;
|
|
2184
|
+
y: number;
|
|
2185
|
+
};
|
|
2186
|
+
mobilePosition?: {
|
|
2187
|
+
x: number;
|
|
2188
|
+
y: number;
|
|
2189
|
+
};
|
|
2190
|
+
};
|
|
2191
|
+
settings?: {
|
|
2192
|
+
allowedToInviteMembers: AllowPolicy$1;
|
|
2193
|
+
allowedToApproveJoinRequests: AllowPolicy$1;
|
|
2194
|
+
allowedToAddMembers: AllowPolicy$1;
|
|
2195
|
+
allowedToCreatePosts: AllowPolicy$1;
|
|
2196
|
+
allowedToCommentPosts: AllowPolicy$1;
|
|
2197
|
+
onboardingStepsSettings: {
|
|
2198
|
+
stepKey: StepKey$3;
|
|
2199
|
+
visible: boolean;
|
|
2200
|
+
}[];
|
|
2201
|
+
};
|
|
2202
|
+
createdBy?: {
|
|
2203
|
+
identityType: IdentityType$3;
|
|
2204
|
+
};
|
|
2205
|
+
};
|
|
2206
|
+
status: RequestStatus$7;
|
|
2207
|
+
}[];
|
|
2208
|
+
}
|
|
2209
|
+
|
|
2210
|
+
/**
|
|
2211
|
+
* >**Notes:**
|
|
2212
|
+
* > + Site owners may set that members are not permitted to create groups in the Wix Groups application settings.
|
|
2213
|
+
* > + In this situation, site members have to submit a Group Request to create a new group.
|
|
2214
|
+
* > + Group Requests can be approved or rejected by an admin.
|
|
2215
|
+
* > + After a Group Request has been approved, the new group is added to the Group List in the Wix Groups app home page.
|
|
2216
|
+
* > + See [Introduction](https://dev.wix.com/api/rest/wix-groups/groups/introduction#wix-groups_groups_introduction_terminology) for more details.
|
|
2217
|
+
*/
|
|
2218
|
+
interface GroupRequest {
|
|
2219
|
+
/**
|
|
2220
|
+
* ID of the request to create a group. Same as group ID.
|
|
2221
|
+
* @readonly
|
|
2222
|
+
*/
|
|
2223
|
+
_id?: string | null;
|
|
2224
|
+
/** Group requested to create. */
|
|
2225
|
+
group?: Group$2;
|
|
2226
|
+
/**
|
|
2227
|
+
* Status of the request to create a group. One of:
|
|
2228
|
+
* - `"PENDING"` - Pending group request.
|
|
2229
|
+
* - `"APPROVED"` - Approved group request.
|
|
2230
|
+
* - `"REJECTED"` - Rejected group request.
|
|
2231
|
+
* - `"CANCELED"` - Canceled group request.
|
|
2232
|
+
*/
|
|
2233
|
+
status?: RequestStatus$6;
|
|
2234
|
+
/** Details of request to create a group. */
|
|
2235
|
+
requestDetails?: RequestDetails$6;
|
|
2236
|
+
}
|
|
2237
|
+
interface Group$2 {
|
|
2238
|
+
/**
|
|
2239
|
+
* Group ID.
|
|
2240
|
+
* @readonly
|
|
2241
|
+
*/
|
|
2242
|
+
_id?: string | null;
|
|
2243
|
+
/**
|
|
2244
|
+
* Part of a group's URL.
|
|
2245
|
+
*
|
|
2246
|
+
* For example, `'https:/example.com/groups/{my-group-slug}'`. Generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, `'https:/example.com/groups/{5D3yTX}'`. It is case-sensitive.
|
|
2247
|
+
*/
|
|
2248
|
+
slug?: string | null;
|
|
2249
|
+
/**
|
|
2250
|
+
* @internal
|
|
2251
|
+
* @internal
|
|
2252
|
+
* @deprecated
|
|
2253
|
+
*/
|
|
2254
|
+
privacyLevel?: PrivacyStatus$2;
|
|
2255
|
+
/**
|
|
2256
|
+
* Group privacy status.
|
|
2257
|
+
* - `"PUBLIC"` - Site visitors can see the group and its content in the list of groups. Members can join the group.
|
|
2258
|
+
* - `"PRIVATE"` - Site visitors can see the group in the list of groups, but only site members can see its content. Members can request to join the group.
|
|
2259
|
+
* - `"SECRET"` - Only admins and group members can see the group and its content in the list of groups. Members can only join a group if invited by group admins, or other group members.
|
|
2260
|
+
*/
|
|
2261
|
+
privacyStatus?: PrivacyStatus$2;
|
|
2262
|
+
/**
|
|
2263
|
+
* @interal
|
|
2264
|
+
* @interal
|
|
2265
|
+
* @deprecated
|
|
2266
|
+
*/
|
|
2267
|
+
title?: string | null;
|
|
2268
|
+
/** Group name. */
|
|
2269
|
+
name?: string | null;
|
|
2270
|
+
/** Group Description. */
|
|
2271
|
+
description?: string | null;
|
|
2272
|
+
/** Group teaser. */
|
|
2273
|
+
teaser?: string | null;
|
|
2274
|
+
/**
|
|
2275
|
+
* @internal
|
|
2276
|
+
* @internal
|
|
2277
|
+
* @deprecated
|
|
2278
|
+
*/
|
|
2279
|
+
details?: GroupDetails$2;
|
|
2280
|
+
/**
|
|
2281
|
+
* What group members are called.
|
|
2282
|
+
*
|
|
2283
|
+
* For example, 'Coworkers', 'Friends', or 'Students'.
|
|
2284
|
+
*/
|
|
2285
|
+
memberTitle?: string | null;
|
|
2286
|
+
/**
|
|
2287
|
+
* Group cover image. You cannot upload your own cover image.
|
|
2288
|
+
*
|
|
2289
|
+
*/
|
|
2290
|
+
coverImage?: CoverImage$2;
|
|
2291
|
+
/** Group settings. */
|
|
2292
|
+
settings?: GroupSettings$2;
|
|
2293
|
+
/**
|
|
2294
|
+
* Total number of members in the group.
|
|
2295
|
+
* @readonly
|
|
2296
|
+
*/
|
|
2297
|
+
membersCount?: number | null;
|
|
2298
|
+
/**
|
|
2299
|
+
* @internal
|
|
2300
|
+
* @internal
|
|
2301
|
+
* @readonly
|
|
2302
|
+
* @deprecated
|
|
2303
|
+
*/
|
|
2304
|
+
createdBy?: Identity$2;
|
|
2305
|
+
/**
|
|
2306
|
+
* Member ID of the group creator.
|
|
2307
|
+
* @readonly
|
|
2308
|
+
*/
|
|
2309
|
+
ownerId?: string | null;
|
|
2310
|
+
/**
|
|
2311
|
+
* Date and time the group was created.
|
|
2312
|
+
* @readonly
|
|
2313
|
+
*/
|
|
2314
|
+
_createdDate?: Date;
|
|
2315
|
+
/**
|
|
2316
|
+
* Date and time the group was last updated.
|
|
2317
|
+
* @readonly
|
|
2318
|
+
*/
|
|
2319
|
+
_updatedDate?: Date;
|
|
2320
|
+
/**
|
|
2321
|
+
* @internal
|
|
2322
|
+
* @internal
|
|
2323
|
+
* @readonly
|
|
2324
|
+
* @deprecated
|
|
2325
|
+
*/
|
|
2326
|
+
recentActivityDate?: Date;
|
|
2327
|
+
/**
|
|
2328
|
+
* Date and time the group was last active.
|
|
2329
|
+
*
|
|
2330
|
+
* For example, a post or comment made in the group.
|
|
2331
|
+
* @readonly
|
|
2332
|
+
*/
|
|
2333
|
+
lastActivityDate?: Date;
|
|
2334
|
+
}
|
|
2335
|
+
interface Logo$2 {
|
|
2336
|
+
/** Logo image ID (for internal use). */
|
|
2337
|
+
mediaId?: string | null;
|
|
2338
|
+
/** Logo image width. */
|
|
2339
|
+
width?: number | null;
|
|
2340
|
+
/** Logo image height. */
|
|
2341
|
+
height?: number | null;
|
|
2342
|
+
}
|
|
2343
|
+
interface Image$2 {
|
|
2344
|
+
/** Image ID (for internal use). */
|
|
2345
|
+
mediaId?: string | null;
|
|
2346
|
+
/** Image width. */
|
|
2347
|
+
width?: number | null;
|
|
2348
|
+
/** Image height. */
|
|
2349
|
+
height?: number | null;
|
|
2350
|
+
}
|
|
2351
|
+
interface Position$2 {
|
|
2352
|
+
/** horizontal coordinate */
|
|
2353
|
+
x?: number;
|
|
2354
|
+
/** vertical coordinate */
|
|
2355
|
+
y?: number;
|
|
2356
|
+
}
|
|
2357
|
+
interface OnboardingStepSettings$2 {
|
|
2358
|
+
stepKey?: StepKey$2;
|
|
2359
|
+
visible?: boolean;
|
|
2360
|
+
}
|
|
2361
|
+
declare enum StepKey$2 {
|
|
2362
|
+
UNKNOWN = "UNKNOWN",
|
|
2363
|
+
CREATE_POST = "CREATE_POST",
|
|
2364
|
+
REACT_TO_POST = "REACT_TO_POST",
|
|
2365
|
+
INVITE_MEMBERS = "INVITE_MEMBERS"
|
|
2366
|
+
}
|
|
2367
|
+
declare enum PrivacyStatus$2 {
|
|
2368
|
+
UNKNOWN = "UNKNOWN",
|
|
2369
|
+
/** Anyone can see the group in the group list and view its content. Anyone can join. */
|
|
2370
|
+
PUBLIC = "PUBLIC",
|
|
2371
|
+
/** Anyone can see the group in the group list, but only group members can see its content. In order to join a group, a group join request must be submitted. */
|
|
2372
|
+
PRIVATE = "PRIVATE",
|
|
2373
|
+
/** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */
|
|
2374
|
+
SECRET = "SECRET"
|
|
2375
|
+
}
|
|
2376
|
+
interface GroupDetails$2 {
|
|
2377
|
+
/** Group logo. You cannot upload your own logo. */
|
|
2378
|
+
logo?: Logo$2;
|
|
2379
|
+
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
2380
|
+
membersTitle?: string | null;
|
|
2381
|
+
}
|
|
2382
|
+
interface CoverImage$2 {
|
|
2383
|
+
/** Cover image. */
|
|
2384
|
+
image?: Image$2;
|
|
2385
|
+
/** Position of the corner of the cover image (or logo). */
|
|
2386
|
+
position?: Position$2;
|
|
2387
|
+
/** Position of the corner of the cover image (or logo) for mobile browser. */
|
|
2388
|
+
mobilePosition?: Position$2;
|
|
2389
|
+
}
|
|
2390
|
+
interface GroupSettings$2 {
|
|
2391
|
+
/**
|
|
2392
|
+
* Whether group members can send an email inviting others to join the group. When `false`, only site admins and group admins can invite others to join the group.
|
|
2393
|
+
*
|
|
2394
|
+
* Default: `false`
|
|
2395
|
+
* @deprecated
|
|
2396
|
+
*/
|
|
2397
|
+
membersCanInvite?: boolean | null;
|
|
2398
|
+
/**
|
|
2399
|
+
* Whether group members can approve or reject requests to join a group. When `false`, only site admins and group admins can approve or reject requests to join a group.
|
|
2400
|
+
*
|
|
2401
|
+
* Default: `false`
|
|
2402
|
+
* @deprecated
|
|
2403
|
+
*/
|
|
2404
|
+
membersCanApprove?: boolean | null;
|
|
2405
|
+
/**
|
|
2406
|
+
* @internal
|
|
2407
|
+
* @internal
|
|
2408
|
+
* @deprecated
|
|
2409
|
+
*/
|
|
2410
|
+
memberWelcomePostEnabled?: boolean | null;
|
|
2411
|
+
/**
|
|
2412
|
+
* Whether to create a daily group post welcoming new members.
|
|
2413
|
+
*
|
|
2414
|
+
* Default: `true`
|
|
2415
|
+
*/
|
|
2416
|
+
welcomeMemberPostEnabled?: boolean | null;
|
|
2417
|
+
/**
|
|
2418
|
+
* Whether to create an automatic group post when group details are changed.
|
|
2419
|
+
*
|
|
2420
|
+
* Default: `true`
|
|
2421
|
+
*/
|
|
2422
|
+
groupDetailsChangedPostEnabled?: boolean | null;
|
|
2423
|
+
/**
|
|
2424
|
+
* Whether all group members can view the full list of group members.
|
|
2425
|
+
*
|
|
2426
|
+
* Default: `true`
|
|
2427
|
+
*/
|
|
2428
|
+
showMemberList?: boolean | null;
|
|
2429
|
+
onboardingStepsSettings?: OnboardingStepSettings$2[];
|
|
2430
|
+
}
|
|
2431
|
+
interface Identity$2 {
|
|
2432
|
+
/** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
2433
|
+
_id?: string | null;
|
|
2434
|
+
identityType?: IdentityType$2;
|
|
2435
|
+
}
|
|
2436
|
+
declare enum IdentityType$2 {
|
|
2437
|
+
USER = "USER",
|
|
2438
|
+
MEMBER = "MEMBER"
|
|
2439
|
+
}
|
|
2440
|
+
declare enum RequestStatus$6 {
|
|
2441
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2442
|
+
/** Pending request. */
|
|
2443
|
+
PENDING = "PENDING",
|
|
2444
|
+
/** Approved request. */
|
|
2445
|
+
APPROVED = "APPROVED",
|
|
2446
|
+
/** Rejected request. */
|
|
2447
|
+
REJECTED = "REJECTED",
|
|
2448
|
+
/** Cancelled request. */
|
|
2449
|
+
CANCELLED = "CANCELLED",
|
|
2450
|
+
/** Canceled request. */
|
|
2451
|
+
CANCELED = "CANCELED"
|
|
2452
|
+
}
|
|
2453
|
+
interface RequestDetails$6 {
|
|
2454
|
+
/** Reason the request to create a group is rejected. */
|
|
2455
|
+
rejectionReason?: string | null;
|
|
2456
|
+
}
|
|
2457
|
+
interface ApproveGroupRequestsRequest {
|
|
2458
|
+
/**
|
|
2459
|
+
* IDs of the requests create groups to approve.
|
|
2460
|
+
*
|
|
2461
|
+
* Max: 100 create group request IDs
|
|
2462
|
+
*/
|
|
2463
|
+
groupRequestIds?: string[];
|
|
2464
|
+
}
|
|
2465
|
+
interface ApproveGroupRequestsResponse {
|
|
2466
|
+
/** Approved request to create a group. */
|
|
2467
|
+
groupRequest?: GroupRequest[];
|
|
2468
|
+
}
|
|
2469
|
+
interface RejectGroupRequestsRequest {
|
|
2470
|
+
/** Rejection data. */
|
|
2471
|
+
rejections?: Rejection$6[];
|
|
2472
|
+
}
|
|
2473
|
+
interface Rejection$6 {
|
|
2474
|
+
/**
|
|
2475
|
+
* ID of the requests to create groups to reject.
|
|
2476
|
+
*
|
|
2477
|
+
*/
|
|
2478
|
+
groupRequestId?: string;
|
|
2479
|
+
/**
|
|
2480
|
+
* Reason the request to create a group is rejected. This text is displayed to the creator of the rejected request.
|
|
2481
|
+
*
|
|
2482
|
+
* Max: 1,000 characters.
|
|
2483
|
+
*/
|
|
2484
|
+
reason?: string | null;
|
|
2485
|
+
}
|
|
2486
|
+
interface RejectGroupRequestsResponse {
|
|
2487
|
+
/** Rejected Group Requests. */
|
|
2488
|
+
groupRequest?: GroupRequest[];
|
|
2489
|
+
}
|
|
2490
|
+
interface ListGroupRequestsRequest {
|
|
2491
|
+
/** Number of items to load. Maximum `100`. */
|
|
2492
|
+
limit?: number | null;
|
|
2493
|
+
/** Number of items to skip in the current sort order. */
|
|
2494
|
+
offset?: number | null;
|
|
2495
|
+
}
|
|
2496
|
+
interface ListGroupRequestsResponse {
|
|
2497
|
+
/** List of requests to create a group. */
|
|
2498
|
+
groupRequests?: GroupRequest[];
|
|
2499
|
+
/** Paging information. */
|
|
2500
|
+
metadata?: PagingMetadata$8;
|
|
2501
|
+
}
|
|
2502
|
+
interface PagingMetadata$8 {
|
|
2503
|
+
/** Number of items returned in the response. */
|
|
2504
|
+
count?: number | null;
|
|
2505
|
+
/** Offset that was requested. */
|
|
2506
|
+
offset?: number | null;
|
|
2507
|
+
/** Total number of items that match the query. */
|
|
2508
|
+
total?: number | null;
|
|
2509
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
2510
|
+
tooManyToCount?: boolean | null;
|
|
2511
|
+
}
|
|
2512
|
+
interface QueryGroupRequestsRequest {
|
|
2513
|
+
query?: Query$6;
|
|
2514
|
+
}
|
|
2515
|
+
interface Query$6 {
|
|
2516
|
+
/**
|
|
2517
|
+
* Filter object in the following format:
|
|
2518
|
+
* `"filter" : {
|
|
2519
|
+
* "fieldName1": "value1",
|
|
2520
|
+
* "fieldName2":{"$operator":"value2"}
|
|
2521
|
+
* }`
|
|
2522
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
2523
|
+
*/
|
|
2524
|
+
filter?: any;
|
|
2525
|
+
/**
|
|
2526
|
+
* Sort object in the following format:
|
|
2527
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
2528
|
+
*/
|
|
2529
|
+
sort?: Sorting$6[];
|
|
2530
|
+
/** Paging options to limit and skip the number of items. */
|
|
2531
|
+
paging?: Paging$8;
|
|
2532
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
2533
|
+
fields?: string[];
|
|
2534
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
2535
|
+
fieldsets?: string[];
|
|
2536
|
+
}
|
|
2537
|
+
interface Sorting$6 {
|
|
2538
|
+
/** Name of the field to sort by. */
|
|
2539
|
+
fieldName?: string;
|
|
2540
|
+
/** Sort order. */
|
|
2541
|
+
order?: SortOrder$6;
|
|
2542
|
+
}
|
|
2543
|
+
declare enum SortOrder$6 {
|
|
2544
|
+
ASC = "ASC",
|
|
2545
|
+
DESC = "DESC"
|
|
2546
|
+
}
|
|
2547
|
+
interface Paging$8 {
|
|
2548
|
+
/**
|
|
2549
|
+
* Number of items to load.
|
|
2550
|
+
*
|
|
2551
|
+
* Max: `100`
|
|
2552
|
+
*/
|
|
2553
|
+
limit?: number | null;
|
|
2554
|
+
/**
|
|
2555
|
+
* Number of items to skip in the current sort order.
|
|
2556
|
+
*
|
|
2557
|
+
*/
|
|
2558
|
+
offset?: number | null;
|
|
2559
|
+
}
|
|
2560
|
+
interface QueryGroupRequestsResponse {
|
|
2561
|
+
/** Retrieved Group Requests. */
|
|
2562
|
+
groupRequests?: GroupRequest[];
|
|
2563
|
+
metadata?: PagingMetadata$8;
|
|
2564
|
+
}
|
|
2565
|
+
interface ApproveGroupRequestsResponseNonNullableFields {
|
|
2566
|
+
groupRequest: {
|
|
2567
|
+
group?: {
|
|
2568
|
+
privacyLevel: PrivacyStatus$2;
|
|
2569
|
+
privacyStatus: PrivacyStatus$2;
|
|
2570
|
+
coverImage?: {
|
|
2571
|
+
position?: {
|
|
2572
|
+
x: number;
|
|
2573
|
+
y: number;
|
|
2574
|
+
};
|
|
2575
|
+
mobilePosition?: {
|
|
2576
|
+
x: number;
|
|
2577
|
+
y: number;
|
|
2578
|
+
};
|
|
2579
|
+
};
|
|
2580
|
+
settings?: {
|
|
2581
|
+
onboardingStepsSettings: {
|
|
2582
|
+
stepKey: StepKey$2;
|
|
2583
|
+
visible: boolean;
|
|
2584
|
+
}[];
|
|
2585
|
+
};
|
|
2586
|
+
createdBy?: {
|
|
2587
|
+
identityType: IdentityType$2;
|
|
2588
|
+
};
|
|
2589
|
+
};
|
|
2590
|
+
status: RequestStatus$6;
|
|
2591
|
+
}[];
|
|
2592
|
+
}
|
|
2593
|
+
interface RejectGroupRequestsResponseNonNullableFields {
|
|
2594
|
+
groupRequest: {
|
|
2595
|
+
group?: {
|
|
2596
|
+
privacyLevel: PrivacyStatus$2;
|
|
2597
|
+
privacyStatus: PrivacyStatus$2;
|
|
2598
|
+
coverImage?: {
|
|
2599
|
+
position?: {
|
|
2600
|
+
x: number;
|
|
2601
|
+
y: number;
|
|
2602
|
+
};
|
|
2603
|
+
mobilePosition?: {
|
|
2604
|
+
x: number;
|
|
2605
|
+
y: number;
|
|
2606
|
+
};
|
|
2607
|
+
};
|
|
2608
|
+
settings?: {
|
|
2609
|
+
onboardingStepsSettings: {
|
|
2610
|
+
stepKey: StepKey$2;
|
|
2611
|
+
visible: boolean;
|
|
2612
|
+
}[];
|
|
2613
|
+
};
|
|
2614
|
+
createdBy?: {
|
|
2615
|
+
identityType: IdentityType$2;
|
|
2616
|
+
};
|
|
2617
|
+
};
|
|
2618
|
+
status: RequestStatus$6;
|
|
2619
|
+
}[];
|
|
2620
|
+
}
|
|
2621
|
+
interface ListGroupRequestsResponseNonNullableFields {
|
|
2622
|
+
groupRequests: {
|
|
2623
|
+
group?: {
|
|
2624
|
+
privacyLevel: PrivacyStatus$2;
|
|
2625
|
+
privacyStatus: PrivacyStatus$2;
|
|
2626
|
+
coverImage?: {
|
|
2627
|
+
position?: {
|
|
2628
|
+
x: number;
|
|
2629
|
+
y: number;
|
|
2630
|
+
};
|
|
2631
|
+
mobilePosition?: {
|
|
2632
|
+
x: number;
|
|
2633
|
+
y: number;
|
|
2634
|
+
};
|
|
2635
|
+
};
|
|
2636
|
+
settings?: {
|
|
2637
|
+
onboardingStepsSettings: {
|
|
2638
|
+
stepKey: StepKey$2;
|
|
2639
|
+
visible: boolean;
|
|
2640
|
+
}[];
|
|
2641
|
+
};
|
|
2642
|
+
createdBy?: {
|
|
2643
|
+
identityType: IdentityType$2;
|
|
2644
|
+
};
|
|
2645
|
+
};
|
|
2646
|
+
status: RequestStatus$6;
|
|
2647
|
+
}[];
|
|
2648
|
+
}
|
|
2649
|
+
interface QueryGroupRequestsResponseNonNullableFields {
|
|
2650
|
+
groupRequests: {
|
|
2651
|
+
group?: {
|
|
2652
|
+
privacyLevel: PrivacyStatus$2;
|
|
2653
|
+
privacyStatus: PrivacyStatus$2;
|
|
2654
|
+
coverImage?: {
|
|
2655
|
+
position?: {
|
|
2656
|
+
x: number;
|
|
2657
|
+
y: number;
|
|
2658
|
+
};
|
|
2659
|
+
mobilePosition?: {
|
|
2660
|
+
x: number;
|
|
2661
|
+
y: number;
|
|
2662
|
+
};
|
|
2663
|
+
};
|
|
2664
|
+
settings?: {
|
|
2665
|
+
onboardingStepsSettings: {
|
|
2666
|
+
stepKey: StepKey$2;
|
|
2667
|
+
visible: boolean;
|
|
2668
|
+
}[];
|
|
2669
|
+
};
|
|
2670
|
+
createdBy?: {
|
|
2671
|
+
identityType: IdentityType$2;
|
|
2672
|
+
};
|
|
2673
|
+
};
|
|
2674
|
+
status: RequestStatus$6;
|
|
2675
|
+
}[];
|
|
2676
|
+
}
|
|
2677
|
+
|
|
2678
|
+
type __PublicMethodMetaInfo$6<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2679
|
+
getUrl: (context: any) => string;
|
|
2680
|
+
httpMethod: K;
|
|
2681
|
+
path: string;
|
|
2682
|
+
pathParams: M;
|
|
2683
|
+
__requestType: T;
|
|
2684
|
+
__originalRequestType: S;
|
|
2685
|
+
__responseType: Q;
|
|
2686
|
+
__originalResponseType: R;
|
|
2687
|
+
};
|
|
2688
|
+
declare function approveGroupRequests(): __PublicMethodMetaInfo$6<'POST', {}, ApproveGroupRequestsRequest, ApproveGroupRequestsRequest$1, ApproveGroupRequestsResponse & ApproveGroupRequestsResponseNonNullableFields, ApproveGroupRequestsResponse$1 & ApproveGroupRequestsResponseNonNullableFields$1>;
|
|
2689
|
+
declare function rejectGroupRequests(): __PublicMethodMetaInfo$6<'POST', {}, RejectGroupRequestsRequest, RejectGroupRequestsRequest$1, RejectGroupRequestsResponse & RejectGroupRequestsResponseNonNullableFields, RejectGroupRequestsResponse$1 & RejectGroupRequestsResponseNonNullableFields$1>;
|
|
2690
|
+
declare function listGroupRequests(): __PublicMethodMetaInfo$6<'GET', {}, ListGroupRequestsRequest, ListGroupRequestsRequest$1, ListGroupRequestsResponse & ListGroupRequestsResponseNonNullableFields, ListGroupRequestsResponse$1 & ListGroupRequestsResponseNonNullableFields$1>;
|
|
2691
|
+
declare function queryGroupRequests(): __PublicMethodMetaInfo$6<'POST', {}, QueryGroupRequestsRequest, QueryGroupRequestsRequest$1, QueryGroupRequestsResponse & QueryGroupRequestsResponseNonNullableFields, QueryGroupRequestsResponse$1 & QueryGroupRequestsResponseNonNullableFields$1>;
|
|
2692
|
+
|
|
2693
|
+
declare const meta$6_approveGroupRequests: typeof approveGroupRequests;
|
|
2694
|
+
declare const meta$6_listGroupRequests: typeof listGroupRequests;
|
|
2695
|
+
declare const meta$6_queryGroupRequests: typeof queryGroupRequests;
|
|
2696
|
+
declare const meta$6_rejectGroupRequests: typeof rejectGroupRequests;
|
|
2697
|
+
declare namespace meta$6 {
|
|
2698
|
+
export { type __PublicMethodMetaInfo$6 as __PublicMethodMetaInfo, meta$6_approveGroupRequests as approveGroupRequests, meta$6_listGroupRequests as listGroupRequests, meta$6_queryGroupRequests as queryGroupRequests, meta$6_rejectGroupRequests as rejectGroupRequests };
|
|
2699
|
+
}
|
|
2700
|
+
|
|
2701
|
+
/**
|
|
2702
|
+
* A group member may have multiple roles in a single group.
|
|
2703
|
+
* Currently, only `MEMBER` and `ADMIN` roles are supported, but more roles may be available in the future.
|
|
2704
|
+
*/
|
|
2705
|
+
interface GroupRole$1 {
|
|
2706
|
+
/**
|
|
2707
|
+
* Member's role.
|
|
2708
|
+
* - `MEMBER` - Regular group member.
|
|
2709
|
+
* - `ADMIN` - Group administrator.
|
|
2710
|
+
*/
|
|
2711
|
+
value?: Role$1;
|
|
2712
|
+
}
|
|
2713
|
+
declare enum Role$1 {
|
|
2714
|
+
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
2715
|
+
/** Regular group member. */
|
|
2716
|
+
MEMBER = "MEMBER",
|
|
2717
|
+
/** Group administrator. */
|
|
2718
|
+
ADMIN = "ADMIN"
|
|
2719
|
+
}
|
|
2720
|
+
interface AssignRoleRequest$1 {
|
|
2721
|
+
/** Group ID. */
|
|
2722
|
+
groupId: string;
|
|
2723
|
+
/**
|
|
2724
|
+
* __Deprecated.__ Use `memberIds` instead.
|
|
2725
|
+
* This parameter will be removed on June 30, 2022.
|
|
2726
|
+
* @deprecated
|
|
2727
|
+
*/
|
|
2728
|
+
siteMemberIds?: string[];
|
|
2729
|
+
/** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
|
|
2730
|
+
memberIds?: string[];
|
|
2731
|
+
/** Role to assign. */
|
|
2732
|
+
role?: GroupRole$1;
|
|
2733
|
+
}
|
|
2734
|
+
interface AssignRoleResponse$1 {
|
|
2735
|
+
/** Group ID. */
|
|
2736
|
+
groupId?: string;
|
|
2737
|
+
/**
|
|
2738
|
+
* __Deprecated.__ Use `memberIds` instead.
|
|
2739
|
+
* This parameter will be removed on June 30, 2022.
|
|
2740
|
+
* @deprecated
|
|
2741
|
+
*/
|
|
2742
|
+
siteMemberIds?: string[];
|
|
2743
|
+
/** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
|
|
2744
|
+
memberIds?: string[];
|
|
2745
|
+
/** Assigned role. */
|
|
2746
|
+
role?: GroupRole$1;
|
|
2747
|
+
}
|
|
2748
|
+
interface UnassignRoleRequest$1 {
|
|
2749
|
+
/** Group ID. */
|
|
2750
|
+
groupId: string;
|
|
2751
|
+
/**
|
|
2752
|
+
* __Deprecated.__ Use `memberIds` instead.
|
|
2753
|
+
* This parameter will be removed on June 30, 2022.
|
|
2754
|
+
* @deprecated
|
|
2755
|
+
*/
|
|
2756
|
+
siteMemberIds?: string[];
|
|
2757
|
+
/** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
|
|
2758
|
+
memberIds?: string[];
|
|
2759
|
+
/** Role to unassign. */
|
|
2760
|
+
role?: GroupRole$1;
|
|
2761
|
+
}
|
|
2762
|
+
interface UnassignRoleResponse$1 {
|
|
2763
|
+
/** Group ID. */
|
|
2764
|
+
groupId?: string;
|
|
2765
|
+
/**
|
|
2766
|
+
* Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
|
|
2767
|
+
* @deprecated
|
|
2768
|
+
*/
|
|
2769
|
+
siteMemberIds?: string[];
|
|
2770
|
+
/** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
|
|
2771
|
+
memberIds?: string[];
|
|
2772
|
+
/** Unassigned role. */
|
|
2773
|
+
role?: GroupRole$1;
|
|
2774
|
+
}
|
|
2775
|
+
interface AssignRoleResponseNonNullableFields$1 {
|
|
2776
|
+
groupId: string;
|
|
2777
|
+
siteMemberIds: string[];
|
|
2778
|
+
memberIds: string[];
|
|
2779
|
+
role?: {
|
|
2780
|
+
value: Role$1;
|
|
2781
|
+
};
|
|
2782
|
+
}
|
|
2783
|
+
interface UnassignRoleResponseNonNullableFields$1 {
|
|
2784
|
+
groupId: string;
|
|
2785
|
+
siteMemberIds: string[];
|
|
2786
|
+
memberIds: string[];
|
|
2787
|
+
role?: {
|
|
2788
|
+
value: Role$1;
|
|
2789
|
+
};
|
|
2790
|
+
}
|
|
2791
|
+
|
|
2792
|
+
/**
|
|
2793
|
+
* A group member may have multiple roles in a single group.
|
|
2794
|
+
* Currently, only `MEMBER` and `ADMIN` roles are supported, but more roles may be available in the future.
|
|
2795
|
+
*/
|
|
2796
|
+
interface GroupRole {
|
|
2797
|
+
/**
|
|
2798
|
+
* Member's role.
|
|
2799
|
+
* - `MEMBER` - Regular group member.
|
|
2800
|
+
* - `ADMIN` - Group administrator.
|
|
2801
|
+
*/
|
|
2802
|
+
value?: Role;
|
|
2803
|
+
}
|
|
2804
|
+
declare enum Role {
|
|
2805
|
+
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
2806
|
+
/** Regular group member. */
|
|
2807
|
+
MEMBER = "MEMBER",
|
|
2808
|
+
/** Group administrator. */
|
|
2809
|
+
ADMIN = "ADMIN"
|
|
2810
|
+
}
|
|
2811
|
+
interface AssignRoleRequest {
|
|
2812
|
+
/** Group ID. */
|
|
2813
|
+
groupId: string;
|
|
2814
|
+
/**
|
|
2815
|
+
* @internal
|
|
2816
|
+
* @internal
|
|
2817
|
+
* @deprecated
|
|
2818
|
+
*/
|
|
2819
|
+
siteMemberIds?: string[];
|
|
2820
|
+
/**
|
|
2821
|
+
* Member IDs.
|
|
2822
|
+
*
|
|
2823
|
+
* Max: 100 member IDs
|
|
2824
|
+
*/
|
|
2825
|
+
memberIds?: string[];
|
|
2826
|
+
/** Role to assign. */
|
|
2827
|
+
role?: GroupRole;
|
|
2828
|
+
}
|
|
2829
|
+
interface AssignRoleResponse {
|
|
2830
|
+
/** Group ID. */
|
|
2831
|
+
groupId?: string;
|
|
2832
|
+
/**
|
|
2833
|
+
* @internal
|
|
2834
|
+
* @internal
|
|
2835
|
+
* @deprecated
|
|
2836
|
+
*/
|
|
2837
|
+
siteMemberIds?: string[];
|
|
2838
|
+
/** Member IDs */
|
|
2839
|
+
memberIds?: string[];
|
|
2840
|
+
/** Assigned role. */
|
|
2841
|
+
role?: GroupRole;
|
|
2842
|
+
}
|
|
2843
|
+
interface UnassignRoleRequest {
|
|
2844
|
+
/** Group ID. */
|
|
2845
|
+
groupId: string;
|
|
2846
|
+
/**
|
|
2847
|
+
* @internal
|
|
2848
|
+
* @internal
|
|
2849
|
+
* @deprecated
|
|
2850
|
+
*/
|
|
2851
|
+
siteMemberIds?: string[];
|
|
2852
|
+
/**
|
|
2853
|
+
* Member IDs.
|
|
2854
|
+
*
|
|
2855
|
+
* Max: 100 member IDs
|
|
2856
|
+
*/
|
|
2857
|
+
memberIds?: string[];
|
|
2858
|
+
/** Role to unassign. */
|
|
2859
|
+
role?: GroupRole;
|
|
2860
|
+
}
|
|
2861
|
+
interface UnassignRoleResponse {
|
|
2862
|
+
/** Group ID. */
|
|
2863
|
+
groupId?: string;
|
|
2864
|
+
/**
|
|
2865
|
+
* @internal
|
|
2866
|
+
* @internal
|
|
2867
|
+
* @deprecated
|
|
2868
|
+
*/
|
|
2869
|
+
siteMemberIds?: string[];
|
|
2870
|
+
/** Member IDs. */
|
|
2871
|
+
memberIds?: string[];
|
|
2872
|
+
/** Unassigned role. */
|
|
2873
|
+
role?: GroupRole;
|
|
2874
|
+
}
|
|
2875
|
+
interface AssignRoleResponseNonNullableFields {
|
|
2876
|
+
groupId: string;
|
|
2877
|
+
siteMemberIds: string[];
|
|
2878
|
+
memberIds: string[];
|
|
2879
|
+
role?: {
|
|
2880
|
+
value: Role;
|
|
2881
|
+
};
|
|
2882
|
+
}
|
|
2883
|
+
interface UnassignRoleResponseNonNullableFields {
|
|
2884
|
+
groupId: string;
|
|
2885
|
+
siteMemberIds: string[];
|
|
2886
|
+
memberIds: string[];
|
|
2887
|
+
role?: {
|
|
2888
|
+
value: Role;
|
|
2889
|
+
};
|
|
2890
|
+
}
|
|
2891
|
+
|
|
2892
|
+
type __PublicMethodMetaInfo$5<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2893
|
+
getUrl: (context: any) => string;
|
|
2894
|
+
httpMethod: K;
|
|
2895
|
+
path: string;
|
|
2896
|
+
pathParams: M;
|
|
2897
|
+
__requestType: T;
|
|
2898
|
+
__originalRequestType: S;
|
|
2899
|
+
__responseType: Q;
|
|
2900
|
+
__originalResponseType: R;
|
|
2901
|
+
};
|
|
2902
|
+
declare function assignRole(): __PublicMethodMetaInfo$5<'POST', {
|
|
2903
|
+
groupId: string;
|
|
2904
|
+
}, AssignRoleRequest, AssignRoleRequest$1, AssignRoleResponse & AssignRoleResponseNonNullableFields, AssignRoleResponse$1 & AssignRoleResponseNonNullableFields$1>;
|
|
2905
|
+
declare function unassignRole(): __PublicMethodMetaInfo$5<'POST', {
|
|
2906
|
+
groupId: string;
|
|
2907
|
+
}, UnassignRoleRequest, UnassignRoleRequest$1, UnassignRoleResponse & UnassignRoleResponseNonNullableFields, UnassignRoleResponse$1 & UnassignRoleResponseNonNullableFields$1>;
|
|
2908
|
+
|
|
2909
|
+
declare const meta$5_assignRole: typeof assignRole;
|
|
2910
|
+
declare const meta$5_unassignRole: typeof unassignRole;
|
|
2911
|
+
declare namespace meta$5 {
|
|
2912
|
+
export { type __PublicMethodMetaInfo$5 as __PublicMethodMetaInfo, meta$5_assignRole as assignRole, meta$5_unassignRole as unassignRole };
|
|
2913
|
+
}
|
|
2914
|
+
|
|
2915
|
+
interface GroupRule$1 {
|
|
2916
|
+
/** Rule title. */
|
|
2917
|
+
title?: string;
|
|
2918
|
+
/** Rule description. */
|
|
2919
|
+
description?: string;
|
|
2920
|
+
}
|
|
2921
|
+
interface ListRulesRequest$1 {
|
|
2922
|
+
/** Group ID. */
|
|
2923
|
+
groupId: string;
|
|
2924
|
+
}
|
|
2925
|
+
interface ListRulesResponse$1 {
|
|
2926
|
+
/** Retrieved rules. */
|
|
2927
|
+
rules?: GroupRule$1[];
|
|
2928
|
+
}
|
|
2929
|
+
interface CreateOrReplaceAllRulesRequest$1 {
|
|
2930
|
+
/** Group ID. */
|
|
2931
|
+
groupId: string;
|
|
2932
|
+
/** New rules. */
|
|
2933
|
+
rules?: GroupRule$1[];
|
|
2934
|
+
}
|
|
2935
|
+
interface CreateOrReplaceAllRulesResponse$1 {
|
|
2936
|
+
/** Group ID. */
|
|
2937
|
+
groupId?: string;
|
|
2938
|
+
/** Rules. */
|
|
2939
|
+
rules?: GroupRule$1[];
|
|
2940
|
+
}
|
|
2941
|
+
interface ListRulesResponseNonNullableFields$1 {
|
|
2942
|
+
rules: {
|
|
2943
|
+
title: string;
|
|
2944
|
+
description: string;
|
|
2945
|
+
}[];
|
|
2946
|
+
}
|
|
2947
|
+
interface CreateOrReplaceAllRulesResponseNonNullableFields$1 {
|
|
2948
|
+
groupId: string;
|
|
2949
|
+
rules: {
|
|
2950
|
+
title: string;
|
|
2951
|
+
description: string;
|
|
2952
|
+
}[];
|
|
2953
|
+
}
|
|
2954
|
+
|
|
2955
|
+
interface GroupRule {
|
|
2956
|
+
/** Rule title. */
|
|
2957
|
+
title?: string;
|
|
2958
|
+
/** Rule description. */
|
|
2959
|
+
description?: string;
|
|
2960
|
+
}
|
|
2961
|
+
interface ListRulesRequest {
|
|
2962
|
+
/** Group ID. */
|
|
2963
|
+
groupId: string;
|
|
2964
|
+
}
|
|
2965
|
+
interface ListRulesResponse {
|
|
2966
|
+
/** Retrieved rules. */
|
|
2967
|
+
rules?: GroupRule[];
|
|
2968
|
+
}
|
|
2969
|
+
interface CreateOrReplaceAllRulesRequest {
|
|
2970
|
+
/** Group ID. */
|
|
2971
|
+
groupId: string;
|
|
2972
|
+
/** New rules. */
|
|
2973
|
+
rules?: GroupRule[];
|
|
2974
|
+
}
|
|
2975
|
+
interface CreateOrReplaceAllRulesResponse {
|
|
2976
|
+
/** Group ID. */
|
|
2977
|
+
groupId?: string;
|
|
2978
|
+
/** Rules. */
|
|
2979
|
+
rules?: GroupRule[];
|
|
2980
|
+
}
|
|
2981
|
+
interface ListRulesResponseNonNullableFields {
|
|
2982
|
+
rules: {
|
|
2983
|
+
title: string;
|
|
2984
|
+
description: string;
|
|
2985
|
+
}[];
|
|
2986
|
+
}
|
|
2987
|
+
interface CreateOrReplaceAllRulesResponseNonNullableFields {
|
|
2988
|
+
groupId: string;
|
|
2989
|
+
rules: {
|
|
2990
|
+
title: string;
|
|
2991
|
+
description: string;
|
|
2992
|
+
}[];
|
|
2993
|
+
}
|
|
2994
|
+
|
|
2995
|
+
type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2996
|
+
getUrl: (context: any) => string;
|
|
2997
|
+
httpMethod: K;
|
|
2998
|
+
path: string;
|
|
2999
|
+
pathParams: M;
|
|
3000
|
+
__requestType: T;
|
|
3001
|
+
__originalRequestType: S;
|
|
3002
|
+
__responseType: Q;
|
|
3003
|
+
__originalResponseType: R;
|
|
3004
|
+
};
|
|
3005
|
+
declare function listRules(): __PublicMethodMetaInfo$4<'GET', {
|
|
3006
|
+
groupId: string;
|
|
3007
|
+
}, ListRulesRequest, ListRulesRequest$1, ListRulesResponse & ListRulesResponseNonNullableFields, ListRulesResponse$1 & ListRulesResponseNonNullableFields$1>;
|
|
3008
|
+
declare function createOrReplaceAllRules(): __PublicMethodMetaInfo$4<'PUT', {
|
|
3009
|
+
groupId: string;
|
|
3010
|
+
}, CreateOrReplaceAllRulesRequest, CreateOrReplaceAllRulesRequest$1, CreateOrReplaceAllRulesResponse & CreateOrReplaceAllRulesResponseNonNullableFields, CreateOrReplaceAllRulesResponse$1 & CreateOrReplaceAllRulesResponseNonNullableFields$1>;
|
|
3011
|
+
|
|
3012
|
+
declare const meta$4_createOrReplaceAllRules: typeof createOrReplaceAllRules;
|
|
3013
|
+
declare const meta$4_listRules: typeof listRules;
|
|
3014
|
+
declare namespace meta$4 {
|
|
3015
|
+
export { type __PublicMethodMetaInfo$4 as __PublicMethodMetaInfo, meta$4_createOrReplaceAllRules as createOrReplaceAllRules, meta$4_listRules as listRules };
|
|
3016
|
+
}
|
|
3017
|
+
|
|
3018
|
+
/**
|
|
3019
|
+
* To join a private group, a site member must submit a Join Request, which can be approved or rejected by an admin.
|
|
3020
|
+
* When the request is approved, the site member becomes a group member.
|
|
3021
|
+
*/
|
|
3022
|
+
interface JoinGroupRequest$1 {
|
|
3023
|
+
/**
|
|
3024
|
+
* Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.
|
|
3025
|
+
* @readonly
|
|
3026
|
+
*/
|
|
3027
|
+
siteMemberId?: string;
|
|
3028
|
+
/** @readonly */
|
|
3029
|
+
contactId?: string;
|
|
3030
|
+
/**
|
|
3031
|
+
* Join group request status.
|
|
3032
|
+
* - `PENDING` - Pending join group request.
|
|
3033
|
+
* - `APPROVED` - Approved join group request.
|
|
3034
|
+
* - `REJECTED` - Rejected join group request.
|
|
3035
|
+
* - `CANCELED` - Canceled join group request.
|
|
3036
|
+
*/
|
|
3037
|
+
status?: RequestStatus$5;
|
|
3038
|
+
/** Join group request details. */
|
|
3039
|
+
requestDetails?: RequestDetails$5;
|
|
3040
|
+
}
|
|
3041
|
+
declare enum RequestStatus$5 {
|
|
3042
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3043
|
+
/** Pending request. */
|
|
3044
|
+
PENDING = "PENDING",
|
|
3045
|
+
/** Approved request. */
|
|
3046
|
+
APPROVED = "APPROVED",
|
|
3047
|
+
/** Rejected request. */
|
|
3048
|
+
REJECTED = "REJECTED",
|
|
3049
|
+
/** Cancelled request. */
|
|
3050
|
+
CANCELLED = "CANCELLED",
|
|
3051
|
+
/** Canceled request. */
|
|
3052
|
+
CANCELED = "CANCELED"
|
|
3053
|
+
}
|
|
3054
|
+
interface RequestDetails$5 {
|
|
3055
|
+
/** Reason the request has been rejected. */
|
|
3056
|
+
rejectionReason?: string | null;
|
|
3057
|
+
}
|
|
3058
|
+
interface ApproveJoinGroupRequestsRequest$1 {
|
|
3059
|
+
/** Relevant group. */
|
|
3060
|
+
groupId: string;
|
|
3061
|
+
/**
|
|
3062
|
+
* __Deprecated.__ Use `memberIds` instead.
|
|
3063
|
+
* This parameter will be removed on June 30, 2022.
|
|
3064
|
+
*
|
|
3065
|
+
* Required if `memberIds` is not provided.
|
|
3066
|
+
* @deprecated
|
|
3067
|
+
*/
|
|
3068
|
+
siteMemberIds?: string[];
|
|
3069
|
+
/**
|
|
3070
|
+
* Member IDs to approve.
|
|
3071
|
+
*
|
|
3072
|
+
* <blockquote class='important'>
|
|
3073
|
+
*
|
|
3074
|
+
* __Important:__
|
|
3075
|
+
* This parameter will be required after the deprecated `siteMemberIds` is removed
|
|
3076
|
+
* on June 30, 2022.
|
|
3077
|
+
*
|
|
3078
|
+
* </blockquote>
|
|
3079
|
+
*/
|
|
3080
|
+
memberIds?: string[];
|
|
3081
|
+
}
|
|
3082
|
+
interface ApproveJoinGroupRequestsResponse$1 {
|
|
3083
|
+
/** Approved join group requests. */
|
|
3084
|
+
joinGroupRequests?: JoinGroupRequest$1[];
|
|
3085
|
+
}
|
|
3086
|
+
interface RejectJoinGroupRequestsRequest$1 {
|
|
3087
|
+
/** Relevant group. */
|
|
3088
|
+
groupId: string;
|
|
3089
|
+
/** Rejection data. */
|
|
3090
|
+
rejections?: Rejection$5[];
|
|
3091
|
+
}
|
|
3092
|
+
interface Rejection$5 {
|
|
3093
|
+
/** Member ID to reject. */
|
|
3094
|
+
memberId?: string;
|
|
3095
|
+
/** Rejection reason. Free text that will be displayed to the rejected site member (max 1,000 characters). */
|
|
3096
|
+
reason?: string | null;
|
|
3097
|
+
}
|
|
3098
|
+
interface RejectJoinGroupRequestsResponse$1 {
|
|
3099
|
+
/** Rejected join group requests. */
|
|
3100
|
+
joinGroupRequests?: JoinGroupRequest$1[];
|
|
3101
|
+
}
|
|
3102
|
+
interface ListJoinGroupRequestsRequest$1 {
|
|
3103
|
+
/** Group ID. */
|
|
3104
|
+
groupId: string;
|
|
3105
|
+
limit?: number | null;
|
|
3106
|
+
offset?: number | null;
|
|
3107
|
+
}
|
|
3108
|
+
interface ListJoinGroupRequestsResponse$1 {
|
|
3109
|
+
/** Join group requests. */
|
|
3110
|
+
joinGroupRequests?: JoinGroupRequest$1[];
|
|
3111
|
+
metadata?: PagingMetadata$7;
|
|
3112
|
+
}
|
|
3113
|
+
interface PagingMetadata$7 {
|
|
3114
|
+
/** Number of items returned in the response. */
|
|
3115
|
+
count?: number | null;
|
|
3116
|
+
/** Offset that was requested. */
|
|
3117
|
+
offset?: number | null;
|
|
3118
|
+
/** Total number of items that match the query. */
|
|
3119
|
+
total?: number | null;
|
|
3120
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
3121
|
+
tooManyToCount?: boolean | null;
|
|
3122
|
+
}
|
|
3123
|
+
interface QueryJoinGroupRequestsRequest$1 {
|
|
3124
|
+
/** Group ID. */
|
|
3125
|
+
groupId: string;
|
|
3126
|
+
query?: Query$5;
|
|
3127
|
+
}
|
|
3128
|
+
interface Query$5 {
|
|
3129
|
+
/**
|
|
3130
|
+
* Filter object in the following format:
|
|
3131
|
+
* `"filter" : {
|
|
3132
|
+
* "fieldName1": "value1",
|
|
3133
|
+
* "fieldName2":{"$operator":"value2"}
|
|
3134
|
+
* }`
|
|
3135
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
3136
|
+
*/
|
|
3137
|
+
filter?: any;
|
|
3138
|
+
/**
|
|
3139
|
+
* Sort object in the following format:
|
|
3140
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
3141
|
+
*/
|
|
3142
|
+
sort?: Sorting$5[];
|
|
3143
|
+
/** Paging options to limit and skip the number of items. */
|
|
3144
|
+
paging?: Paging$7;
|
|
3145
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
3146
|
+
fields?: string[];
|
|
3147
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
3148
|
+
fieldsets?: string[];
|
|
3149
|
+
}
|
|
3150
|
+
interface Sorting$5 {
|
|
3151
|
+
/** Name of the field to sort by. */
|
|
3152
|
+
fieldName?: string;
|
|
3153
|
+
/** Sort order. */
|
|
3154
|
+
order?: SortOrder$5;
|
|
3155
|
+
}
|
|
3156
|
+
declare enum SortOrder$5 {
|
|
3157
|
+
ASC = "ASC",
|
|
3158
|
+
DESC = "DESC"
|
|
3159
|
+
}
|
|
3160
|
+
interface Paging$7 {
|
|
3161
|
+
/** Number of items to load. */
|
|
3162
|
+
limit?: number | null;
|
|
3163
|
+
/** Number of items to skip in the current sort order. */
|
|
3164
|
+
offset?: number | null;
|
|
3165
|
+
}
|
|
3166
|
+
interface QueryJoinGroupRequestsResponse$1 {
|
|
3167
|
+
/** Join group requests. */
|
|
3168
|
+
joinGroupRequests?: JoinGroupRequest$1[];
|
|
3169
|
+
metadata?: PagingMetadata$7;
|
|
3170
|
+
}
|
|
3171
|
+
interface ApproveJoinGroupRequestsResponseNonNullableFields$1 {
|
|
3172
|
+
joinGroupRequests: {
|
|
3173
|
+
siteMemberId: string;
|
|
3174
|
+
contactId: string;
|
|
3175
|
+
status: RequestStatus$5;
|
|
3176
|
+
}[];
|
|
3177
|
+
}
|
|
3178
|
+
interface RejectJoinGroupRequestsResponseNonNullableFields$1 {
|
|
3179
|
+
joinGroupRequests: {
|
|
3180
|
+
siteMemberId: string;
|
|
3181
|
+
contactId: string;
|
|
3182
|
+
status: RequestStatus$5;
|
|
3183
|
+
}[];
|
|
3184
|
+
}
|
|
3185
|
+
interface ListJoinGroupRequestsResponseNonNullableFields$1 {
|
|
3186
|
+
joinGroupRequests: {
|
|
3187
|
+
siteMemberId: string;
|
|
3188
|
+
contactId: string;
|
|
3189
|
+
status: RequestStatus$5;
|
|
3190
|
+
}[];
|
|
3191
|
+
}
|
|
3192
|
+
interface QueryJoinGroupRequestsResponseNonNullableFields$1 {
|
|
3193
|
+
joinGroupRequests: {
|
|
3194
|
+
siteMemberId: string;
|
|
3195
|
+
contactId: string;
|
|
3196
|
+
status: RequestStatus$5;
|
|
3197
|
+
}[];
|
|
3198
|
+
}
|
|
3199
|
+
|
|
3200
|
+
/**
|
|
3201
|
+
* To join a private group, a site member must submit a Join Request, which can be approved or rejected by an admin.
|
|
3202
|
+
* When the request is approved, the site member becomes a group member.
|
|
3203
|
+
*/
|
|
3204
|
+
interface JoinGroupRequest {
|
|
3205
|
+
/**
|
|
3206
|
+
* Site member ID of the requester.
|
|
3207
|
+
* @readonly
|
|
3208
|
+
*/
|
|
3209
|
+
siteMemberId?: string;
|
|
3210
|
+
/** @readonly */
|
|
3211
|
+
contactId?: string;
|
|
3212
|
+
/**
|
|
3213
|
+
* Status of the request to join a group.
|
|
3214
|
+
*
|
|
3215
|
+
* One of:
|
|
3216
|
+
* - `"PENDING"`
|
|
3217
|
+
* - `"APPROVED"`
|
|
3218
|
+
* - `"REJECTED"`
|
|
3219
|
+
*/
|
|
3220
|
+
status?: RequestStatus$4;
|
|
3221
|
+
/** Join group request details. */
|
|
3222
|
+
requestDetails?: RequestDetails$4;
|
|
3223
|
+
}
|
|
3224
|
+
declare enum RequestStatus$4 {
|
|
3225
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3226
|
+
/** Pending request. */
|
|
3227
|
+
PENDING = "PENDING",
|
|
3228
|
+
/** Approved request. */
|
|
3229
|
+
APPROVED = "APPROVED",
|
|
3230
|
+
/** Rejected request. */
|
|
3231
|
+
REJECTED = "REJECTED",
|
|
3232
|
+
/** Cancelled request. */
|
|
3233
|
+
CANCELLED = "CANCELLED",
|
|
3234
|
+
/** Canceled request. */
|
|
3235
|
+
CANCELED = "CANCELED"
|
|
3236
|
+
}
|
|
3237
|
+
interface RequestDetails$4 {
|
|
3238
|
+
/** Reason the request to join a group was rejected. */
|
|
3239
|
+
rejectionReason?: string | null;
|
|
3240
|
+
}
|
|
3241
|
+
interface ApproveJoinGroupRequestsRequest {
|
|
3242
|
+
/** ID of the group requested to join. */
|
|
3243
|
+
groupId: string;
|
|
3244
|
+
/**
|
|
3245
|
+
* @Internal
|
|
3246
|
+
* @Internal
|
|
3247
|
+
* @deprecated
|
|
3248
|
+
*/
|
|
3249
|
+
siteMemberIds?: string[];
|
|
3250
|
+
/** IDs of the site members to approve. */
|
|
3251
|
+
memberIds?: string[];
|
|
3252
|
+
}
|
|
3253
|
+
interface ApproveJoinGroupRequestsResponse {
|
|
3254
|
+
/** Approved join group requests. */
|
|
3255
|
+
joinGroupRequests?: JoinGroupRequest[];
|
|
3256
|
+
}
|
|
3257
|
+
interface RejectJoinGroupRequestsRequest {
|
|
3258
|
+
/** ID of the group requested to join. */
|
|
3259
|
+
groupId: string;
|
|
3260
|
+
/** Rejection data. */
|
|
3261
|
+
rejections?: Rejection$4[];
|
|
3262
|
+
}
|
|
3263
|
+
interface Rejection$4 {
|
|
3264
|
+
/** Member ID to reject. */
|
|
3265
|
+
memberId?: string;
|
|
3266
|
+
/** Reason the request to join a group was rejected. Text written by the request reviewer that is displayed when the group is rejected (max 1,000 characters). */
|
|
3267
|
+
reason?: string | null;
|
|
3268
|
+
}
|
|
3269
|
+
interface RejectJoinGroupRequestsResponse {
|
|
3270
|
+
/** Rejected join group requests. */
|
|
3271
|
+
joinGroupRequests?: JoinGroupRequest[];
|
|
3272
|
+
}
|
|
3273
|
+
interface ListJoinGroupRequestsRequest {
|
|
3274
|
+
/** ID of the group requested to join. */
|
|
3275
|
+
groupId: string;
|
|
3276
|
+
limit?: number | null;
|
|
3277
|
+
offset?: number | null;
|
|
3278
|
+
}
|
|
3279
|
+
interface ListJoinGroupRequestsResponse {
|
|
3280
|
+
/** Join group requests. */
|
|
3281
|
+
joinGroupRequests?: JoinGroupRequest[];
|
|
3282
|
+
metadata?: PagingMetadata$6;
|
|
3283
|
+
}
|
|
3284
|
+
interface PagingMetadata$6 {
|
|
3285
|
+
/** Number of items in the current results page. */
|
|
3286
|
+
count?: number | null;
|
|
3287
|
+
/** Offset that was requested. */
|
|
3288
|
+
offset?: number | null;
|
|
3289
|
+
/** Total number of items that match the query. */
|
|
3290
|
+
total?: number | null;
|
|
3291
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
3292
|
+
tooManyToCount?: boolean | null;
|
|
3293
|
+
}
|
|
3294
|
+
interface QueryJoinGroupRequestsRequest {
|
|
3295
|
+
/** ID of the group requested to join. */
|
|
3296
|
+
groupId: string;
|
|
3297
|
+
query?: Query$4;
|
|
3298
|
+
}
|
|
3299
|
+
interface Query$4 {
|
|
3300
|
+
/**
|
|
3301
|
+
* Filter object in the following format:
|
|
3302
|
+
* `"filter" : {
|
|
3303
|
+
* "fieldName1": "value1",
|
|
3304
|
+
* "fieldName2":{"$operator":"value2"}
|
|
3305
|
+
* }`
|
|
3306
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
3307
|
+
*/
|
|
3308
|
+
filter?: any;
|
|
3309
|
+
/**
|
|
3310
|
+
* Sort object in the following format:
|
|
3311
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
3312
|
+
*/
|
|
3313
|
+
sort?: Sorting$4[];
|
|
3314
|
+
/** Paging options to limit and skip the number of items. */
|
|
3315
|
+
paging?: Paging$6;
|
|
3316
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
3317
|
+
fields?: string[];
|
|
3318
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
3319
|
+
fieldsets?: string[];
|
|
3320
|
+
}
|
|
3321
|
+
interface Sorting$4 {
|
|
3322
|
+
/** Name of the field to sort by. */
|
|
3323
|
+
fieldName?: string;
|
|
3324
|
+
/** Sort order. */
|
|
3325
|
+
order?: SortOrder$4;
|
|
3326
|
+
}
|
|
3327
|
+
declare enum SortOrder$4 {
|
|
3328
|
+
ASC = "ASC",
|
|
3329
|
+
DESC = "DESC"
|
|
3330
|
+
}
|
|
3331
|
+
interface Paging$6 {
|
|
3332
|
+
/** Number of items to load. */
|
|
3333
|
+
limit?: number | null;
|
|
3334
|
+
/** Number of items to skip in the current sort order. */
|
|
3335
|
+
offset?: number | null;
|
|
3336
|
+
}
|
|
3337
|
+
interface QueryJoinGroupRequestsResponse {
|
|
3338
|
+
/** Requests to join a group. */
|
|
3339
|
+
joinGroupRequests?: JoinGroupRequest[];
|
|
3340
|
+
metadata?: PagingMetadata$6;
|
|
3341
|
+
}
|
|
3342
|
+
interface ApproveJoinGroupRequestsResponseNonNullableFields {
|
|
3343
|
+
joinGroupRequests: {
|
|
3344
|
+
siteMemberId: string;
|
|
3345
|
+
contactId: string;
|
|
3346
|
+
status: RequestStatus$4;
|
|
3347
|
+
}[];
|
|
3348
|
+
}
|
|
3349
|
+
interface RejectJoinGroupRequestsResponseNonNullableFields {
|
|
3350
|
+
joinGroupRequests: {
|
|
3351
|
+
siteMemberId: string;
|
|
3352
|
+
contactId: string;
|
|
3353
|
+
status: RequestStatus$4;
|
|
3354
|
+
}[];
|
|
3355
|
+
}
|
|
3356
|
+
interface ListJoinGroupRequestsResponseNonNullableFields {
|
|
3357
|
+
joinGroupRequests: {
|
|
3358
|
+
siteMemberId: string;
|
|
3359
|
+
contactId: string;
|
|
3360
|
+
status: RequestStatus$4;
|
|
3361
|
+
}[];
|
|
3362
|
+
}
|
|
3363
|
+
interface QueryJoinGroupRequestsResponseNonNullableFields {
|
|
3364
|
+
joinGroupRequests: {
|
|
3365
|
+
siteMemberId: string;
|
|
3366
|
+
contactId: string;
|
|
3367
|
+
status: RequestStatus$4;
|
|
3368
|
+
}[];
|
|
3369
|
+
}
|
|
3370
|
+
|
|
3371
|
+
type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
3372
|
+
getUrl: (context: any) => string;
|
|
3373
|
+
httpMethod: K;
|
|
3374
|
+
path: string;
|
|
3375
|
+
pathParams: M;
|
|
3376
|
+
__requestType: T;
|
|
3377
|
+
__originalRequestType: S;
|
|
3378
|
+
__responseType: Q;
|
|
3379
|
+
__originalResponseType: R;
|
|
3380
|
+
};
|
|
3381
|
+
declare function approveJoinGroupRequests(): __PublicMethodMetaInfo$3<'POST', {
|
|
3382
|
+
groupId: string;
|
|
3383
|
+
}, ApproveJoinGroupRequestsRequest, ApproveJoinGroupRequestsRequest$1, ApproveJoinGroupRequestsResponse & ApproveJoinGroupRequestsResponseNonNullableFields, ApproveJoinGroupRequestsResponse$1 & ApproveJoinGroupRequestsResponseNonNullableFields$1>;
|
|
3384
|
+
declare function rejectJoinGroupRequests(): __PublicMethodMetaInfo$3<'POST', {
|
|
3385
|
+
groupId: string;
|
|
3386
|
+
}, RejectJoinGroupRequestsRequest, RejectJoinGroupRequestsRequest$1, RejectJoinGroupRequestsResponse & RejectJoinGroupRequestsResponseNonNullableFields, RejectJoinGroupRequestsResponse$1 & RejectJoinGroupRequestsResponseNonNullableFields$1>;
|
|
3387
|
+
declare function listJoinGroupRequests(): __PublicMethodMetaInfo$3<'GET', {
|
|
3388
|
+
groupId: string;
|
|
3389
|
+
}, ListJoinGroupRequestsRequest, ListJoinGroupRequestsRequest$1, ListJoinGroupRequestsResponse & ListJoinGroupRequestsResponseNonNullableFields, ListJoinGroupRequestsResponse$1 & ListJoinGroupRequestsResponseNonNullableFields$1>;
|
|
3390
|
+
declare function queryJoinGroupRequests(): __PublicMethodMetaInfo$3<'POST', {
|
|
3391
|
+
groupId: string;
|
|
3392
|
+
}, QueryJoinGroupRequestsRequest, QueryJoinGroupRequestsRequest$1, QueryJoinGroupRequestsResponse & QueryJoinGroupRequestsResponseNonNullableFields, QueryJoinGroupRequestsResponse$1 & QueryJoinGroupRequestsResponseNonNullableFields$1>;
|
|
3393
|
+
|
|
3394
|
+
declare const meta$3_approveJoinGroupRequests: typeof approveJoinGroupRequests;
|
|
3395
|
+
declare const meta$3_listJoinGroupRequests: typeof listJoinGroupRequests;
|
|
3396
|
+
declare const meta$3_queryJoinGroupRequests: typeof queryJoinGroupRequests;
|
|
3397
|
+
declare const meta$3_rejectJoinGroupRequests: typeof rejectJoinGroupRequests;
|
|
3398
|
+
declare namespace meta$3 {
|
|
3399
|
+
export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_approveJoinGroupRequests as approveJoinGroupRequests, meta$3_listJoinGroupRequests as listJoinGroupRequests, meta$3_queryJoinGroupRequests as queryJoinGroupRequests, meta$3_rejectJoinGroupRequests as rejectJoinGroupRequests };
|
|
3400
|
+
}
|
|
3401
|
+
|
|
3402
|
+
/**
|
|
3403
|
+
* Question asked to members when joining a group. Site owners can set whether it is required to answer the question in the dashboard.
|
|
3404
|
+
* > **Note:** Only admins can create or update membership questions.
|
|
3405
|
+
*/
|
|
3406
|
+
interface MembershipQuestion$1 {
|
|
3407
|
+
/**
|
|
3408
|
+
* Question ID.
|
|
3409
|
+
* @readonly
|
|
3410
|
+
*/
|
|
3411
|
+
id?: string | null;
|
|
3412
|
+
/** Whether a member must answer this question when joining the group. */
|
|
3413
|
+
required?: boolean;
|
|
3414
|
+
/** Question text. */
|
|
3415
|
+
text?: string;
|
|
3416
|
+
}
|
|
3417
|
+
interface ListMembershipQuestionsRequest$1 {
|
|
3418
|
+
/** Group ID. */
|
|
3419
|
+
groupId: string;
|
|
3420
|
+
}
|
|
3421
|
+
interface ListMembershipQuestionsResponse$1 {
|
|
3422
|
+
/** Membership questions. */
|
|
3423
|
+
questions?: MembershipQuestion$1[];
|
|
3424
|
+
}
|
|
3425
|
+
interface CreateOrReplaceAllMembershipQuestionsRequest$1 {
|
|
3426
|
+
/** Group ID. */
|
|
3427
|
+
groupId: string;
|
|
3428
|
+
/** New membership questions. */
|
|
3429
|
+
questions?: MembershipQuestion$1[];
|
|
3430
|
+
}
|
|
3431
|
+
interface CreateOrReplaceAllMembershipQuestionsResponse$1 {
|
|
3432
|
+
/** Membership questions. */
|
|
3433
|
+
questions?: MembershipQuestion$1[];
|
|
3434
|
+
}
|
|
3435
|
+
interface ListAnswersRequest$1 {
|
|
3436
|
+
/** Group ID. */
|
|
3437
|
+
groupId: string;
|
|
3438
|
+
/** Member IDs. If no member ID is provided, answers for all members will be returned. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
3439
|
+
memberIds?: string[];
|
|
3440
|
+
paging?: Paging$5;
|
|
3441
|
+
}
|
|
3442
|
+
interface Paging$5 {
|
|
3443
|
+
/** Number of items to load. */
|
|
3444
|
+
limit?: number | null;
|
|
3445
|
+
/** Number of items to skip in the current sort order. */
|
|
3446
|
+
offset?: number | null;
|
|
3447
|
+
}
|
|
3448
|
+
interface ListAnswersResponse$1 {
|
|
3449
|
+
/** Answers to the membership questions, grouped by member. */
|
|
3450
|
+
memberAnswers?: MemberMembershipQuestionAnswers$1[];
|
|
3451
|
+
/** Membership questions by question ID. Inludes only questions that have been answered by the specified members. */
|
|
3452
|
+
questions?: Record<string, MembershipQuestion$1>;
|
|
3453
|
+
metadata?: PagingMetadata$5;
|
|
3454
|
+
}
|
|
3455
|
+
interface MemberMembershipQuestionAnswers$1 {
|
|
3456
|
+
/** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
3457
|
+
memberId?: string;
|
|
3458
|
+
/** Answers to the membership question. */
|
|
3459
|
+
answers?: MembershipQuestionAnswer$1[];
|
|
3460
|
+
}
|
|
3461
|
+
/** Answer to a membership question. */
|
|
3462
|
+
interface MembershipQuestionAnswer$1 {
|
|
3463
|
+
/** Question ID. */
|
|
3464
|
+
id?: string;
|
|
3465
|
+
/** Answer text. */
|
|
3466
|
+
text?: string | null;
|
|
3467
|
+
}
|
|
3468
|
+
interface PagingMetadata$5 {
|
|
3469
|
+
/** Number of items returned in the response. */
|
|
3470
|
+
count?: number | null;
|
|
3471
|
+
/** Offset that was requested. */
|
|
3472
|
+
offset?: number | null;
|
|
3473
|
+
/** Total number of items that match the query. */
|
|
3474
|
+
total?: number | null;
|
|
3475
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
3476
|
+
tooManyToCount?: boolean | null;
|
|
3477
|
+
}
|
|
3478
|
+
interface ListMembershipQuestionsResponseNonNullableFields$1 {
|
|
3479
|
+
questions: {
|
|
3480
|
+
required: boolean;
|
|
3481
|
+
text: string;
|
|
3482
|
+
}[];
|
|
3483
|
+
}
|
|
3484
|
+
interface CreateOrReplaceAllMembershipQuestionsResponseNonNullableFields$1 {
|
|
3485
|
+
questions: {
|
|
3486
|
+
required: boolean;
|
|
3487
|
+
text: string;
|
|
3488
|
+
}[];
|
|
3489
|
+
}
|
|
3490
|
+
interface ListAnswersResponseNonNullableFields$1 {
|
|
3491
|
+
memberAnswers: {
|
|
3492
|
+
memberId: string;
|
|
3493
|
+
answers: {
|
|
3494
|
+
id: string;
|
|
3495
|
+
}[];
|
|
3496
|
+
}[];
|
|
3497
|
+
questions?: {
|
|
3498
|
+
required: boolean;
|
|
3499
|
+
text: string;
|
|
3500
|
+
};
|
|
3501
|
+
}
|
|
3502
|
+
|
|
3503
|
+
/**
|
|
3504
|
+
* Question asked to members when joining a group. Site owners can set whether it is required to answer the question in the dashboard.
|
|
3505
|
+
* > **Note:** Only admins can create or update membership questions.
|
|
3506
|
+
*/
|
|
3507
|
+
interface MembershipQuestion {
|
|
3508
|
+
/**
|
|
3509
|
+
* Question ID.
|
|
3510
|
+
* @readonly
|
|
3511
|
+
*/
|
|
3512
|
+
_id?: string | null;
|
|
3513
|
+
/** Whether a member must answer this question when joining the group. */
|
|
3514
|
+
required?: boolean;
|
|
3515
|
+
/** Question text. */
|
|
3516
|
+
text?: string;
|
|
3517
|
+
}
|
|
3518
|
+
interface ListMembershipQuestionsRequest {
|
|
3519
|
+
/** Group ID. */
|
|
3520
|
+
groupId: string;
|
|
3521
|
+
}
|
|
3522
|
+
interface ListMembershipQuestionsResponse {
|
|
3523
|
+
/** Membership questions. */
|
|
3524
|
+
questions?: MembershipQuestion[];
|
|
3525
|
+
}
|
|
3526
|
+
interface CreateOrReplaceAllMembershipQuestionsRequest {
|
|
3527
|
+
/** Group ID. */
|
|
3528
|
+
groupId: string;
|
|
3529
|
+
/** New membership questions. */
|
|
3530
|
+
questions?: MembershipQuestion[];
|
|
3531
|
+
}
|
|
3532
|
+
interface CreateOrReplaceAllMembershipQuestionsResponse {
|
|
3533
|
+
/** Membership questions. */
|
|
3534
|
+
questions?: MembershipQuestion[];
|
|
3535
|
+
}
|
|
3536
|
+
interface ListAnswersRequest {
|
|
3537
|
+
/** Group ID. */
|
|
3538
|
+
groupId: string;
|
|
3539
|
+
/** Member IDs. If no member ID is provided, answers for all members will be returned. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
3540
|
+
memberIds?: string[];
|
|
3541
|
+
paging?: Paging$4;
|
|
3542
|
+
}
|
|
3543
|
+
interface Paging$4 {
|
|
3544
|
+
/** Number of items to load. */
|
|
3545
|
+
limit?: number | null;
|
|
3546
|
+
/** Number of items to skip in the current sort order. */
|
|
3547
|
+
offset?: number | null;
|
|
3548
|
+
}
|
|
3549
|
+
interface ListAnswersResponse {
|
|
3550
|
+
/** Answers to the membership questions, grouped by member. */
|
|
3551
|
+
memberAnswers?: MemberMembershipQuestionAnswers[];
|
|
3552
|
+
/** Membership questions by question ID. Inludes only questions that have been answered by the specified members. */
|
|
3553
|
+
questions?: Record<string, MembershipQuestion>;
|
|
3554
|
+
metadata?: PagingMetadata$4;
|
|
3555
|
+
}
|
|
3556
|
+
interface MemberMembershipQuestionAnswers {
|
|
3557
|
+
/** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
3558
|
+
memberId?: string;
|
|
3559
|
+
/** Answers to the membership question. */
|
|
3560
|
+
answers?: MembershipQuestionAnswer[];
|
|
3561
|
+
}
|
|
3562
|
+
/** Answer to a membership question. */
|
|
3563
|
+
interface MembershipQuestionAnswer {
|
|
3564
|
+
/** Question ID. */
|
|
3565
|
+
_id?: string;
|
|
3566
|
+
/** Answer text. */
|
|
3567
|
+
text?: string | null;
|
|
3568
|
+
}
|
|
3569
|
+
interface PagingMetadata$4 {
|
|
3570
|
+
/** Number of items returned in the response. */
|
|
3571
|
+
count?: number | null;
|
|
3572
|
+
/** Offset that was requested. */
|
|
3573
|
+
offset?: number | null;
|
|
3574
|
+
/** Total number of items that match the query. */
|
|
3575
|
+
total?: number | null;
|
|
3576
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
3577
|
+
tooManyToCount?: boolean | null;
|
|
3578
|
+
}
|
|
3579
|
+
interface ListMembershipQuestionsResponseNonNullableFields {
|
|
3580
|
+
questions: {
|
|
3581
|
+
required: boolean;
|
|
3582
|
+
text: string;
|
|
3583
|
+
}[];
|
|
3584
|
+
}
|
|
3585
|
+
interface CreateOrReplaceAllMembershipQuestionsResponseNonNullableFields {
|
|
3586
|
+
questions: {
|
|
3587
|
+
required: boolean;
|
|
3588
|
+
text: string;
|
|
3589
|
+
}[];
|
|
3590
|
+
}
|
|
3591
|
+
interface ListAnswersResponseNonNullableFields {
|
|
3592
|
+
memberAnswers: {
|
|
3593
|
+
memberId: string;
|
|
3594
|
+
answers: {
|
|
3595
|
+
_id: string;
|
|
3596
|
+
}[];
|
|
3597
|
+
}[];
|
|
3598
|
+
questions?: {
|
|
3599
|
+
required: boolean;
|
|
3600
|
+
text: string;
|
|
3601
|
+
};
|
|
3602
|
+
}
|
|
3603
|
+
|
|
3604
|
+
type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
3605
|
+
getUrl: (context: any) => string;
|
|
3606
|
+
httpMethod: K;
|
|
3607
|
+
path: string;
|
|
3608
|
+
pathParams: M;
|
|
3609
|
+
__requestType: T;
|
|
3610
|
+
__originalRequestType: S;
|
|
3611
|
+
__responseType: Q;
|
|
3612
|
+
__originalResponseType: R;
|
|
3613
|
+
};
|
|
3614
|
+
declare function listMembershipQuestions(): __PublicMethodMetaInfo$2<'GET', {
|
|
3615
|
+
groupId: string;
|
|
3616
|
+
}, ListMembershipQuestionsRequest, ListMembershipQuestionsRequest$1, ListMembershipQuestionsResponse & ListMembershipQuestionsResponseNonNullableFields, ListMembershipQuestionsResponse$1 & ListMembershipQuestionsResponseNonNullableFields$1>;
|
|
3617
|
+
declare function createOrReplaceAllMembershipQuestions(): __PublicMethodMetaInfo$2<'PUT', {
|
|
3618
|
+
groupId: string;
|
|
3619
|
+
}, CreateOrReplaceAllMembershipQuestionsRequest, CreateOrReplaceAllMembershipQuestionsRequest$1, CreateOrReplaceAllMembershipQuestionsResponse & CreateOrReplaceAllMembershipQuestionsResponseNonNullableFields, CreateOrReplaceAllMembershipQuestionsResponse$1 & CreateOrReplaceAllMembershipQuestionsResponseNonNullableFields$1>;
|
|
3620
|
+
declare function listAnswers(): __PublicMethodMetaInfo$2<'POST', {
|
|
3621
|
+
groupId: string;
|
|
3622
|
+
}, ListAnswersRequest, ListAnswersRequest$1, ListAnswersResponse & ListAnswersResponseNonNullableFields, ListAnswersResponse$1 & ListAnswersResponseNonNullableFields$1>;
|
|
3623
|
+
|
|
3624
|
+
declare const meta$2_createOrReplaceAllMembershipQuestions: typeof createOrReplaceAllMembershipQuestions;
|
|
3625
|
+
declare const meta$2_listAnswers: typeof listAnswers;
|
|
3626
|
+
declare const meta$2_listMembershipQuestions: typeof listMembershipQuestions;
|
|
3627
|
+
declare namespace meta$2 {
|
|
3628
|
+
export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_createOrReplaceAllMembershipQuestions as createOrReplaceAllMembershipQuestions, meta$2_listAnswers as listAnswers, meta$2_listMembershipQuestions as listMembershipQuestions };
|
|
3629
|
+
}
|
|
3630
|
+
|
|
3631
|
+
/**
|
|
3632
|
+
* >**Notes:**
|
|
3633
|
+
* > + Site owners may set that members are not permitted to create groups in the Wix Groups application settings.
|
|
3634
|
+
* > + In this situation, site members have to submit a Create Request to create a new group.
|
|
3635
|
+
* > + Create Requests can be approved or rejected by an admin.
|
|
3636
|
+
* > + After a Create Request has been approved, the new group is added to the Group List in the Wix Groups app home page.
|
|
3637
|
+
* > + See [Introduction](https://dev.wix.com/api/rest/wix-groups/groups/introduction#wix-groups_groups_introduction_terminology) for more details.
|
|
3638
|
+
*/
|
|
3639
|
+
interface CreateRequest$1 {
|
|
3640
|
+
/**
|
|
3641
|
+
* Create request ID
|
|
3642
|
+
* @readonly
|
|
3643
|
+
*/
|
|
3644
|
+
id?: string | null;
|
|
3645
|
+
/** Group requested for creation. */
|
|
3646
|
+
group?: Group$1;
|
|
3647
|
+
/**
|
|
3648
|
+
* Status of request.
|
|
3649
|
+
* - `PENDING` - Pending request.
|
|
3650
|
+
* - `APPROVED` - Approved request.
|
|
3651
|
+
* - `REJECTED` - Rejected request.
|
|
3652
|
+
* - `CANCELED` - Canceled request.
|
|
3653
|
+
*/
|
|
3654
|
+
status?: RequestStatus$3;
|
|
3655
|
+
/** Request details. */
|
|
3656
|
+
requestDetails?: RequestDetails$3;
|
|
3657
|
+
}
|
|
3658
|
+
interface Group$1 {
|
|
3659
|
+
/**
|
|
3660
|
+
* Group ID.
|
|
3661
|
+
* @readonly
|
|
3662
|
+
*/
|
|
3663
|
+
id?: string | null;
|
|
3664
|
+
/** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */
|
|
3665
|
+
slug?: string | null;
|
|
3666
|
+
/**
|
|
3667
|
+
* __Deprecated.__ Use `privacyStatus` instead.
|
|
3668
|
+
* This property will be removed on June 30, 2022.
|
|
3669
|
+
* @deprecated
|
|
3670
|
+
*/
|
|
3671
|
+
privacyLevel?: PrivacyStatus$1;
|
|
3672
|
+
/**
|
|
3673
|
+
* Group privacy status.
|
|
3674
|
+
* - `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.
|
|
3675
|
+
* - `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.
|
|
3676
|
+
* - `SECRET` - Only admins and members can see the group. New members can only be added by other members.
|
|
3677
|
+
*/
|
|
3678
|
+
privacyStatus?: PrivacyStatus$1;
|
|
3679
|
+
/**
|
|
3680
|
+
* __Deprecated.__ Use `name` instead.
|
|
3681
|
+
* This property will be removed on June 30, 2022.
|
|
3682
|
+
* @deprecated
|
|
3683
|
+
*/
|
|
3684
|
+
title?: string | null;
|
|
3685
|
+
/** Group name. */
|
|
3686
|
+
name?: string | null;
|
|
3687
|
+
/** Group description in DraftJS format. */
|
|
3688
|
+
description?: string | null;
|
|
3689
|
+
/** Group teaser. */
|
|
3690
|
+
teaser?: string | null;
|
|
3691
|
+
/**
|
|
3692
|
+
* __Deprecated.__
|
|
3693
|
+
* For `details.logo`, use `coverImage` instead.
|
|
3694
|
+
* For `details.membersTitle`, `memberTitle` instead.
|
|
3695
|
+
* This property will be removed on June 30, 2022.
|
|
3696
|
+
* @deprecated
|
|
3697
|
+
*/
|
|
3698
|
+
details?: GroupDetails$1;
|
|
3699
|
+
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
3700
|
+
memberTitle?: string | null;
|
|
3701
|
+
/** Cover image. You cannot upload your own cover image. */
|
|
3702
|
+
coverImage?: CoverImage$1;
|
|
3703
|
+
/** Group specific settings. Available to the site owners under `Admin Tools` in the dashboard. */
|
|
3704
|
+
settings?: GroupSettings$1;
|
|
3705
|
+
/**
|
|
3706
|
+
* Total count of current group members.
|
|
3707
|
+
* @readonly
|
|
3708
|
+
*/
|
|
3709
|
+
membersCount?: number | null;
|
|
3710
|
+
/**
|
|
3711
|
+
* __Deprecated.__ Use `ownerId` instead.
|
|
3712
|
+
* This property will be removed on June 30, 2022.
|
|
3713
|
+
* @readonly
|
|
3714
|
+
* @deprecated
|
|
3715
|
+
*/
|
|
3716
|
+
createdBy?: Identity$1;
|
|
3717
|
+
/**
|
|
3718
|
+
* Group owner.
|
|
3719
|
+
* @readonly
|
|
3720
|
+
*/
|
|
3721
|
+
ownerId?: string | null;
|
|
3722
|
+
/**
|
|
3723
|
+
* Group creation date and time.
|
|
3724
|
+
* @readonly
|
|
3725
|
+
*/
|
|
3726
|
+
createdDate?: Date;
|
|
3727
|
+
/**
|
|
3728
|
+
* Date and time of the latest group update.
|
|
3729
|
+
* @readonly
|
|
3730
|
+
*/
|
|
3731
|
+
updatedDate?: Date;
|
|
3732
|
+
/**
|
|
3733
|
+
* __Deprecated.__ Use `lastActivityDate` instead.
|
|
3734
|
+
* This property will be removed on June 30, 2022.
|
|
3735
|
+
* @readonly
|
|
3736
|
+
* @deprecated
|
|
3737
|
+
*/
|
|
3738
|
+
recentActivityDate?: Date;
|
|
3739
|
+
/**
|
|
3740
|
+
* Date and time of the most recent group activity, for example a post or comment.
|
|
3741
|
+
* @readonly
|
|
3742
|
+
*/
|
|
3743
|
+
lastActivityDate?: Date;
|
|
3744
|
+
}
|
|
3745
|
+
declare enum Type {
|
|
3746
|
+
UNKNOWN = "UNKNOWN",
|
|
3747
|
+
ADMIN_APPROVAL = "ADMIN_APPROVAL",
|
|
3748
|
+
PAID_PLANS = "PAID_PLANS",
|
|
3749
|
+
EVENTS = "EVENTS"
|
|
3750
|
+
}
|
|
3751
|
+
interface Logo$1 {
|
|
3752
|
+
/** Logo image ID (for internal use). */
|
|
3753
|
+
mediaId?: string | null;
|
|
3754
|
+
/** Logo image width. */
|
|
3755
|
+
width?: number | null;
|
|
3756
|
+
/** Logo image height. */
|
|
3757
|
+
height?: number | null;
|
|
3758
|
+
}
|
|
3759
|
+
interface Image$1 {
|
|
3760
|
+
/** Image ID (for internal use). */
|
|
3761
|
+
mediaId?: string | null;
|
|
3762
|
+
/** Image width. */
|
|
3763
|
+
width?: number | null;
|
|
3764
|
+
/** Image height. */
|
|
3765
|
+
height?: number | null;
|
|
3766
|
+
}
|
|
3767
|
+
interface Position$1 {
|
|
3768
|
+
/** horizontal coordinate */
|
|
3769
|
+
x?: number;
|
|
3770
|
+
/** vertical coordinate */
|
|
3771
|
+
y?: number;
|
|
3772
|
+
}
|
|
3773
|
+
declare enum AllowPolicy {
|
|
3774
|
+
UNKNOWN = "UNKNOWN",
|
|
3775
|
+
OWNER_AND_ADMINS = "OWNER_AND_ADMINS",
|
|
3776
|
+
OWNER = "OWNER",
|
|
3777
|
+
ALL_MEMBERS = "ALL_MEMBERS"
|
|
3778
|
+
}
|
|
3779
|
+
interface OnboardingStepSettings$1 {
|
|
3780
|
+
stepKey?: StepKey$1;
|
|
3781
|
+
visible?: boolean;
|
|
3782
|
+
}
|
|
3783
|
+
declare enum StepKey$1 {
|
|
3784
|
+
UNKNOWN = "UNKNOWN",
|
|
3785
|
+
CREATE_POST = "CREATE_POST",
|
|
3786
|
+
REACT_TO_POST = "REACT_TO_POST",
|
|
3787
|
+
INVITE_MEMBERS = "INVITE_MEMBERS"
|
|
3788
|
+
}
|
|
3789
|
+
declare enum PrivacyStatus$1 {
|
|
3790
|
+
UNKNOWN = "UNKNOWN",
|
|
3791
|
+
/** Anyone can see the group in the group list and view its content. Anyone can join. */
|
|
3792
|
+
PUBLIC = "PUBLIC",
|
|
3793
|
+
/** Anyone can see the group in the group list, but only group members can see its content. In order to join a group, a group join request must be submitted. */
|
|
3794
|
+
PRIVATE = "PRIVATE",
|
|
3795
|
+
/** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */
|
|
3796
|
+
SECRET = "SECRET"
|
|
3797
|
+
}
|
|
3798
|
+
interface GroupDetails$1 {
|
|
3799
|
+
/** Group logo. You cannot upload your own logo. */
|
|
3800
|
+
logo?: Logo$1;
|
|
3801
|
+
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
3802
|
+
membersTitle?: string | null;
|
|
3803
|
+
}
|
|
3804
|
+
interface CoverImage$1 {
|
|
3805
|
+
/** Cover image. */
|
|
3806
|
+
image?: Image$1;
|
|
3807
|
+
/** Position of the corner of the cover image (or logo). */
|
|
3808
|
+
position?: Position$1;
|
|
3809
|
+
/** Position of the corner of the cover image (or logo) for mobile browser. */
|
|
3810
|
+
mobilePosition?: Position$1;
|
|
3811
|
+
}
|
|
3812
|
+
interface GroupSettings$1 {
|
|
3813
|
+
/**
|
|
3814
|
+
* __Deprecated.__ Use `allowedToInviteMembers` instead.
|
|
3815
|
+
* Whether regular members are permitted to invite new members.
|
|
3816
|
+
* If `false`, only admins can invite members. Defaults to `true`.
|
|
3817
|
+
* @deprecated
|
|
3818
|
+
*/
|
|
3819
|
+
membersCanInvite?: boolean | null;
|
|
3820
|
+
/**
|
|
3821
|
+
* __Deprecated.__ Use `allowedToApproveJoinRequests` instead.
|
|
3822
|
+
* Whether all group members are permitted to approve join group requests.
|
|
3823
|
+
* If `false`, member approval is limited to the admins.
|
|
3824
|
+
* @deprecated
|
|
3825
|
+
*/
|
|
3826
|
+
membersCanApprove?: boolean | null;
|
|
3827
|
+
/**
|
|
3828
|
+
* __Deprecated.__ Use `welcomeMemberPostEnabled` instead.
|
|
3829
|
+
* This property will be removed on June 30, 2022.
|
|
3830
|
+
* @deprecated
|
|
3831
|
+
*/
|
|
3832
|
+
memberWelcomePostEnabled?: boolean | null;
|
|
3833
|
+
/** Whether a daily post about new members is enabled. */
|
|
3834
|
+
welcomeMemberPostEnabled?: boolean | null;
|
|
3835
|
+
/** Whether an automatic post about changing the group details is enabled. */
|
|
3836
|
+
groupDetailsChangedPostEnabled?: boolean | null;
|
|
3837
|
+
/** Whether all members can see the full member list. */
|
|
3838
|
+
showMemberList?: boolean | null;
|
|
3839
|
+
onboardingStepsSettings?: OnboardingStepSettings$1[];
|
|
3840
|
+
}
|
|
3841
|
+
interface Identity$1 {
|
|
3842
|
+
/** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
3843
|
+
id?: string | null;
|
|
3844
|
+
identityType?: IdentityType$1;
|
|
3845
|
+
}
|
|
3846
|
+
declare enum IdentityType$1 {
|
|
3847
|
+
USER = "USER",
|
|
3848
|
+
MEMBER = "MEMBER"
|
|
3849
|
+
}
|
|
3850
|
+
declare enum RequestStatus$3 {
|
|
3851
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
3852
|
+
/** Pending request. */
|
|
3853
|
+
PENDING = "PENDING",
|
|
3854
|
+
/** Approved request. */
|
|
3855
|
+
APPROVED = "APPROVED",
|
|
3856
|
+
/** Rejected request. */
|
|
3857
|
+
REJECTED = "REJECTED",
|
|
3858
|
+
/** Cancelled request. */
|
|
3859
|
+
CANCELLED = "CANCELLED",
|
|
3860
|
+
/** Canceled request. */
|
|
3861
|
+
CANCELED = "CANCELED"
|
|
3862
|
+
}
|
|
3863
|
+
interface RequestDetails$3 {
|
|
3864
|
+
/** Reason the request has been rejected. */
|
|
3865
|
+
rejectionReason?: string | null;
|
|
3866
|
+
}
|
|
3867
|
+
interface ApproveCreateRequestsRequest$1 {
|
|
3868
|
+
/** Create Request IDs to approve. Limited to `100`. */
|
|
3869
|
+
createRequestIds?: string[];
|
|
3870
|
+
}
|
|
3871
|
+
interface ApproveCreateRequestsResponse$1 {
|
|
3872
|
+
/** Approved Create Requests. */
|
|
3873
|
+
createRequest?: CreateRequest$1[];
|
|
3874
|
+
}
|
|
3875
|
+
interface RejectCreateRequestsRequest$1 {
|
|
3876
|
+
/** Rejection data. */
|
|
3877
|
+
rejections?: Rejection$3[];
|
|
3878
|
+
}
|
|
3879
|
+
interface Rejection$3 {
|
|
3880
|
+
/** ID of the Create Request to reject. */
|
|
3881
|
+
createRequestId?: string;
|
|
3882
|
+
/** Rejection reason. Free text displayed to the creator of the rejected Create Request. Limited to 1,000 characters. */
|
|
3883
|
+
reason?: string | null;
|
|
3884
|
+
}
|
|
3885
|
+
interface RejectCreateRequestsResponse$1 {
|
|
3886
|
+
/** Rejected Create Requests. */
|
|
3887
|
+
createRequest?: CreateRequest$1[];
|
|
3888
|
+
}
|
|
3889
|
+
interface ListCreateRequestsRequest$1 {
|
|
3890
|
+
/** Number of items to load. Maximum `100`. */
|
|
3891
|
+
limit?: number | null;
|
|
3892
|
+
/** Number of items to skip in the current sort order. */
|
|
3893
|
+
offset?: number | null;
|
|
3894
|
+
}
|
|
3895
|
+
interface ListCreateRequestsResponse$1 {
|
|
3896
|
+
/** Create Requests. */
|
|
3897
|
+
createRequests?: CreateRequest$1[];
|
|
3898
|
+
metadata?: PagingMetadata$3;
|
|
3899
|
+
}
|
|
3900
|
+
interface PagingMetadata$3 {
|
|
3901
|
+
/** Number of items returned in the response. */
|
|
3902
|
+
count?: number | null;
|
|
3903
|
+
/** Offset that was requested. */
|
|
3904
|
+
offset?: number | null;
|
|
3905
|
+
/** Total number of items that match the query. */
|
|
3906
|
+
total?: number | null;
|
|
3907
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
3908
|
+
tooManyToCount?: boolean | null;
|
|
3909
|
+
}
|
|
3910
|
+
interface QueryCreateRequestsRequest$1 {
|
|
3911
|
+
query?: Query$3;
|
|
3912
|
+
}
|
|
3913
|
+
interface Query$3 {
|
|
3914
|
+
/**
|
|
3915
|
+
* Filter object in the following format:
|
|
3916
|
+
* `"filter" : {
|
|
3917
|
+
* "fieldName1": "value1",
|
|
3918
|
+
* "fieldName2":{"$operator":"value2"}
|
|
3919
|
+
* }`
|
|
3920
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
3921
|
+
*/
|
|
3922
|
+
filter?: any;
|
|
3923
|
+
/**
|
|
3924
|
+
* Sort object in the following format:
|
|
3925
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
3926
|
+
*/
|
|
3927
|
+
sort?: Sorting$3[];
|
|
3928
|
+
/** Paging options to limit and skip the number of items. */
|
|
3929
|
+
paging?: Paging$3;
|
|
3930
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
3931
|
+
fields?: string[];
|
|
3932
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
3933
|
+
fieldsets?: string[];
|
|
3934
|
+
}
|
|
3935
|
+
interface Sorting$3 {
|
|
3936
|
+
/** Name of the field to sort by. */
|
|
3937
|
+
fieldName?: string;
|
|
3938
|
+
/** Sort order. */
|
|
3939
|
+
order?: SortOrder$3;
|
|
3940
|
+
}
|
|
3941
|
+
declare enum SortOrder$3 {
|
|
3942
|
+
ASC = "ASC",
|
|
3943
|
+
DESC = "DESC"
|
|
3944
|
+
}
|
|
3945
|
+
interface Paging$3 {
|
|
3946
|
+
/** Number of items to load. */
|
|
3947
|
+
limit?: number | null;
|
|
3948
|
+
/** Number of items to skip in the current sort order. */
|
|
3949
|
+
offset?: number | null;
|
|
3950
|
+
}
|
|
3951
|
+
interface QueryCreateRequestsResponse$1 {
|
|
3952
|
+
/** Retrieved Create Requests. */
|
|
3953
|
+
createRequests?: CreateRequest$1[];
|
|
3954
|
+
metadata?: PagingMetadata$3;
|
|
3955
|
+
}
|
|
3956
|
+
interface ApproveCreateRequestsResponseNonNullableFields$1 {
|
|
3957
|
+
createRequest: {
|
|
3958
|
+
group?: {
|
|
3959
|
+
privacyLevel: PrivacyStatus$1;
|
|
3960
|
+
privacyStatus: PrivacyStatus$1;
|
|
3961
|
+
accessRestriction?: {
|
|
3962
|
+
events?: {
|
|
3963
|
+
eventIds: string[];
|
|
3964
|
+
};
|
|
3965
|
+
type: Type;
|
|
3966
|
+
};
|
|
3967
|
+
details?: {
|
|
3968
|
+
logoPosition?: {
|
|
3969
|
+
x: number;
|
|
3970
|
+
y: number;
|
|
3971
|
+
};
|
|
3972
|
+
mobileLogoPosition?: {
|
|
3973
|
+
x: number;
|
|
3974
|
+
y: number;
|
|
3975
|
+
};
|
|
3976
|
+
};
|
|
3977
|
+
coverImage?: {
|
|
3978
|
+
position?: {
|
|
3979
|
+
x: number;
|
|
3980
|
+
y: number;
|
|
3981
|
+
};
|
|
3982
|
+
mobilePosition?: {
|
|
3983
|
+
x: number;
|
|
3984
|
+
y: number;
|
|
3985
|
+
};
|
|
3986
|
+
};
|
|
3987
|
+
settings?: {
|
|
3988
|
+
allowedToInviteMembers: AllowPolicy;
|
|
3989
|
+
allowedToApproveJoinRequests: AllowPolicy;
|
|
3990
|
+
allowedToAddMembers: AllowPolicy;
|
|
3991
|
+
allowedToCreatePosts: AllowPolicy;
|
|
3992
|
+
allowedToCommentPosts: AllowPolicy;
|
|
3993
|
+
onboardingStepsSettings: {
|
|
3994
|
+
stepKey: StepKey$1;
|
|
3995
|
+
visible: boolean;
|
|
3996
|
+
}[];
|
|
3997
|
+
};
|
|
3998
|
+
createdBy?: {
|
|
3999
|
+
identityType: IdentityType$1;
|
|
4000
|
+
};
|
|
4001
|
+
};
|
|
4002
|
+
status: RequestStatus$3;
|
|
4003
|
+
}[];
|
|
4004
|
+
}
|
|
4005
|
+
interface RejectCreateRequestsResponseNonNullableFields$1 {
|
|
4006
|
+
createRequest: {
|
|
4007
|
+
group?: {
|
|
4008
|
+
privacyLevel: PrivacyStatus$1;
|
|
4009
|
+
privacyStatus: PrivacyStatus$1;
|
|
4010
|
+
accessRestriction?: {
|
|
4011
|
+
events?: {
|
|
4012
|
+
eventIds: string[];
|
|
4013
|
+
};
|
|
4014
|
+
type: Type;
|
|
4015
|
+
};
|
|
4016
|
+
details?: {
|
|
4017
|
+
logoPosition?: {
|
|
4018
|
+
x: number;
|
|
4019
|
+
y: number;
|
|
4020
|
+
};
|
|
4021
|
+
mobileLogoPosition?: {
|
|
4022
|
+
x: number;
|
|
4023
|
+
y: number;
|
|
4024
|
+
};
|
|
4025
|
+
};
|
|
4026
|
+
coverImage?: {
|
|
4027
|
+
position?: {
|
|
4028
|
+
x: number;
|
|
4029
|
+
y: number;
|
|
4030
|
+
};
|
|
4031
|
+
mobilePosition?: {
|
|
4032
|
+
x: number;
|
|
4033
|
+
y: number;
|
|
4034
|
+
};
|
|
4035
|
+
};
|
|
4036
|
+
settings?: {
|
|
4037
|
+
allowedToInviteMembers: AllowPolicy;
|
|
4038
|
+
allowedToApproveJoinRequests: AllowPolicy;
|
|
4039
|
+
allowedToAddMembers: AllowPolicy;
|
|
4040
|
+
allowedToCreatePosts: AllowPolicy;
|
|
4041
|
+
allowedToCommentPosts: AllowPolicy;
|
|
4042
|
+
onboardingStepsSettings: {
|
|
4043
|
+
stepKey: StepKey$1;
|
|
4044
|
+
visible: boolean;
|
|
4045
|
+
}[];
|
|
4046
|
+
};
|
|
4047
|
+
createdBy?: {
|
|
4048
|
+
identityType: IdentityType$1;
|
|
4049
|
+
};
|
|
4050
|
+
};
|
|
4051
|
+
status: RequestStatus$3;
|
|
4052
|
+
}[];
|
|
4053
|
+
}
|
|
4054
|
+
interface ListCreateRequestsResponseNonNullableFields$1 {
|
|
4055
|
+
createRequests: {
|
|
4056
|
+
group?: {
|
|
4057
|
+
privacyLevel: PrivacyStatus$1;
|
|
4058
|
+
privacyStatus: PrivacyStatus$1;
|
|
4059
|
+
accessRestriction?: {
|
|
4060
|
+
events?: {
|
|
4061
|
+
eventIds: string[];
|
|
4062
|
+
};
|
|
4063
|
+
type: Type;
|
|
4064
|
+
};
|
|
4065
|
+
details?: {
|
|
4066
|
+
logoPosition?: {
|
|
4067
|
+
x: number;
|
|
4068
|
+
y: number;
|
|
4069
|
+
};
|
|
4070
|
+
mobileLogoPosition?: {
|
|
4071
|
+
x: number;
|
|
4072
|
+
y: number;
|
|
4073
|
+
};
|
|
4074
|
+
};
|
|
4075
|
+
coverImage?: {
|
|
4076
|
+
position?: {
|
|
4077
|
+
x: number;
|
|
4078
|
+
y: number;
|
|
4079
|
+
};
|
|
4080
|
+
mobilePosition?: {
|
|
4081
|
+
x: number;
|
|
4082
|
+
y: number;
|
|
4083
|
+
};
|
|
4084
|
+
};
|
|
4085
|
+
settings?: {
|
|
4086
|
+
allowedToInviteMembers: AllowPolicy;
|
|
4087
|
+
allowedToApproveJoinRequests: AllowPolicy;
|
|
4088
|
+
allowedToAddMembers: AllowPolicy;
|
|
4089
|
+
allowedToCreatePosts: AllowPolicy;
|
|
4090
|
+
allowedToCommentPosts: AllowPolicy;
|
|
4091
|
+
onboardingStepsSettings: {
|
|
4092
|
+
stepKey: StepKey$1;
|
|
4093
|
+
visible: boolean;
|
|
4094
|
+
}[];
|
|
4095
|
+
};
|
|
4096
|
+
createdBy?: {
|
|
4097
|
+
identityType: IdentityType$1;
|
|
4098
|
+
};
|
|
4099
|
+
};
|
|
4100
|
+
status: RequestStatus$3;
|
|
4101
|
+
}[];
|
|
4102
|
+
}
|
|
4103
|
+
interface QueryCreateRequestsResponseNonNullableFields$1 {
|
|
4104
|
+
createRequests: {
|
|
4105
|
+
group?: {
|
|
4106
|
+
privacyLevel: PrivacyStatus$1;
|
|
4107
|
+
privacyStatus: PrivacyStatus$1;
|
|
4108
|
+
accessRestriction?: {
|
|
4109
|
+
events?: {
|
|
4110
|
+
eventIds: string[];
|
|
4111
|
+
};
|
|
4112
|
+
type: Type;
|
|
4113
|
+
};
|
|
4114
|
+
details?: {
|
|
4115
|
+
logoPosition?: {
|
|
4116
|
+
x: number;
|
|
4117
|
+
y: number;
|
|
4118
|
+
};
|
|
4119
|
+
mobileLogoPosition?: {
|
|
4120
|
+
x: number;
|
|
4121
|
+
y: number;
|
|
4122
|
+
};
|
|
4123
|
+
};
|
|
4124
|
+
coverImage?: {
|
|
4125
|
+
position?: {
|
|
4126
|
+
x: number;
|
|
4127
|
+
y: number;
|
|
4128
|
+
};
|
|
4129
|
+
mobilePosition?: {
|
|
4130
|
+
x: number;
|
|
4131
|
+
y: number;
|
|
4132
|
+
};
|
|
4133
|
+
};
|
|
4134
|
+
settings?: {
|
|
4135
|
+
allowedToInviteMembers: AllowPolicy;
|
|
4136
|
+
allowedToApproveJoinRequests: AllowPolicy;
|
|
4137
|
+
allowedToAddMembers: AllowPolicy;
|
|
4138
|
+
allowedToCreatePosts: AllowPolicy;
|
|
4139
|
+
allowedToCommentPosts: AllowPolicy;
|
|
4140
|
+
onboardingStepsSettings: {
|
|
4141
|
+
stepKey: StepKey$1;
|
|
4142
|
+
visible: boolean;
|
|
4143
|
+
}[];
|
|
4144
|
+
};
|
|
4145
|
+
createdBy?: {
|
|
4146
|
+
identityType: IdentityType$1;
|
|
4147
|
+
};
|
|
4148
|
+
};
|
|
4149
|
+
status: RequestStatus$3;
|
|
4150
|
+
}[];
|
|
4151
|
+
}
|
|
4152
|
+
|
|
4153
|
+
/**
|
|
4154
|
+
* >**Notes:**
|
|
4155
|
+
* > + Site owners may set that members are not permitted to create groups in the Wix Groups application settings.
|
|
4156
|
+
* > + In this situation, site members have to submit a Create Request to create a new group.
|
|
4157
|
+
* > + Create Requests can be approved or rejected by an admin.
|
|
4158
|
+
* > + After a Create Request has been approved, the new group is added to the Group List in the Wix Groups app home page.
|
|
4159
|
+
* > + See [Introduction](https://dev.wix.com/api/rest/wix-groups/groups/introduction#wix-groups_groups_introduction_terminology) for more details.
|
|
4160
|
+
*/
|
|
4161
|
+
interface CreateRequest {
|
|
4162
|
+
/**
|
|
4163
|
+
* Create request ID
|
|
4164
|
+
* @readonly
|
|
4165
|
+
*/
|
|
4166
|
+
_id?: string | null;
|
|
4167
|
+
/** Group requested for creation. */
|
|
4168
|
+
group?: Group;
|
|
4169
|
+
/**
|
|
4170
|
+
* Status of request.
|
|
4171
|
+
* - `PENDING` - Pending request.
|
|
4172
|
+
* - `APPROVED` - Approved request.
|
|
4173
|
+
* - `REJECTED` - Rejected request.
|
|
4174
|
+
* - `CANCELED` - Canceled request.
|
|
4175
|
+
*/
|
|
4176
|
+
status?: RequestStatus$2;
|
|
4177
|
+
/** Request details. */
|
|
4178
|
+
requestDetails?: RequestDetails$2;
|
|
4179
|
+
}
|
|
4180
|
+
interface Group {
|
|
4181
|
+
/**
|
|
4182
|
+
* Group ID.
|
|
4183
|
+
* @readonly
|
|
4184
|
+
*/
|
|
4185
|
+
_id?: string | null;
|
|
4186
|
+
/** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */
|
|
4187
|
+
slug?: string | null;
|
|
4188
|
+
/**
|
|
4189
|
+
* __Deprecated.__ Use `privacyStatus` instead.
|
|
4190
|
+
* This property will be removed on June 30, 2022.
|
|
4191
|
+
* @deprecated
|
|
4192
|
+
*/
|
|
4193
|
+
privacyLevel?: PrivacyStatus;
|
|
4194
|
+
/**
|
|
4195
|
+
* Group privacy status.
|
|
4196
|
+
* - `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.
|
|
4197
|
+
* - `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.
|
|
4198
|
+
* - `SECRET` - Only admins and members can see the group. New members can only be added by other members.
|
|
4199
|
+
*/
|
|
4200
|
+
privacyStatus?: PrivacyStatus;
|
|
4201
|
+
/**
|
|
4202
|
+
* __Deprecated.__ Use `name` instead.
|
|
4203
|
+
* This property will be removed on June 30, 2022.
|
|
4204
|
+
* @deprecated
|
|
4205
|
+
*/
|
|
4206
|
+
title?: string | null;
|
|
4207
|
+
/** Group name. */
|
|
4208
|
+
name?: string | null;
|
|
4209
|
+
/** Group description in DraftJS format. */
|
|
4210
|
+
description?: string | null;
|
|
4211
|
+
/** Group teaser. */
|
|
4212
|
+
teaser?: string | null;
|
|
4213
|
+
/**
|
|
4214
|
+
* __Deprecated.__
|
|
4215
|
+
* For `details.logo`, use `coverImage` instead.
|
|
4216
|
+
* For `details.membersTitle`, `memberTitle` instead.
|
|
4217
|
+
* This property will be removed on June 30, 2022.
|
|
4218
|
+
* @deprecated
|
|
4219
|
+
*/
|
|
4220
|
+
details?: GroupDetails;
|
|
4221
|
+
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
4222
|
+
memberTitle?: string | null;
|
|
4223
|
+
/** Cover image. You cannot upload your own cover image. */
|
|
4224
|
+
coverImage?: CoverImage;
|
|
4225
|
+
/** Group specific settings. Available to the site owners under `Admin Tools` in the dashboard. */
|
|
4226
|
+
settings?: GroupSettings;
|
|
4227
|
+
/**
|
|
4228
|
+
* Total count of current group members.
|
|
4229
|
+
* @readonly
|
|
4230
|
+
*/
|
|
4231
|
+
membersCount?: number | null;
|
|
4232
|
+
/**
|
|
4233
|
+
* __Deprecated.__ Use `ownerId` instead.
|
|
4234
|
+
* This property will be removed on June 30, 2022.
|
|
4235
|
+
* @readonly
|
|
4236
|
+
* @deprecated
|
|
4237
|
+
*/
|
|
4238
|
+
createdBy?: Identity;
|
|
4239
|
+
/**
|
|
4240
|
+
* Group owner.
|
|
4241
|
+
* @readonly
|
|
4242
|
+
*/
|
|
4243
|
+
ownerId?: string | null;
|
|
4244
|
+
/**
|
|
4245
|
+
* Group creation date and time.
|
|
4246
|
+
* @readonly
|
|
4247
|
+
*/
|
|
4248
|
+
_createdDate?: Date;
|
|
4249
|
+
/**
|
|
4250
|
+
* Date and time of the latest group update.
|
|
4251
|
+
* @readonly
|
|
4252
|
+
*/
|
|
4253
|
+
_updatedDate?: Date;
|
|
4254
|
+
/**
|
|
4255
|
+
* __Deprecated.__ Use `lastActivityDate` instead.
|
|
4256
|
+
* This property will be removed on June 30, 2022.
|
|
4257
|
+
* @readonly
|
|
4258
|
+
* @deprecated
|
|
4259
|
+
*/
|
|
4260
|
+
recentActivityDate?: Date;
|
|
4261
|
+
/**
|
|
4262
|
+
* Date and time of the most recent group activity, for example a post or comment.
|
|
4263
|
+
* @readonly
|
|
4264
|
+
*/
|
|
4265
|
+
lastActivityDate?: Date;
|
|
4266
|
+
}
|
|
4267
|
+
interface Logo {
|
|
4268
|
+
/** Logo image ID (for internal use). */
|
|
4269
|
+
mediaId?: string | null;
|
|
4270
|
+
/** Logo image width. */
|
|
4271
|
+
width?: number | null;
|
|
4272
|
+
/** Logo image height. */
|
|
4273
|
+
height?: number | null;
|
|
4274
|
+
}
|
|
4275
|
+
interface Image {
|
|
4276
|
+
/** Image ID (for internal use). */
|
|
4277
|
+
mediaId?: string | null;
|
|
4278
|
+
/** Image width. */
|
|
4279
|
+
width?: number | null;
|
|
4280
|
+
/** Image height. */
|
|
4281
|
+
height?: number | null;
|
|
4282
|
+
}
|
|
4283
|
+
interface Position {
|
|
4284
|
+
/** horizontal coordinate */
|
|
4285
|
+
x?: number;
|
|
4286
|
+
/** vertical coordinate */
|
|
4287
|
+
y?: number;
|
|
4288
|
+
}
|
|
4289
|
+
interface OnboardingStepSettings {
|
|
4290
|
+
stepKey?: StepKey;
|
|
4291
|
+
visible?: boolean;
|
|
4292
|
+
}
|
|
4293
|
+
declare enum StepKey {
|
|
4294
|
+
UNKNOWN = "UNKNOWN",
|
|
4295
|
+
CREATE_POST = "CREATE_POST",
|
|
4296
|
+
REACT_TO_POST = "REACT_TO_POST",
|
|
4297
|
+
INVITE_MEMBERS = "INVITE_MEMBERS"
|
|
4298
|
+
}
|
|
4299
|
+
declare enum PrivacyStatus {
|
|
4300
|
+
UNKNOWN = "UNKNOWN",
|
|
4301
|
+
/** Anyone can see the group in the group list and view its content. Anyone can join. */
|
|
4302
|
+
PUBLIC = "PUBLIC",
|
|
4303
|
+
/** Anyone can see the group in the group list, but only group members can see its content. In order to join a group, a group join request must be submitted. */
|
|
4304
|
+
PRIVATE = "PRIVATE",
|
|
4305
|
+
/** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */
|
|
4306
|
+
SECRET = "SECRET"
|
|
4307
|
+
}
|
|
4308
|
+
interface GroupDetails {
|
|
4309
|
+
/** Group logo. You cannot upload your own logo. */
|
|
4310
|
+
logo?: Logo;
|
|
4311
|
+
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
4312
|
+
membersTitle?: string | null;
|
|
4313
|
+
}
|
|
4314
|
+
interface CoverImage {
|
|
4315
|
+
/** Cover image. */
|
|
4316
|
+
image?: Image;
|
|
4317
|
+
/** Position of the corner of the cover image (or logo). */
|
|
4318
|
+
position?: Position;
|
|
4319
|
+
/** Position of the corner of the cover image (or logo) for mobile browser. */
|
|
4320
|
+
mobilePosition?: Position;
|
|
4321
|
+
}
|
|
4322
|
+
interface GroupSettings {
|
|
4323
|
+
/**
|
|
4324
|
+
* __Deprecated.__ Use `allowedToInviteMembers` instead.
|
|
4325
|
+
* Whether regular members are permitted to invite new members.
|
|
4326
|
+
* If `false`, only admins can invite members. Defaults to `true`.
|
|
4327
|
+
* @deprecated
|
|
4328
|
+
*/
|
|
4329
|
+
membersCanInvite?: boolean | null;
|
|
4330
|
+
/**
|
|
4331
|
+
* __Deprecated.__ Use `allowedToApproveJoinRequests` instead.
|
|
4332
|
+
* Whether all group members are permitted to approve join group requests.
|
|
4333
|
+
* If `false`, member approval is limited to the admins.
|
|
4334
|
+
* @deprecated
|
|
4335
|
+
*/
|
|
4336
|
+
membersCanApprove?: boolean | null;
|
|
4337
|
+
/**
|
|
4338
|
+
* __Deprecated.__ Use `welcomeMemberPostEnabled` instead.
|
|
4339
|
+
* This property will be removed on June 30, 2022.
|
|
4340
|
+
* @deprecated
|
|
4341
|
+
*/
|
|
4342
|
+
memberWelcomePostEnabled?: boolean | null;
|
|
4343
|
+
/** Whether a daily post about new members is enabled. */
|
|
4344
|
+
welcomeMemberPostEnabled?: boolean | null;
|
|
4345
|
+
/** Whether an automatic post about changing the group details is enabled. */
|
|
4346
|
+
groupDetailsChangedPostEnabled?: boolean | null;
|
|
4347
|
+
/** Whether all members can see the full member list. */
|
|
4348
|
+
showMemberList?: boolean | null;
|
|
4349
|
+
onboardingStepsSettings?: OnboardingStepSettings[];
|
|
4350
|
+
}
|
|
4351
|
+
interface Identity {
|
|
4352
|
+
/** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
4353
|
+
_id?: string | null;
|
|
4354
|
+
identityType?: IdentityType;
|
|
4355
|
+
}
|
|
4356
|
+
declare enum IdentityType {
|
|
4357
|
+
USER = "USER",
|
|
4358
|
+
MEMBER = "MEMBER"
|
|
4359
|
+
}
|
|
4360
|
+
declare enum RequestStatus$2 {
|
|
4361
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
4362
|
+
/** Pending request. */
|
|
4363
|
+
PENDING = "PENDING",
|
|
4364
|
+
/** Approved request. */
|
|
4365
|
+
APPROVED = "APPROVED",
|
|
4366
|
+
/** Rejected request. */
|
|
4367
|
+
REJECTED = "REJECTED",
|
|
4368
|
+
/** Cancelled request. */
|
|
4369
|
+
CANCELLED = "CANCELLED",
|
|
4370
|
+
/** Canceled request. */
|
|
4371
|
+
CANCELED = "CANCELED"
|
|
4372
|
+
}
|
|
4373
|
+
interface RequestDetails$2 {
|
|
4374
|
+
/** Reason the request has been rejected. */
|
|
4375
|
+
rejectionReason?: string | null;
|
|
4376
|
+
}
|
|
4377
|
+
interface ApproveCreateRequestsRequest {
|
|
4378
|
+
/** Create Request IDs to approve. Limited to `100`. */
|
|
4379
|
+
createRequestIds?: string[];
|
|
4380
|
+
}
|
|
4381
|
+
interface ApproveCreateRequestsResponse {
|
|
4382
|
+
/** Approved Create Requests. */
|
|
4383
|
+
createRequest?: CreateRequest[];
|
|
4384
|
+
}
|
|
4385
|
+
interface RejectCreateRequestsRequest {
|
|
4386
|
+
/** Rejection data. */
|
|
4387
|
+
rejections?: Rejection$2[];
|
|
4388
|
+
}
|
|
4389
|
+
interface Rejection$2 {
|
|
4390
|
+
/** ID of the Create Request to reject. */
|
|
4391
|
+
createRequestId?: string;
|
|
4392
|
+
/** Rejection reason. Free text displayed to the creator of the rejected Create Request. Limited to 1,000 characters. */
|
|
4393
|
+
reason?: string | null;
|
|
4394
|
+
}
|
|
4395
|
+
interface RejectCreateRequestsResponse {
|
|
4396
|
+
/** Rejected Create Requests. */
|
|
4397
|
+
createRequest?: CreateRequest[];
|
|
4398
|
+
}
|
|
4399
|
+
interface ListCreateRequestsRequest {
|
|
4400
|
+
/** Number of items to load. Maximum `100`. */
|
|
4401
|
+
limit?: number | null;
|
|
4402
|
+
/** Number of items to skip in the current sort order. */
|
|
4403
|
+
offset?: number | null;
|
|
4404
|
+
}
|
|
4405
|
+
interface ListCreateRequestsResponse {
|
|
4406
|
+
/** Create Requests. */
|
|
4407
|
+
createRequests?: CreateRequest[];
|
|
4408
|
+
metadata?: PagingMetadata$2;
|
|
4409
|
+
}
|
|
4410
|
+
interface PagingMetadata$2 {
|
|
4411
|
+
/** Number of items returned in the response. */
|
|
4412
|
+
count?: number | null;
|
|
4413
|
+
/** Offset that was requested. */
|
|
4414
|
+
offset?: number | null;
|
|
4415
|
+
/** Total number of items that match the query. */
|
|
4416
|
+
total?: number | null;
|
|
4417
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
4418
|
+
tooManyToCount?: boolean | null;
|
|
4419
|
+
}
|
|
4420
|
+
interface QueryCreateRequestsRequest {
|
|
4421
|
+
query?: Query$2;
|
|
4422
|
+
}
|
|
4423
|
+
interface Query$2 {
|
|
4424
|
+
/**
|
|
4425
|
+
* Filter object in the following format:
|
|
4426
|
+
* `"filter" : {
|
|
4427
|
+
* "fieldName1": "value1",
|
|
4428
|
+
* "fieldName2":{"$operator":"value2"}
|
|
4429
|
+
* }`
|
|
4430
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
4431
|
+
*/
|
|
4432
|
+
filter?: any;
|
|
4433
|
+
/**
|
|
4434
|
+
* Sort object in the following format:
|
|
4435
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
4436
|
+
*/
|
|
4437
|
+
sort?: Sorting$2[];
|
|
4438
|
+
/** Paging options to limit and skip the number of items. */
|
|
4439
|
+
paging?: Paging$2;
|
|
4440
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
4441
|
+
fields?: string[];
|
|
4442
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
4443
|
+
fieldsets?: string[];
|
|
4444
|
+
}
|
|
4445
|
+
interface Sorting$2 {
|
|
4446
|
+
/** Name of the field to sort by. */
|
|
4447
|
+
fieldName?: string;
|
|
4448
|
+
/** Sort order. */
|
|
4449
|
+
order?: SortOrder$2;
|
|
4450
|
+
}
|
|
4451
|
+
declare enum SortOrder$2 {
|
|
4452
|
+
ASC = "ASC",
|
|
4453
|
+
DESC = "DESC"
|
|
4454
|
+
}
|
|
4455
|
+
interface Paging$2 {
|
|
4456
|
+
/** Number of items to load. */
|
|
4457
|
+
limit?: number | null;
|
|
4458
|
+
/** Number of items to skip in the current sort order. */
|
|
4459
|
+
offset?: number | null;
|
|
4460
|
+
}
|
|
4461
|
+
interface QueryCreateRequestsResponse {
|
|
4462
|
+
/** Retrieved Create Requests. */
|
|
4463
|
+
createRequests?: CreateRequest[];
|
|
4464
|
+
metadata?: PagingMetadata$2;
|
|
4465
|
+
}
|
|
4466
|
+
interface ApproveCreateRequestsResponseNonNullableFields {
|
|
4467
|
+
createRequest: {
|
|
4468
|
+
group?: {
|
|
4469
|
+
privacyLevel: PrivacyStatus;
|
|
4470
|
+
privacyStatus: PrivacyStatus;
|
|
4471
|
+
coverImage?: {
|
|
4472
|
+
position?: {
|
|
4473
|
+
x: number;
|
|
4474
|
+
y: number;
|
|
4475
|
+
};
|
|
4476
|
+
mobilePosition?: {
|
|
4477
|
+
x: number;
|
|
4478
|
+
y: number;
|
|
4479
|
+
};
|
|
4480
|
+
};
|
|
4481
|
+
settings?: {
|
|
4482
|
+
onboardingStepsSettings: {
|
|
4483
|
+
stepKey: StepKey;
|
|
4484
|
+
visible: boolean;
|
|
4485
|
+
}[];
|
|
4486
|
+
};
|
|
4487
|
+
createdBy?: {
|
|
4488
|
+
identityType: IdentityType;
|
|
4489
|
+
};
|
|
4490
|
+
};
|
|
4491
|
+
status: RequestStatus$2;
|
|
4492
|
+
}[];
|
|
4493
|
+
}
|
|
4494
|
+
interface RejectCreateRequestsResponseNonNullableFields {
|
|
4495
|
+
createRequest: {
|
|
4496
|
+
group?: {
|
|
4497
|
+
privacyLevel: PrivacyStatus;
|
|
4498
|
+
privacyStatus: PrivacyStatus;
|
|
4499
|
+
coverImage?: {
|
|
4500
|
+
position?: {
|
|
4501
|
+
x: number;
|
|
4502
|
+
y: number;
|
|
4503
|
+
};
|
|
4504
|
+
mobilePosition?: {
|
|
4505
|
+
x: number;
|
|
4506
|
+
y: number;
|
|
4507
|
+
};
|
|
4508
|
+
};
|
|
4509
|
+
settings?: {
|
|
4510
|
+
onboardingStepsSettings: {
|
|
4511
|
+
stepKey: StepKey;
|
|
4512
|
+
visible: boolean;
|
|
4513
|
+
}[];
|
|
4514
|
+
};
|
|
4515
|
+
createdBy?: {
|
|
4516
|
+
identityType: IdentityType;
|
|
4517
|
+
};
|
|
4518
|
+
};
|
|
4519
|
+
status: RequestStatus$2;
|
|
4520
|
+
}[];
|
|
4521
|
+
}
|
|
4522
|
+
interface ListCreateRequestsResponseNonNullableFields {
|
|
4523
|
+
createRequests: {
|
|
4524
|
+
group?: {
|
|
4525
|
+
privacyLevel: PrivacyStatus;
|
|
4526
|
+
privacyStatus: PrivacyStatus;
|
|
4527
|
+
coverImage?: {
|
|
4528
|
+
position?: {
|
|
4529
|
+
x: number;
|
|
4530
|
+
y: number;
|
|
4531
|
+
};
|
|
4532
|
+
mobilePosition?: {
|
|
4533
|
+
x: number;
|
|
4534
|
+
y: number;
|
|
4535
|
+
};
|
|
4536
|
+
};
|
|
4537
|
+
settings?: {
|
|
4538
|
+
onboardingStepsSettings: {
|
|
4539
|
+
stepKey: StepKey;
|
|
4540
|
+
visible: boolean;
|
|
4541
|
+
}[];
|
|
4542
|
+
};
|
|
4543
|
+
createdBy?: {
|
|
4544
|
+
identityType: IdentityType;
|
|
4545
|
+
};
|
|
4546
|
+
};
|
|
4547
|
+
status: RequestStatus$2;
|
|
4548
|
+
}[];
|
|
4549
|
+
}
|
|
4550
|
+
interface QueryCreateRequestsResponseNonNullableFields {
|
|
4551
|
+
createRequests: {
|
|
4552
|
+
group?: {
|
|
4553
|
+
privacyLevel: PrivacyStatus;
|
|
4554
|
+
privacyStatus: PrivacyStatus;
|
|
4555
|
+
coverImage?: {
|
|
4556
|
+
position?: {
|
|
4557
|
+
x: number;
|
|
4558
|
+
y: number;
|
|
4559
|
+
};
|
|
4560
|
+
mobilePosition?: {
|
|
4561
|
+
x: number;
|
|
4562
|
+
y: number;
|
|
4563
|
+
};
|
|
4564
|
+
};
|
|
4565
|
+
settings?: {
|
|
4566
|
+
onboardingStepsSettings: {
|
|
4567
|
+
stepKey: StepKey;
|
|
4568
|
+
visible: boolean;
|
|
4569
|
+
}[];
|
|
4570
|
+
};
|
|
4571
|
+
createdBy?: {
|
|
4572
|
+
identityType: IdentityType;
|
|
4573
|
+
};
|
|
4574
|
+
};
|
|
4575
|
+
status: RequestStatus$2;
|
|
4576
|
+
}[];
|
|
4577
|
+
}
|
|
4578
|
+
|
|
4579
|
+
type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
4580
|
+
getUrl: (context: any) => string;
|
|
4581
|
+
httpMethod: K;
|
|
4582
|
+
path: string;
|
|
4583
|
+
pathParams: M;
|
|
4584
|
+
__requestType: T;
|
|
4585
|
+
__originalRequestType: S;
|
|
4586
|
+
__responseType: Q;
|
|
4587
|
+
__originalResponseType: R;
|
|
4588
|
+
};
|
|
4589
|
+
declare function approveCreateRequests(): __PublicMethodMetaInfo$1<'POST', {}, ApproveCreateRequestsRequest, ApproveCreateRequestsRequest$1, ApproveCreateRequestsResponse & ApproveCreateRequestsResponseNonNullableFields, ApproveCreateRequestsResponse$1 & ApproveCreateRequestsResponseNonNullableFields$1>;
|
|
4590
|
+
declare function rejectCreateRequests(): __PublicMethodMetaInfo$1<'POST', {}, RejectCreateRequestsRequest, RejectCreateRequestsRequest$1, RejectCreateRequestsResponse & RejectCreateRequestsResponseNonNullableFields, RejectCreateRequestsResponse$1 & RejectCreateRequestsResponseNonNullableFields$1>;
|
|
4591
|
+
declare function listCreateRequests(): __PublicMethodMetaInfo$1<'GET', {}, ListCreateRequestsRequest, ListCreateRequestsRequest$1, ListCreateRequestsResponse & ListCreateRequestsResponseNonNullableFields, ListCreateRequestsResponse$1 & ListCreateRequestsResponseNonNullableFields$1>;
|
|
4592
|
+
declare function queryCreateRequests(): __PublicMethodMetaInfo$1<'POST', {}, QueryCreateRequestsRequest, QueryCreateRequestsRequest$1, QueryCreateRequestsResponse & QueryCreateRequestsResponseNonNullableFields, QueryCreateRequestsResponse$1 & QueryCreateRequestsResponseNonNullableFields$1>;
|
|
4593
|
+
|
|
4594
|
+
declare const meta$1_approveCreateRequests: typeof approveCreateRequests;
|
|
4595
|
+
declare const meta$1_listCreateRequests: typeof listCreateRequests;
|
|
4596
|
+
declare const meta$1_queryCreateRequests: typeof queryCreateRequests;
|
|
4597
|
+
declare const meta$1_rejectCreateRequests: typeof rejectCreateRequests;
|
|
4598
|
+
declare namespace meta$1 {
|
|
4599
|
+
export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_approveCreateRequests as approveCreateRequests, meta$1_listCreateRequests as listCreateRequests, meta$1_queryCreateRequests as queryCreateRequests, meta$1_rejectCreateRequests as rejectCreateRequests };
|
|
4600
|
+
}
|
|
4601
|
+
|
|
4602
|
+
/**
|
|
4603
|
+
* To join a private group, a site member must submit a Join Request, which can be approved or rejected by an admin.
|
|
4604
|
+
* When the request is approved, the site member becomes a group member.
|
|
4605
|
+
*/
|
|
4606
|
+
interface JoinRequest$1 {
|
|
4607
|
+
/**
|
|
4608
|
+
* Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.
|
|
4609
|
+
* @readonly
|
|
4610
|
+
*/
|
|
4611
|
+
memberId?: string;
|
|
4612
|
+
/**
|
|
4613
|
+
* Join request status.
|
|
4614
|
+
* - `PENDING` - Pending join request.
|
|
4615
|
+
* - `APPROVED` - Approved join request.
|
|
4616
|
+
* - `REJECTED` - Rejected join request.
|
|
4617
|
+
* - `CANCELED` - Canceled join request.
|
|
4618
|
+
*/
|
|
4619
|
+
status?: RequestStatus$1;
|
|
4620
|
+
/** Join request details. */
|
|
4621
|
+
requestDetails?: RequestDetails$1;
|
|
4622
|
+
}
|
|
4623
|
+
declare enum RequestStatus$1 {
|
|
4624
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
4625
|
+
/** Pending request. */
|
|
4626
|
+
PENDING = "PENDING",
|
|
4627
|
+
/** Approved request. */
|
|
4628
|
+
APPROVED = "APPROVED",
|
|
4629
|
+
/** Rejected request. */
|
|
4630
|
+
REJECTED = "REJECTED",
|
|
4631
|
+
/** Cancelled request. */
|
|
4632
|
+
CANCELLED = "CANCELLED",
|
|
4633
|
+
/** Canceled request. */
|
|
4634
|
+
CANCELED = "CANCELED"
|
|
4635
|
+
}
|
|
4636
|
+
interface RequestDetails$1 {
|
|
4637
|
+
/** Reason the request has been rejected. */
|
|
4638
|
+
rejectionReason?: string | null;
|
|
4639
|
+
}
|
|
4640
|
+
interface ApproveJoinRequestsRequest$1 {
|
|
4641
|
+
/** Relevant group. */
|
|
4642
|
+
groupId: string;
|
|
4643
|
+
/** Member IDs to approve. */
|
|
4644
|
+
memberIds: string[];
|
|
4645
|
+
}
|
|
4646
|
+
interface ApproveJoinRequestsResponse$1 {
|
|
4647
|
+
/** Approved join requests. */
|
|
4648
|
+
joinRequests?: JoinRequest$1[];
|
|
4649
|
+
}
|
|
4650
|
+
interface RejectJoinRequestsRequest$1 {
|
|
4651
|
+
/** Relevant group. */
|
|
4652
|
+
groupId: string;
|
|
4653
|
+
/** Rejection data. */
|
|
4654
|
+
rejections?: Rejection$1[];
|
|
4655
|
+
}
|
|
4656
|
+
interface Rejection$1 {
|
|
4657
|
+
/** Member ID to reject. */
|
|
4658
|
+
memberId?: string;
|
|
4659
|
+
/** Rejection reason. Free text that will be displayed to the rejected site member (max 1,000 characters). */
|
|
4660
|
+
reason?: string | null;
|
|
4661
|
+
}
|
|
4662
|
+
interface RejectJoinRequestsResponse$1 {
|
|
4663
|
+
/** Rejected join requests. */
|
|
4664
|
+
joinRequests?: JoinRequest$1[];
|
|
4665
|
+
}
|
|
4666
|
+
interface ListJoinRequestsRequest$1 {
|
|
4667
|
+
/** Group ID. */
|
|
4668
|
+
groupId: string;
|
|
4669
|
+
limit?: number | null;
|
|
4670
|
+
offset?: number | null;
|
|
4671
|
+
}
|
|
4672
|
+
interface ListJoinRequestsResponse$1 {
|
|
4673
|
+
/** Join requests. */
|
|
4674
|
+
joinRequests?: JoinRequest$1[];
|
|
4675
|
+
metadata?: PagingMetadata$1;
|
|
4676
|
+
}
|
|
4677
|
+
interface PagingMetadata$1 {
|
|
4678
|
+
/** Number of items returned in the response. */
|
|
4679
|
+
count?: number | null;
|
|
4680
|
+
/** Offset that was requested. */
|
|
4681
|
+
offset?: number | null;
|
|
4682
|
+
/** Total number of items that match the query. */
|
|
4683
|
+
total?: number | null;
|
|
4684
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
4685
|
+
tooManyToCount?: boolean | null;
|
|
4686
|
+
}
|
|
4687
|
+
interface QueryJoinRequestsRequest$1 {
|
|
4688
|
+
/** Group ID. */
|
|
4689
|
+
groupId: string;
|
|
4690
|
+
query?: Query$1;
|
|
4691
|
+
}
|
|
4692
|
+
interface Query$1 {
|
|
4693
|
+
/**
|
|
4694
|
+
* Filter object in the following format:
|
|
4695
|
+
* `"filter" : {
|
|
4696
|
+
* "fieldName1": "value1",
|
|
4697
|
+
* "fieldName2":{"$operator":"value2"}
|
|
4698
|
+
* }`
|
|
4699
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
4700
|
+
*/
|
|
4701
|
+
filter?: any;
|
|
4702
|
+
/**
|
|
4703
|
+
* Sort object in the following format:
|
|
4704
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
4705
|
+
*/
|
|
4706
|
+
sort?: Sorting$1[];
|
|
4707
|
+
/** Paging options to limit and skip the number of items. */
|
|
4708
|
+
paging?: Paging$1;
|
|
4709
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
4710
|
+
fields?: string[];
|
|
4711
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
4712
|
+
fieldsets?: string[];
|
|
4713
|
+
}
|
|
4714
|
+
interface Sorting$1 {
|
|
4715
|
+
/** Name of the field to sort by. */
|
|
4716
|
+
fieldName?: string;
|
|
4717
|
+
/** Sort order. */
|
|
4718
|
+
order?: SortOrder$1;
|
|
4719
|
+
}
|
|
4720
|
+
declare enum SortOrder$1 {
|
|
4721
|
+
ASC = "ASC",
|
|
4722
|
+
DESC = "DESC"
|
|
4723
|
+
}
|
|
4724
|
+
interface Paging$1 {
|
|
4725
|
+
/** Number of items to load. */
|
|
4726
|
+
limit?: number | null;
|
|
4727
|
+
/** Number of items to skip in the current sort order. */
|
|
4728
|
+
offset?: number | null;
|
|
4729
|
+
}
|
|
4730
|
+
interface QueryJoinRequestsResponse$1 {
|
|
4731
|
+
/** Join requests. */
|
|
4732
|
+
joinRequests?: JoinRequest$1[];
|
|
4733
|
+
metadata?: PagingMetadata$1;
|
|
4734
|
+
}
|
|
4735
|
+
interface ApproveJoinRequestsResponseNonNullableFields$1 {
|
|
4736
|
+
joinRequests: {
|
|
4737
|
+
memberId: string;
|
|
4738
|
+
status: RequestStatus$1;
|
|
4739
|
+
}[];
|
|
4740
|
+
}
|
|
4741
|
+
interface RejectJoinRequestsResponseNonNullableFields$1 {
|
|
4742
|
+
joinRequests: {
|
|
4743
|
+
memberId: string;
|
|
4744
|
+
status: RequestStatus$1;
|
|
4745
|
+
}[];
|
|
4746
|
+
}
|
|
4747
|
+
interface ListJoinRequestsResponseNonNullableFields$1 {
|
|
4748
|
+
joinRequests: {
|
|
4749
|
+
memberId: string;
|
|
4750
|
+
status: RequestStatus$1;
|
|
4751
|
+
}[];
|
|
4752
|
+
}
|
|
4753
|
+
interface QueryJoinRequestsResponseNonNullableFields$1 {
|
|
4754
|
+
joinRequests: {
|
|
4755
|
+
memberId: string;
|
|
4756
|
+
status: RequestStatus$1;
|
|
4757
|
+
}[];
|
|
4758
|
+
}
|
|
4759
|
+
|
|
4760
|
+
/**
|
|
4761
|
+
* To join a private group, a site member must submit a Join Request, which can be approved or rejected by an admin.
|
|
4762
|
+
* When the request is approved, the site member becomes a group member.
|
|
4763
|
+
*/
|
|
4764
|
+
interface JoinRequest {
|
|
4765
|
+
/**
|
|
4766
|
+
* Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.
|
|
4767
|
+
* @readonly
|
|
4768
|
+
*/
|
|
4769
|
+
memberId?: string;
|
|
4770
|
+
/**
|
|
4771
|
+
* Join request status.
|
|
4772
|
+
* - `PENDING` - Pending join request.
|
|
4773
|
+
* - `APPROVED` - Approved join request.
|
|
4774
|
+
* - `REJECTED` - Rejected join request.
|
|
4775
|
+
* - `CANCELED` - Canceled join request.
|
|
4776
|
+
*/
|
|
4777
|
+
status?: RequestStatus;
|
|
4778
|
+
/** Join request details. */
|
|
4779
|
+
requestDetails?: RequestDetails;
|
|
4780
|
+
}
|
|
4781
|
+
declare enum RequestStatus {
|
|
4782
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
4783
|
+
/** Pending request. */
|
|
4784
|
+
PENDING = "PENDING",
|
|
4785
|
+
/** Approved request. */
|
|
4786
|
+
APPROVED = "APPROVED",
|
|
4787
|
+
/** Rejected request. */
|
|
4788
|
+
REJECTED = "REJECTED",
|
|
4789
|
+
/** Cancelled request. */
|
|
4790
|
+
CANCELLED = "CANCELLED",
|
|
4791
|
+
/** Canceled request. */
|
|
4792
|
+
CANCELED = "CANCELED"
|
|
4793
|
+
}
|
|
4794
|
+
interface RequestDetails {
|
|
4795
|
+
/** Reason the request has been rejected. */
|
|
4796
|
+
rejectionReason?: string | null;
|
|
4797
|
+
}
|
|
4798
|
+
interface ApproveJoinRequestsRequest {
|
|
4799
|
+
/** Relevant group. */
|
|
4800
|
+
groupId: string;
|
|
4801
|
+
/** Member IDs to approve. */
|
|
4802
|
+
memberIds: string[];
|
|
4803
|
+
}
|
|
4804
|
+
interface ApproveJoinRequestsResponse {
|
|
4805
|
+
/** Approved join requests. */
|
|
4806
|
+
joinRequests?: JoinRequest[];
|
|
4807
|
+
}
|
|
4808
|
+
interface RejectJoinRequestsRequest {
|
|
4809
|
+
/** Relevant group. */
|
|
4810
|
+
groupId: string;
|
|
4811
|
+
/** Rejection data. */
|
|
4812
|
+
rejections?: Rejection[];
|
|
4813
|
+
}
|
|
4814
|
+
interface Rejection {
|
|
4815
|
+
/** Member ID to reject. */
|
|
4816
|
+
memberId?: string;
|
|
4817
|
+
/** Rejection reason. Free text that will be displayed to the rejected site member (max 1,000 characters). */
|
|
4818
|
+
reason?: string | null;
|
|
4819
|
+
}
|
|
4820
|
+
interface RejectJoinRequestsResponse {
|
|
4821
|
+
/** Rejected join requests. */
|
|
4822
|
+
joinRequests?: JoinRequest[];
|
|
4823
|
+
}
|
|
4824
|
+
interface ListJoinRequestsRequest {
|
|
4825
|
+
/** Group ID. */
|
|
4826
|
+
groupId: string;
|
|
4827
|
+
limit?: number | null;
|
|
4828
|
+
offset?: number | null;
|
|
4829
|
+
}
|
|
4830
|
+
interface ListJoinRequestsResponse {
|
|
4831
|
+
/** Join requests. */
|
|
4832
|
+
joinRequests?: JoinRequest[];
|
|
4833
|
+
metadata?: PagingMetadata;
|
|
4834
|
+
}
|
|
4835
|
+
interface PagingMetadata {
|
|
4836
|
+
/** Number of items returned in the response. */
|
|
4837
|
+
count?: number | null;
|
|
4838
|
+
/** Offset that was requested. */
|
|
4839
|
+
offset?: number | null;
|
|
4840
|
+
/** Total number of items that match the query. */
|
|
4841
|
+
total?: number | null;
|
|
4842
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
4843
|
+
tooManyToCount?: boolean | null;
|
|
4844
|
+
}
|
|
4845
|
+
interface QueryJoinRequestsRequest {
|
|
4846
|
+
/** Group ID. */
|
|
4847
|
+
groupId: string;
|
|
4848
|
+
query?: Query;
|
|
4849
|
+
}
|
|
4850
|
+
interface Query {
|
|
4851
|
+
/**
|
|
4852
|
+
* Filter object in the following format:
|
|
4853
|
+
* `"filter" : {
|
|
4854
|
+
* "fieldName1": "value1",
|
|
4855
|
+
* "fieldName2":{"$operator":"value2"}
|
|
4856
|
+
* }`
|
|
4857
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
4858
|
+
*/
|
|
4859
|
+
filter?: any;
|
|
4860
|
+
/**
|
|
4861
|
+
* Sort object in the following format:
|
|
4862
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
4863
|
+
*/
|
|
4864
|
+
sort?: Sorting[];
|
|
4865
|
+
/** Paging options to limit and skip the number of items. */
|
|
4866
|
+
paging?: Paging;
|
|
4867
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
4868
|
+
fields?: string[];
|
|
4869
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
4870
|
+
fieldsets?: string[];
|
|
4871
|
+
}
|
|
4872
|
+
interface Sorting {
|
|
4873
|
+
/** Name of the field to sort by. */
|
|
4874
|
+
fieldName?: string;
|
|
4875
|
+
/** Sort order. */
|
|
4876
|
+
order?: SortOrder;
|
|
4877
|
+
}
|
|
4878
|
+
declare enum SortOrder {
|
|
4879
|
+
ASC = "ASC",
|
|
4880
|
+
DESC = "DESC"
|
|
4881
|
+
}
|
|
4882
|
+
interface Paging {
|
|
4883
|
+
/** Number of items to load. */
|
|
4884
|
+
limit?: number | null;
|
|
4885
|
+
/** Number of items to skip in the current sort order. */
|
|
4886
|
+
offset?: number | null;
|
|
4887
|
+
}
|
|
4888
|
+
interface QueryJoinRequestsResponse {
|
|
4889
|
+
/** Join requests. */
|
|
4890
|
+
joinRequests?: JoinRequest[];
|
|
4891
|
+
metadata?: PagingMetadata;
|
|
4892
|
+
}
|
|
4893
|
+
interface ApproveJoinRequestsResponseNonNullableFields {
|
|
4894
|
+
joinRequests: {
|
|
4895
|
+
memberId: string;
|
|
4896
|
+
status: RequestStatus;
|
|
4897
|
+
}[];
|
|
4898
|
+
}
|
|
4899
|
+
interface RejectJoinRequestsResponseNonNullableFields {
|
|
4900
|
+
joinRequests: {
|
|
4901
|
+
memberId: string;
|
|
4902
|
+
status: RequestStatus;
|
|
4903
|
+
}[];
|
|
4904
|
+
}
|
|
4905
|
+
interface ListJoinRequestsResponseNonNullableFields {
|
|
4906
|
+
joinRequests: {
|
|
4907
|
+
memberId: string;
|
|
4908
|
+
status: RequestStatus;
|
|
4909
|
+
}[];
|
|
4910
|
+
}
|
|
4911
|
+
interface QueryJoinRequestsResponseNonNullableFields {
|
|
4912
|
+
joinRequests: {
|
|
4913
|
+
memberId: string;
|
|
4914
|
+
status: RequestStatus;
|
|
4915
|
+
}[];
|
|
4916
|
+
}
|
|
4917
|
+
|
|
4918
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
4919
|
+
getUrl: (context: any) => string;
|
|
4920
|
+
httpMethod: K;
|
|
4921
|
+
path: string;
|
|
4922
|
+
pathParams: M;
|
|
4923
|
+
__requestType: T;
|
|
4924
|
+
__originalRequestType: S;
|
|
4925
|
+
__responseType: Q;
|
|
4926
|
+
__originalResponseType: R;
|
|
4927
|
+
};
|
|
4928
|
+
declare function approveJoinRequests(): __PublicMethodMetaInfo<'POST', {
|
|
4929
|
+
groupId: string;
|
|
4930
|
+
}, ApproveJoinRequestsRequest, ApproveJoinRequestsRequest$1, ApproveJoinRequestsResponse & ApproveJoinRequestsResponseNonNullableFields, ApproveJoinRequestsResponse$1 & ApproveJoinRequestsResponseNonNullableFields$1>;
|
|
4931
|
+
declare function rejectJoinRequests(): __PublicMethodMetaInfo<'POST', {
|
|
4932
|
+
groupId: string;
|
|
4933
|
+
}, RejectJoinRequestsRequest, RejectJoinRequestsRequest$1, RejectJoinRequestsResponse & RejectJoinRequestsResponseNonNullableFields, RejectJoinRequestsResponse$1 & RejectJoinRequestsResponseNonNullableFields$1>;
|
|
4934
|
+
declare function listJoinRequests(): __PublicMethodMetaInfo<'GET', {
|
|
4935
|
+
groupId: string;
|
|
4936
|
+
}, ListJoinRequestsRequest, ListJoinRequestsRequest$1, ListJoinRequestsResponse & ListJoinRequestsResponseNonNullableFields, ListJoinRequestsResponse$1 & ListJoinRequestsResponseNonNullableFields$1>;
|
|
4937
|
+
declare function queryJoinRequests(): __PublicMethodMetaInfo<'POST', {
|
|
4938
|
+
groupId: string;
|
|
4939
|
+
}, QueryJoinRequestsRequest, QueryJoinRequestsRequest$1, QueryJoinRequestsResponse & QueryJoinRequestsResponseNonNullableFields, QueryJoinRequestsResponse$1 & QueryJoinRequestsResponseNonNullableFields$1>;
|
|
4940
|
+
|
|
4941
|
+
type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
|
|
4942
|
+
declare const meta_approveJoinRequests: typeof approveJoinRequests;
|
|
4943
|
+
declare const meta_listJoinRequests: typeof listJoinRequests;
|
|
4944
|
+
declare const meta_queryJoinRequests: typeof queryJoinRequests;
|
|
4945
|
+
declare const meta_rejectJoinRequests: typeof rejectJoinRequests;
|
|
4946
|
+
declare namespace meta {
|
|
4947
|
+
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_approveJoinRequests as approveJoinRequests, meta_listJoinRequests as listJoinRequests, meta_queryJoinRequests as queryJoinRequests, meta_rejectJoinRequests as rejectJoinRequests };
|
|
4948
|
+
}
|
|
4949
|
+
|
|
4950
|
+
export { meta$1 as createRequests, meta$6 as groupRequests, meta$8 as groups, meta$3 as joinGroupRequests, meta as joinRequests, meta$7 as members, meta$2 as membershipQuestions, meta$5 as roles, meta$4 as rules };
|