@wix/groups 1.0.5 → 1.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/build/cjs/index.d.ts +4 -0
  2. package/build/cjs/index.js +5 -1
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/src/social-groups-v2-group-member.universal.d.ts +6 -0
  5. package/build/cjs/src/social-groups-v2-group-member.universal.js +48 -18
  6. package/build/cjs/src/social-groups-v2-group-member.universal.js.map +1 -1
  7. package/build/cjs/src/social-groups-v2-group-request.http.d.ts +24 -0
  8. package/build/cjs/src/social-groups-v2-group-request.http.js +322 -0
  9. package/build/cjs/src/social-groups-v2-group-request.http.js.map +1 -0
  10. package/build/cjs/src/social-groups-v2-group-request.public.d.ts +8 -0
  11. package/build/cjs/src/social-groups-v2-group-request.public.js +37 -0
  12. package/build/cjs/src/social-groups-v2-group-request.public.js.map +1 -0
  13. package/build/cjs/src/social-groups-v2-group-request.types.d.ts +361 -0
  14. package/build/cjs/src/social-groups-v2-group-request.types.js +59 -0
  15. package/build/cjs/src/social-groups-v2-group-request.types.js.map +1 -0
  16. package/build/cjs/src/social-groups-v2-group-request.universal.d.ts +416 -0
  17. package/build/cjs/src/social-groups-v2-group-request.universal.js +316 -0
  18. package/build/cjs/src/social-groups-v2-group-request.universal.js.map +1 -0
  19. package/build/cjs/src/social-groups-v2-group-role.http.d.ts +16 -0
  20. package/build/cjs/src/social-groups-v2-group-role.http.js +225 -0
  21. package/build/cjs/src/social-groups-v2-group-role.http.js.map +1 -0
  22. package/build/cjs/src/social-groups-v2-group-role.public.d.ts +6 -0
  23. package/build/cjs/src/social-groups-v2-group-role.public.js +19 -0
  24. package/build/cjs/src/social-groups-v2-group-role.public.js.map +1 -0
  25. package/build/cjs/src/social-groups-v2-group-role.types.d.ts +108 -0
  26. package/build/cjs/src/social-groups-v2-group-role.types.js +12 -0
  27. package/build/cjs/src/social-groups-v2-group-role.types.js.map +1 -0
  28. package/build/cjs/src/social-groups-v2-group-role.universal.d.ts +158 -0
  29. package/build/cjs/src/social-groups-v2-group-role.universal.js +181 -0
  30. package/build/cjs/src/social-groups-v2-group-role.universal.js.map +1 -0
  31. package/build/cjs/src/social-groups-v2-group-rules.http.d.ts +9 -0
  32. package/build/cjs/src/social-groups-v2-group-rules.http.js +219 -0
  33. package/build/cjs/src/social-groups-v2-group-rules.http.js.map +1 -0
  34. package/build/cjs/src/social-groups-v2-group-rules.public.d.ts +5 -0
  35. package/build/cjs/src/social-groups-v2-group-rules.public.js +17 -0
  36. package/build/cjs/src/social-groups-v2-group-rules.public.js.map +1 -0
  37. package/build/cjs/src/social-groups-v2-group-rules.types.d.ts +40 -0
  38. package/build/cjs/src/social-groups-v2-group-rules.types.js +3 -0
  39. package/build/cjs/src/social-groups-v2-group-rules.types.js.map +1 -0
  40. package/build/cjs/src/social-groups-v2-group-rules.universal.d.ts +67 -0
  41. package/build/cjs/src/social-groups-v2-group-rules.universal.js +157 -0
  42. package/build/cjs/src/social-groups-v2-group-rules.universal.js.map +1 -0
  43. package/build/cjs/src/social-groups-v2-group.universal.d.ts +13 -3
  44. package/build/cjs/src/social-groups-v2-group.universal.js +62 -24
  45. package/build/cjs/src/social-groups-v2-group.universal.js.map +1 -1
  46. package/build/cjs/src/social-groups-v2-join-group-request.universal.d.ts +4 -0
  47. package/build/cjs/src/social-groups-v2-join-group-request.universal.js +32 -12
  48. package/build/cjs/src/social-groups-v2-join-group-request.universal.js.map +1 -1
  49. package/build/cjs/src/social-groups-v2-membership-question.http.d.ts +13 -0
  50. package/build/cjs/src/social-groups-v2-membership-question.http.js +245 -0
  51. package/build/cjs/src/social-groups-v2-membership-question.http.js.map +1 -0
  52. package/build/cjs/src/social-groups-v2-membership-question.public.d.ts +6 -0
  53. package/build/cjs/src/social-groups-v2-membership-question.public.js +23 -0
  54. package/build/cjs/src/social-groups-v2-membership-question.public.js.map +1 -0
  55. package/build/cjs/src/social-groups-v2-membership-question.types.d.ts +87 -0
  56. package/build/cjs/src/social-groups-v2-membership-question.types.js +3 -0
  57. package/build/cjs/src/social-groups-v2-membership-question.types.js.map +1 -0
  58. package/build/cjs/src/social-groups-v2-membership-question.universal.d.ts +129 -0
  59. package/build/cjs/src/social-groups-v2-membership-question.universal.js +220 -0
  60. package/build/cjs/src/social-groups-v2-membership-question.universal.js.map +1 -0
  61. package/build/es/index.d.ts +4 -0
  62. package/build/es/index.js +4 -0
  63. package/build/es/index.js.map +1 -1
  64. package/build/es/src/social-groups-v2-group-member.universal.d.ts +6 -0
  65. package/build/es/src/social-groups-v2-group-member.universal.js +48 -18
  66. package/build/es/src/social-groups-v2-group-member.universal.js.map +1 -1
  67. package/build/es/src/social-groups-v2-group-request.http.d.ts +24 -0
  68. package/build/es/src/social-groups-v2-group-request.http.js +315 -0
  69. package/build/es/src/social-groups-v2-group-request.http.js.map +1 -0
  70. package/build/es/src/social-groups-v2-group-request.public.d.ts +8 -0
  71. package/build/es/src/social-groups-v2-group-request.public.js +23 -0
  72. package/build/es/src/social-groups-v2-group-request.public.js.map +1 -0
  73. package/build/es/src/social-groups-v2-group-request.types.d.ts +361 -0
  74. package/build/es/src/social-groups-v2-group-request.types.js +56 -0
  75. package/build/es/src/social-groups-v2-group-request.types.js.map +1 -0
  76. package/build/es/src/social-groups-v2-group-request.universal.d.ts +416 -0
  77. package/build/es/src/social-groups-v2-group-request.universal.js +290 -0
  78. package/build/es/src/social-groups-v2-group-request.universal.js.map +1 -0
  79. package/build/es/src/social-groups-v2-group-role.http.d.ts +16 -0
  80. package/build/es/src/social-groups-v2-group-role.http.js +220 -0
  81. package/build/es/src/social-groups-v2-group-role.http.js.map +1 -0
  82. package/build/es/src/social-groups-v2-group-role.public.d.ts +6 -0
  83. package/build/es/src/social-groups-v2-group-role.public.js +13 -0
  84. package/build/es/src/social-groups-v2-group-role.public.js.map +1 -0
  85. package/build/es/src/social-groups-v2-group-role.types.d.ts +108 -0
  86. package/build/es/src/social-groups-v2-group-role.types.js +9 -0
  87. package/build/es/src/social-groups-v2-group-role.types.js.map +1 -0
  88. package/build/es/src/social-groups-v2-group-role.universal.d.ts +158 -0
  89. package/build/es/src/social-groups-v2-group-role.universal.js +157 -0
  90. package/build/es/src/social-groups-v2-group-role.universal.js.map +1 -0
  91. package/build/es/src/social-groups-v2-group-rules.http.d.ts +9 -0
  92. package/build/es/src/social-groups-v2-group-rules.http.js +214 -0
  93. package/build/es/src/social-groups-v2-group-rules.http.js.map +1 -0
  94. package/build/es/src/social-groups-v2-group-rules.public.d.ts +5 -0
  95. package/build/es/src/social-groups-v2-group-rules.public.js +12 -0
  96. package/build/es/src/social-groups-v2-group-rules.public.js.map +1 -0
  97. package/build/es/src/social-groups-v2-group-rules.types.d.ts +40 -0
  98. package/build/es/src/social-groups-v2-group-rules.types.js +2 -0
  99. package/build/es/src/social-groups-v2-group-rules.types.js.map +1 -0
  100. package/build/es/src/social-groups-v2-group-rules.universal.d.ts +67 -0
  101. package/build/es/src/social-groups-v2-group-rules.universal.js +133 -0
  102. package/build/es/src/social-groups-v2-group-rules.universal.js.map +1 -0
  103. package/build/es/src/social-groups-v2-group.universal.d.ts +13 -3
  104. package/build/es/src/social-groups-v2-group.universal.js +62 -24
  105. package/build/es/src/social-groups-v2-group.universal.js.map +1 -1
  106. package/build/es/src/social-groups-v2-join-group-request.universal.d.ts +4 -0
  107. package/build/es/src/social-groups-v2-join-group-request.universal.js +32 -12
  108. package/build/es/src/social-groups-v2-join-group-request.universal.js.map +1 -1
  109. package/build/es/src/social-groups-v2-membership-question.http.d.ts +13 -0
  110. package/build/es/src/social-groups-v2-membership-question.http.js +239 -0
  111. package/build/es/src/social-groups-v2-membership-question.http.js.map +1 -0
  112. package/build/es/src/social-groups-v2-membership-question.public.d.ts +6 -0
  113. package/build/es/src/social-groups-v2-membership-question.public.js +17 -0
  114. package/build/es/src/social-groups-v2-membership-question.public.js.map +1 -0
  115. package/build/es/src/social-groups-v2-membership-question.types.d.ts +87 -0
  116. package/build/es/src/social-groups-v2-membership-question.types.js +2 -0
  117. package/build/es/src/social-groups-v2-membership-question.types.js.map +1 -0
  118. package/build/es/src/social-groups-v2-membership-question.universal.d.ts +129 -0
  119. package/build/es/src/social-groups-v2-membership-question.universal.js +195 -0
  120. package/build/es/src/social-groups-v2-membership-question.universal.js.map +1 -0
  121. package/package.json +2 -2
@@ -0,0 +1,416 @@
1
+ export declare const __debug: {
2
+ verboseLogging: {
3
+ on: () => boolean;
4
+ off: () => boolean;
5
+ };
6
+ };
7
+ /**
8
+ * >**Notes:**
9
+ * > + Site owners may set that members are not permitted to create groups in the Wix Groups application settings.
10
+ * > + In this situation, site members have to submit a Group Request to create a new group.
11
+ * > + Group Requests can be approved or rejected by an admin.
12
+ * > + After a Group Request has been approved, the new group is added to the Group List in the Wix Groups app home page.
13
+ * > + See [Introduction](https://dev.wix.com/api/rest/wix-groups/groups/introduction#wix-groups_groups_introduction_terminology) for more details.
14
+ */
15
+ export interface GroupRequest {
16
+ /**
17
+ * Group request ID
18
+ * @readonly
19
+ */
20
+ _id?: string | null;
21
+ /** Group requested for creation. */
22
+ group?: Group;
23
+ /**
24
+ * Status of group request.
25
+ * - `PENDING` - Pending group request.
26
+ * - `APPROVED` - Approved group request.
27
+ * - `REJECTED` - Rejected group request.
28
+ * - `CANCELED` - Canceled group request.
29
+ */
30
+ status?: RequestStatus;
31
+ /** Group request details. */
32
+ requestDetails?: RequestDetails;
33
+ }
34
+ export interface Group {
35
+ /**
36
+ * Group ID.
37
+ * @readonly
38
+ */
39
+ _id?: string | null;
40
+ /** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */
41
+ slug?: string | null;
42
+ /**
43
+ * __Deprecated.__ Use `privacyStatus` instead.
44
+ * This property will be removed on June 30, 2022.
45
+ */
46
+ privacyLevel?: PrivacyStatus;
47
+ /**
48
+ * Group privacy status.
49
+ * - `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.
50
+ * - `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.
51
+ * - `SECRET` - Only admins and members can see the group. New members can only be added by other members.
52
+ */
53
+ privacyStatus?: PrivacyStatus;
54
+ /**
55
+ * __Deprecated.__ Use `name` instead.
56
+ * This property will be removed on June 30, 2022.
57
+ */
58
+ title?: string | null;
59
+ /** Group name. */
60
+ name?: string | null;
61
+ /** Group description in DraftJS format. */
62
+ description?: string | null;
63
+ /** Group teaser. */
64
+ teaser?: string | null;
65
+ /**
66
+ * __Deprecated.__
67
+ * For `details.logo`, use `coverImage` instead.
68
+ * For `details.membersTitle`, `memberTitle` instead.
69
+ * This property will be removed on June 30, 2022.
70
+ */
71
+ details?: GroupDetails;
72
+ /** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
73
+ memberTitle?: string | null;
74
+ /** Cover image. You cannot upload your own cover image. */
75
+ coverImage?: CoverImage;
76
+ /** Group specific settings. Available to the site owners under `Admin Tools` in the Business Manager. */
77
+ settings?: GroupSettings;
78
+ /**
79
+ * Total count of current group members.
80
+ * @readonly
81
+ */
82
+ membersCount?: number | null;
83
+ /**
84
+ * __Deprecated.__ Use `ownerId` instead.
85
+ * This property will be removed on June 30, 2022.
86
+ * @readonly
87
+ */
88
+ createdBy?: Identity;
89
+ /**
90
+ * Group owner.
91
+ * @readonly
92
+ */
93
+ ownerId?: string | null;
94
+ /**
95
+ * Group creation date and time.
96
+ * @readonly
97
+ */
98
+ _createdDate?: Date;
99
+ /**
100
+ * Date and time of the latest group update.
101
+ * @readonly
102
+ */
103
+ _updatedDate?: Date;
104
+ /**
105
+ * __Deprecated.__ Use `lastActivityDate` instead.
106
+ * This property will be removed on June 30, 2022.
107
+ * @readonly
108
+ */
109
+ recentActivityDate?: Date;
110
+ /**
111
+ * Date and time of the most recent group activity, for example a post or comment.
112
+ * @readonly
113
+ */
114
+ lastActivityDate?: Date;
115
+ }
116
+ export declare enum Type {
117
+ UNKNOWN = "UNKNOWN",
118
+ ADMIN_APPROVAL = "ADMIN_APPROVAL",
119
+ PAID_PLANS = "PAID_PLANS",
120
+ EVENTS = "EVENTS"
121
+ }
122
+ export interface Events {
123
+ eventIds?: string[];
124
+ }
125
+ export interface Logo {
126
+ /** Logo image ID (for internal use). */
127
+ mediaId?: string | null;
128
+ /** Logo image width. */
129
+ width?: number | null;
130
+ /** Logo image height. */
131
+ height?: number | null;
132
+ }
133
+ export interface GroupDetailsPosition {
134
+ /** horizontal coordinate */
135
+ x?: number;
136
+ /** vertical coordinate */
137
+ y?: number;
138
+ }
139
+ export interface Image {
140
+ /** Image ID (for internal use). */
141
+ mediaId?: string | null;
142
+ /** Image width. */
143
+ width?: number | null;
144
+ /** Image height. */
145
+ height?: number | null;
146
+ }
147
+ export interface Position {
148
+ /** horizontal coordinate */
149
+ x?: number;
150
+ /** vertical coordinate */
151
+ y?: number;
152
+ }
153
+ export declare enum PrivacyStatus {
154
+ UNKNOWN = "UNKNOWN",
155
+ /** Anyone can see the group in the group list and view its content. Anyone can join. */
156
+ PUBLIC = "PUBLIC",
157
+ /** 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. */
158
+ PRIVATE = "PRIVATE",
159
+ /** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */
160
+ SECRET = "SECRET"
161
+ }
162
+ export interface AccessRestriction extends AccessRestrictionDataOneOf {
163
+ type?: Type;
164
+ events?: Events;
165
+ }
166
+ /** @oneof */
167
+ export interface AccessRestrictionDataOneOf {
168
+ events?: Events;
169
+ }
170
+ export interface GroupDetails {
171
+ /** Group logo. You cannot upload your own logo. */
172
+ logo?: Logo;
173
+ /** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
174
+ membersTitle?: string | null;
175
+ }
176
+ export interface CoverImage {
177
+ /** Cover image. */
178
+ image?: Image;
179
+ /** Position of the corner of the cover image (or logo). */
180
+ position?: Position;
181
+ /** Position of the corner of the cover image (or logo) for mobile browser. */
182
+ mobilePosition?: Position;
183
+ }
184
+ export interface GroupSettings {
185
+ /**
186
+ * __Deprecated.__ Use `membersCanInvite` instead.
187
+ * This property will be removed on June 30, 2022.
188
+ */
189
+ membersPermittedToInvite?: boolean | null;
190
+ /**
191
+ * Whether regular members are permitted to invite new members.
192
+ * If `false`, only admins can invite members. Defaults to `true`.
193
+ */
194
+ membersCanInvite?: boolean | null;
195
+ /**
196
+ * __Deprecated.__ Use `membersCanApprove` instead.
197
+ * This property will be removed on June 30, 2022.
198
+ */
199
+ membersPermittedToApprove?: boolean | null;
200
+ /**
201
+ * Whether all group members are permitted to approve join group requests.
202
+ * If `false`, member approval is limited to the admins.
203
+ */
204
+ membersCanApprove?: boolean | null;
205
+ /**
206
+ * __Deprecated.__ Use `welcomeMemberPostEnabled` instead.
207
+ * This property will be removed on June 30, 2022.
208
+ */
209
+ memberWelcomePostEnabled?: boolean | null;
210
+ /** Whether a daily post about new members is enabled. */
211
+ welcomeMemberPostEnabled?: boolean | null;
212
+ /** Whether an automatic post about changing the group details is enabled. */
213
+ groupDetailsChangedPostEnabled?: boolean | null;
214
+ /** Whether all members can see the full member list. */
215
+ showMemberList?: boolean | null;
216
+ }
217
+ export interface Identity {
218
+ /** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
219
+ _id?: string | null;
220
+ identityType?: IdentityType;
221
+ }
222
+ export declare enum IdentityType {
223
+ USER = "USER",
224
+ MEMBER = "MEMBER"
225
+ }
226
+ export declare enum RequestStatus {
227
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
228
+ /** Pending request. */
229
+ PENDING = "PENDING",
230
+ /** Approved request. */
231
+ APPROVED = "APPROVED",
232
+ /** Rejected request. */
233
+ REJECTED = "REJECTED",
234
+ /** Cancelled request. */
235
+ CANCELLED = "CANCELLED",
236
+ /** Canceled request. */
237
+ CANCELED = "CANCELED"
238
+ }
239
+ export interface RequestDetails {
240
+ /** Reason the request has been rejected. */
241
+ rejectionReason?: string | null;
242
+ }
243
+ export interface SubmitGroupRequestRequest {
244
+ /** Group submitted for creation. */
245
+ group?: Group;
246
+ }
247
+ export interface SubmitGroupRequestResponse {
248
+ /** Submitted Group Request. */
249
+ groupRequest?: GroupRequest;
250
+ }
251
+ export interface ApproveGroupRequestsRequest {
252
+ /** Group Request IDs to approve. Limited to `100`. */
253
+ groupRequestIds?: string[];
254
+ }
255
+ export declare enum ItemsToUpdate {
256
+ /** Take into account only items which are listed in request. */
257
+ BY_ID = "BY_ID",
258
+ /** Update all items. */
259
+ ALL_ITEMS = "ALL_ITEMS"
260
+ }
261
+ export interface ApproveGroupRequestsResponse {
262
+ /** Approved Group Requests. */
263
+ groupRequest?: GroupRequest[];
264
+ }
265
+ export interface GroupRequestApproved {
266
+ /** Approved group request. */
267
+ groupRequest?: GroupRequest;
268
+ }
269
+ export interface RejectGroupRequestsRequest {
270
+ /** Rejection data. */
271
+ rejections?: Rejection[];
272
+ }
273
+ export interface Rejection {
274
+ /** ID of the Group Request to reject. */
275
+ groupRequestId?: string;
276
+ /** Rejection reason. Free text displayed to the creator of the rejected Group Request. Limited to 1,000 characters. */
277
+ reason?: string | null;
278
+ }
279
+ export interface RejectGroupRequestsResponse {
280
+ /** Rejected Group Requests. */
281
+ groupRequest?: GroupRequest[];
282
+ }
283
+ export interface GroupRequestRejected {
284
+ /** Rejected group request. */
285
+ groupRequest?: GroupRequest;
286
+ }
287
+ export interface CancelGroupRequestRequest {
288
+ /** ID of the Group Request to cancel. */
289
+ groupRequestId?: string;
290
+ }
291
+ export interface CancelGroupRequestResponse {
292
+ /** Canceled Group Request. */
293
+ groupRequest?: GroupRequest;
294
+ }
295
+ export interface ListGroupRequestsRequest {
296
+ /** Number of items to load. Maximum `100`. */
297
+ limit?: number | null;
298
+ /** Number of items to skip in the current sort order. */
299
+ offset?: number | null;
300
+ }
301
+ export declare enum OwnershipFilter {
302
+ /** All items. */
303
+ ALL = "ALL",
304
+ /** Items for current site member. */
305
+ CURRENT_MEMBER = "CURRENT_MEMBER"
306
+ }
307
+ export interface ListGroupRequestsResponse {
308
+ /** Group Requests. */
309
+ groupRequests?: GroupRequest[];
310
+ metadata?: PagingMetadata;
311
+ }
312
+ export interface PagingMetadata {
313
+ /** Number of items returned in the response. */
314
+ count?: number | null;
315
+ /** Offset that was requested. */
316
+ offset?: number | null;
317
+ /** Total number of items that match the query. */
318
+ total?: number | null;
319
+ /** Flag that indicates the server failed to calculate the `total` field. */
320
+ tooManyToCount?: boolean | null;
321
+ }
322
+ export interface QueryGroupRequestsRequest {
323
+ query?: Query;
324
+ }
325
+ export interface Query {
326
+ /**
327
+ * Filter object in the following format:
328
+ * `"filter" : {
329
+ * "fieldName1": "value1",
330
+ * "fieldName2":{"$operator":"value2"}
331
+ * }`
332
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
333
+ */
334
+ filter?: any;
335
+ /**
336
+ * Sort object in the following format:
337
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
338
+ */
339
+ sort?: Sorting[];
340
+ /** Paging options to limit and skip the number of items. */
341
+ paging?: Paging;
342
+ /** 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. */
343
+ fields?: string[];
344
+ /** 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. */
345
+ fieldsets?: string[];
346
+ }
347
+ export interface Sorting {
348
+ /** Name of the field to sort by. */
349
+ fieldName?: string;
350
+ /** Sort order. */
351
+ order?: SortOrder;
352
+ }
353
+ export declare enum SortOrder {
354
+ ASC = "ASC",
355
+ DESC = "DESC"
356
+ }
357
+ export interface Paging {
358
+ /** Number of items to load. */
359
+ limit?: number | null;
360
+ /** Number of items to skip in the current sort order. */
361
+ offset?: number | null;
362
+ }
363
+ export interface QueryGroupRequestsResponse {
364
+ /** Retrieved Group Requests. */
365
+ groupRequests?: GroupRequest[];
366
+ metadata?: PagingMetadata;
367
+ }
368
+ /**
369
+ * Approves Group Requests.
370
+ * Only admins can approve Group Requests.
371
+ * @public
372
+ * @documentationMaturity preview
373
+ */
374
+ export declare function approveGroupRequests(options?: ApproveGroupRequestsOptions): Promise<ApproveGroupRequestsResponse>;
375
+ export interface ApproveGroupRequestsOptions {
376
+ /** Group Request IDs to approve. Limited to `100`. */
377
+ groupRequestIds?: string[];
378
+ }
379
+ /**
380
+ * Rejects Group Requests.
381
+ * Only admins can reject Group Requests.
382
+ * @public
383
+ * @documentationMaturity preview
384
+ */
385
+ export declare function rejectGroupRequests(options?: RejectGroupRequestsOptions): Promise<RejectGroupRequestsResponse>;
386
+ export interface RejectGroupRequestsOptions {
387
+ /** Rejection data. */
388
+ rejections?: Rejection[];
389
+ }
390
+ /**
391
+ * Lists group requests across the site.
392
+ * @public
393
+ * @documentationMaturity preview
394
+ */
395
+ export declare function listGroupRequests(options?: ListGroupRequestsOptions): Promise<ListGroupRequestsResponse>;
396
+ export interface ListGroupRequestsOptions {
397
+ /** Number of items to load. Maximum `100`. */
398
+ limit?: number | null;
399
+ /** Number of items to skip in the current sort order. */
400
+ offset?: number | null;
401
+ }
402
+ /**
403
+ * Retrieves a list of groups requests across the site.
404
+ *
405
+ * Supported fields for filtering:
406
+ * - `status`
407
+ *
408
+ * Supported fields for sorting:
409
+ * - `createdDate`
410
+ * @public
411
+ * @documentationMaturity preview
412
+ */
413
+ export declare function queryGroupRequests(options?: QueryGroupRequestsOptions): Promise<QueryGroupRequestsResponse>;
414
+ export interface QueryGroupRequestsOptions {
415
+ query?: Query;
416
+ }
@@ -0,0 +1,290 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
10
+ import { serializer, transformError } from '@wix/metro-runtime/velo';
11
+ import * as ambassadorWixSocialGroupsV2GroupRequest from './social-groups-v2-group-request.http';
12
+ let __verbose = false;
13
+ function __log(...args) {
14
+ __verbose && console.log(...args);
15
+ }
16
+ function __inspect(obj) {
17
+ return obj;
18
+ }
19
+ export const __debug = {
20
+ verboseLogging: {
21
+ on: () => (__verbose = true),
22
+ off: () => (__verbose = false),
23
+ },
24
+ };
25
+ const _toVeloEntity = '$';
26
+ const _fromVeloEntity = '$';
27
+ export var Type;
28
+ (function (Type) {
29
+ Type["UNKNOWN"] = "UNKNOWN";
30
+ Type["ADMIN_APPROVAL"] = "ADMIN_APPROVAL";
31
+ Type["PAID_PLANS"] = "PAID_PLANS";
32
+ Type["EVENTS"] = "EVENTS";
33
+ })(Type || (Type = {}));
34
+ export var PrivacyStatus;
35
+ (function (PrivacyStatus) {
36
+ PrivacyStatus["UNKNOWN"] = "UNKNOWN";
37
+ /** Anyone can see the group in the group list and view its content. Anyone can join. */
38
+ PrivacyStatus["PUBLIC"] = "PUBLIC";
39
+ /** 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. */
40
+ PrivacyStatus["PRIVATE"] = "PRIVATE";
41
+ /** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */
42
+ PrivacyStatus["SECRET"] = "SECRET";
43
+ })(PrivacyStatus || (PrivacyStatus = {}));
44
+ export var IdentityType;
45
+ (function (IdentityType) {
46
+ IdentityType["USER"] = "USER";
47
+ IdentityType["MEMBER"] = "MEMBER";
48
+ })(IdentityType || (IdentityType = {}));
49
+ export var RequestStatus;
50
+ (function (RequestStatus) {
51
+ RequestStatus["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
52
+ /** Pending request. */
53
+ RequestStatus["PENDING"] = "PENDING";
54
+ /** Approved request. */
55
+ RequestStatus["APPROVED"] = "APPROVED";
56
+ /** Rejected request. */
57
+ RequestStatus["REJECTED"] = "REJECTED";
58
+ /** Cancelled request. */
59
+ RequestStatus["CANCELLED"] = "CANCELLED";
60
+ /** Canceled request. */
61
+ RequestStatus["CANCELED"] = "CANCELED";
62
+ })(RequestStatus || (RequestStatus = {}));
63
+ export var ItemsToUpdate;
64
+ (function (ItemsToUpdate) {
65
+ /** Take into account only items which are listed in request. */
66
+ ItemsToUpdate["BY_ID"] = "BY_ID";
67
+ /** Update all items. */
68
+ ItemsToUpdate["ALL_ITEMS"] = "ALL_ITEMS";
69
+ })(ItemsToUpdate || (ItemsToUpdate = {}));
70
+ export var OwnershipFilter;
71
+ (function (OwnershipFilter) {
72
+ /** All items. */
73
+ OwnershipFilter["ALL"] = "ALL";
74
+ /** Items for current site member. */
75
+ OwnershipFilter["CURRENT_MEMBER"] = "CURRENT_MEMBER";
76
+ })(OwnershipFilter || (OwnershipFilter = {}));
77
+ export var SortOrder;
78
+ (function (SortOrder) {
79
+ SortOrder["ASC"] = "ASC";
80
+ SortOrder["DESC"] = "DESC";
81
+ })(SortOrder || (SortOrder = {}));
82
+ const _approveGroupRequestsRequest = {};
83
+ const _approveGroupRequestsResponse = {};
84
+ const _listGroupRequestsRequest = {};
85
+ const _listGroupRequestsResponse = {};
86
+ const _queryGroupRequestsRequest = {};
87
+ const _queryGroupRequestsResponse = {};
88
+ const _rejectGroupRequestsRequest = {};
89
+ const _rejectGroupRequestsResponse = {};
90
+ /**
91
+ * Approves Group Requests.
92
+ * Only admins can approve Group Requests.
93
+ * @public
94
+ * @documentationMaturity preview
95
+ */
96
+ export function approveGroupRequests(options) {
97
+ var _a, _b, _c;
98
+ return __awaiter(this, arguments, void 0, function* () {
99
+ const requestTransformation = { groupRequestIds: '$[0].groupRequestIds' };
100
+ const responseTransformation = '$';
101
+ // @ts-ignore
102
+ const { httpClient, sideEffects } = arguments[1];
103
+ const { toAmbassadorRequest } = serializer({
104
+ rootSchema: _approveGroupRequestsRequest,
105
+ depSchemas: {},
106
+ fqdnTransformation: {
107
+ paths: [],
108
+ transformation: _fromVeloEntity,
109
+ },
110
+ customTransformation: requestTransformation,
111
+ });
112
+ const { fromJSON } = serializer({
113
+ rootSchema: _approveGroupRequestsResponse,
114
+ depSchemas: {},
115
+ fqdnTransformation: {
116
+ paths: [...['Array#groupRequest']],
117
+ transformation: _toVeloEntity,
118
+ },
119
+ customTransformation: responseTransformation,
120
+ });
121
+ const payload = toAmbassadorRequest([options]);
122
+ const reqOpts = ambassadorWixSocialGroupsV2GroupRequest.approveGroupRequests(payload);
123
+ __log(`"ApproveGroupRequests" sending request with: ${__inspect(reqOpts)}`);
124
+ (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
125
+ try {
126
+ const result = yield httpClient.request(reqOpts);
127
+ (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
128
+ return fromJSON(result.data);
129
+ }
130
+ catch (err) {
131
+ const transformedError = transformError(err, requestTransformation, [
132
+ 'options',
133
+ ]);
134
+ (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
135
+ throw transformedError;
136
+ }
137
+ });
138
+ }
139
+ /**
140
+ * Rejects Group Requests.
141
+ * Only admins can reject Group Requests.
142
+ * @public
143
+ * @documentationMaturity preview
144
+ */
145
+ export function rejectGroupRequests(options) {
146
+ var _a, _b, _c;
147
+ return __awaiter(this, arguments, void 0, function* () {
148
+ const requestTransformation = { rejections: '$[0].rejections' };
149
+ const responseTransformation = '$';
150
+ // @ts-ignore
151
+ const { httpClient, sideEffects } = arguments[1];
152
+ const { toAmbassadorRequest } = serializer({
153
+ rootSchema: _rejectGroupRequestsRequest,
154
+ depSchemas: {},
155
+ fqdnTransformation: {
156
+ paths: [],
157
+ transformation: _fromVeloEntity,
158
+ },
159
+ customTransformation: requestTransformation,
160
+ });
161
+ const { fromJSON } = serializer({
162
+ rootSchema: _rejectGroupRequestsResponse,
163
+ depSchemas: {},
164
+ fqdnTransformation: {
165
+ paths: [...['Array#groupRequest']],
166
+ transformation: _toVeloEntity,
167
+ },
168
+ customTransformation: responseTransformation,
169
+ });
170
+ const payload = toAmbassadorRequest([options]);
171
+ const reqOpts = ambassadorWixSocialGroupsV2GroupRequest.rejectGroupRequests(payload);
172
+ __log(`"RejectGroupRequests" sending request with: ${__inspect(reqOpts)}`);
173
+ (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
174
+ try {
175
+ const result = yield httpClient.request(reqOpts);
176
+ (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
177
+ return fromJSON(result.data);
178
+ }
179
+ catch (err) {
180
+ const transformedError = transformError(err, requestTransformation, [
181
+ 'options',
182
+ ]);
183
+ (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
184
+ throw transformedError;
185
+ }
186
+ });
187
+ }
188
+ /**
189
+ * Lists group requests across the site.
190
+ * @public
191
+ * @documentationMaturity preview
192
+ */
193
+ export function listGroupRequests(options) {
194
+ var _a, _b, _c;
195
+ return __awaiter(this, arguments, void 0, function* () {
196
+ const requestTransformation = { limit: '$[0].limit', offset: '$[0].offset' };
197
+ const responseTransformation = '$';
198
+ // @ts-ignore
199
+ const { httpClient, sideEffects } = arguments[1];
200
+ const { toAmbassadorRequest } = serializer({
201
+ rootSchema: _listGroupRequestsRequest,
202
+ depSchemas: {},
203
+ fqdnTransformation: {
204
+ paths: [],
205
+ transformation: _fromVeloEntity,
206
+ },
207
+ customTransformation: requestTransformation,
208
+ });
209
+ const { fromJSON } = serializer({
210
+ rootSchema: _listGroupRequestsResponse,
211
+ depSchemas: {},
212
+ fqdnTransformation: {
213
+ paths: [...['Array#groupRequests']],
214
+ transformation: _toVeloEntity,
215
+ },
216
+ customTransformation: responseTransformation,
217
+ });
218
+ const payload = toAmbassadorRequest([options]);
219
+ const reqOpts = ambassadorWixSocialGroupsV2GroupRequest.listGroupRequests(payload);
220
+ __log(`"ListGroupRequests" sending request with: ${__inspect(reqOpts)}`);
221
+ (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
222
+ try {
223
+ const result = yield httpClient.request(reqOpts);
224
+ (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
225
+ return fromJSON(result.data);
226
+ }
227
+ catch (err) {
228
+ const transformedError = transformError(err, requestTransformation, [
229
+ 'options',
230
+ ]);
231
+ (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
232
+ throw transformedError;
233
+ }
234
+ });
235
+ }
236
+ /**
237
+ * Retrieves a list of groups requests across the site.
238
+ *
239
+ * Supported fields for filtering:
240
+ * - `status`
241
+ *
242
+ * Supported fields for sorting:
243
+ * - `createdDate`
244
+ * @public
245
+ * @documentationMaturity preview
246
+ */
247
+ export function queryGroupRequests(options) {
248
+ var _a, _b, _c;
249
+ return __awaiter(this, arguments, void 0, function* () {
250
+ const requestTransformation = { query: '$[0].query' };
251
+ const responseTransformation = '$';
252
+ // @ts-ignore
253
+ const { httpClient, sideEffects } = arguments[1];
254
+ const { toAmbassadorRequest } = serializer({
255
+ rootSchema: _queryGroupRequestsRequest,
256
+ depSchemas: {},
257
+ fqdnTransformation: {
258
+ paths: [],
259
+ transformation: _fromVeloEntity,
260
+ },
261
+ customTransformation: requestTransformation,
262
+ });
263
+ const { fromJSON } = serializer({
264
+ rootSchema: _queryGroupRequestsResponse,
265
+ depSchemas: {},
266
+ fqdnTransformation: {
267
+ paths: [...['Array#groupRequests']],
268
+ transformation: _toVeloEntity,
269
+ },
270
+ customTransformation: responseTransformation,
271
+ });
272
+ const payload = toAmbassadorRequest([options]);
273
+ const reqOpts = ambassadorWixSocialGroupsV2GroupRequest.queryGroupRequests(payload);
274
+ __log(`"QueryGroupRequests" sending request with: ${__inspect(reqOpts)}`);
275
+ (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
276
+ try {
277
+ const result = yield httpClient.request(reqOpts);
278
+ (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
279
+ return fromJSON(result.data);
280
+ }
281
+ catch (err) {
282
+ const transformedError = transformError(err, requestTransformation, [
283
+ 'options',
284
+ ]);
285
+ (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
286
+ throw transformedError;
287
+ }
288
+ });
289
+ }
290
+ //# sourceMappingURL=social-groups-v2-group-request.universal.js.map