@wix/groups 1.0.67 → 1.0.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/context.d.ts +8 -7
- package/build/cjs/context.js +9 -8
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +8 -8
- package/build/cjs/index.js +9 -9
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +8 -7
- package/build/cjs/meta.js +9 -8
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +8 -7
- package/build/es/context.js +8 -7
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +8 -8
- package/build/es/index.js +8 -8
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +8 -7
- package/build/es/meta.js +8 -7
- package/build/es/meta.js.map +1 -1
- package/package.json +18 -9
- package/build/cjs/index.typings.d.ts +0 -7
- package/build/cjs/index.typings.js +0 -34
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-member.context.d.ts +0 -8
- package/build/cjs/src/social-groups-v2-group-member.context.js +0 -77
- package/build/cjs/src/social-groups-v2-group-member.context.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-member.http.d.ts +0 -93
- package/build/cjs/src/social-groups-v2-group-member.http.js +0 -305
- package/build/cjs/src/social-groups-v2-group-member.http.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-member.meta.d.ts +0 -30
- package/build/cjs/src/social-groups-v2-group-member.meta.js +0 -142
- package/build/cjs/src/social-groups-v2-group-member.meta.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-member.public.d.ts +0 -14
- package/build/cjs/src/social-groups-v2-group-member.public.js +0 -50
- package/build/cjs/src/social-groups-v2-group-member.public.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-member.types.d.ts +0 -404
- package/build/cjs/src/social-groups-v2-group-member.types.js +0 -31
- package/build/cjs/src/social-groups-v2-group-member.types.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-member.universal.d.ts +0 -604
- package/build/cjs/src/social-groups-v2-group-member.universal.js +0 -511
- package/build/cjs/src/social-groups-v2-group-member.universal.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-request.context.d.ts +0 -6
- package/build/cjs/src/social-groups-v2-group-request.context.js +0 -53
- package/build/cjs/src/social-groups-v2-group-request.context.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-request.http.d.ts +0 -44
- package/build/cjs/src/social-groups-v2-group-request.http.js +0 -293
- package/build/cjs/src/social-groups-v2-group-request.http.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-request.meta.d.ts +0 -16
- package/build/cjs/src/social-groups-v2-group-request.meta.js +0 -104
- package/build/cjs/src/social-groups-v2-group-request.meta.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-request.public.d.ts +0 -12
- package/build/cjs/src/social-groups-v2-group-request.public.js +0 -44
- package/build/cjs/src/social-groups-v2-group-request.public.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-request.types.d.ts +0 -633
- package/build/cjs/src/social-groups-v2-group-request.types.js +0 -73
- package/build/cjs/src/social-groups-v2-group-request.types.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-request.universal.d.ts +0 -717
- package/build/cjs/src/social-groups-v2-group-request.universal.js +0 -368
- package/build/cjs/src/social-groups-v2-group-request.universal.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-role.context.d.ts +0 -4
- package/build/cjs/src/social-groups-v2-group-role.context.js +0 -29
- package/build/cjs/src/social-groups-v2-group-role.context.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-role.http.d.ts +0 -18
- package/build/cjs/src/social-groups-v2-group-role.http.js +0 -141
- package/build/cjs/src/social-groups-v2-group-role.http.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-role.meta.d.ts +0 -18
- package/build/cjs/src/social-groups-v2-group-role.meta.js +0 -66
- package/build/cjs/src/social-groups-v2-group-role.meta.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-role.public.d.ts +0 -10
- package/build/cjs/src/social-groups-v2-group-role.public.js +0 -23
- package/build/cjs/src/social-groups-v2-group-role.public.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-role.types.d.ts +0 -191
- package/build/cjs/src/social-groups-v2-group-role.types.js +0 -12
- package/build/cjs/src/social-groups-v2-group-role.types.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-role.universal.d.ts +0 -252
- package/build/cjs/src/social-groups-v2-group-role.universal.js +0 -199
- package/build/cjs/src/social-groups-v2-group-role.universal.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-rules.context.d.ts +0 -4
- package/build/cjs/src/social-groups-v2-group-rules.context.js +0 -29
- package/build/cjs/src/social-groups-v2-group-rules.context.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-rules.http.d.ts +0 -16
- package/build/cjs/src/social-groups-v2-group-rules.http.js +0 -220
- package/build/cjs/src/social-groups-v2-group-rules.http.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-rules.meta.d.ts +0 -18
- package/build/cjs/src/social-groups-v2-group-rules.meta.js +0 -66
- package/build/cjs/src/social-groups-v2-group-rules.meta.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-rules.public.d.ts +0 -9
- package/build/cjs/src/social-groups-v2-group-rules.public.js +0 -20
- package/build/cjs/src/social-groups-v2-group-rules.public.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-rules.types.d.ts +0 -120
- package/build/cjs/src/social-groups-v2-group-rules.types.js +0 -3
- package/build/cjs/src/social-groups-v2-group-rules.types.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group-rules.universal.d.ts +0 -157
- package/build/cjs/src/social-groups-v2-group-rules.universal.js +0 -158
- package/build/cjs/src/social-groups-v2-group-rules.universal.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group.context.d.ts +0 -9
- package/build/cjs/src/social-groups-v2-group.context.js +0 -89
- package/build/cjs/src/social-groups-v2-group.context.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group.http.d.ts +0 -70
- package/build/cjs/src/social-groups-v2-group.http.js +0 -500
- package/build/cjs/src/social-groups-v2-group.http.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group.meta.d.ts +0 -27
- package/build/cjs/src/social-groups-v2-group.meta.js +0 -161
- package/build/cjs/src/social-groups-v2-group.meta.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group.public.d.ts +0 -81
- package/build/cjs/src/social-groups-v2-group.public.js +0 -63
- package/build/cjs/src/social-groups-v2-group.public.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group.types.d.ts +0 -778
- package/build/cjs/src/social-groups-v2-group.types.js +0 -57
- package/build/cjs/src/social-groups-v2-group.types.js.map +0 -1
- package/build/cjs/src/social-groups-v2-group.universal.d.ts +0 -869
- package/build/cjs/src/social-groups-v2-group.universal.js +0 -547
- package/build/cjs/src/social-groups-v2-group.universal.js.map +0 -1
- package/build/cjs/src/social-groups-v2-join-group-request.context.d.ts +0 -6
- package/build/cjs/src/social-groups-v2-join-group-request.context.js +0 -53
- package/build/cjs/src/social-groups-v2-join-group-request.context.js.map +0 -1
- package/build/cjs/src/social-groups-v2-join-group-request.http.d.ts +0 -66
- package/build/cjs/src/social-groups-v2-join-group-request.http.js +0 -250
- package/build/cjs/src/social-groups-v2-join-group-request.http.js.map +0 -1
- package/build/cjs/src/social-groups-v2-join-group-request.meta.d.ts +0 -24
- package/build/cjs/src/social-groups-v2-join-group-request.meta.js +0 -104
- package/build/cjs/src/social-groups-v2-join-group-request.meta.js.map +0 -1
- package/build/cjs/src/social-groups-v2-join-group-request.public.d.ts +0 -12
- package/build/cjs/src/social-groups-v2-join-group-request.public.js +0 -40
- package/build/cjs/src/social-groups-v2-join-group-request.public.js.map +0 -1
- package/build/cjs/src/social-groups-v2-join-group-request.types.d.ts +0 -411
- package/build/cjs/src/social-groups-v2-join-group-request.types.js +0 -48
- package/build/cjs/src/social-groups-v2-join-group-request.types.js.map +0 -1
- package/build/cjs/src/social-groups-v2-join-group-request.universal.d.ts +0 -541
- package/build/cjs/src/social-groups-v2-join-group-request.universal.js +0 -379
- package/build/cjs/src/social-groups-v2-join-group-request.universal.js.map +0 -1
- package/build/cjs/src/social-groups-v2-membership-question.context.d.ts +0 -5
- package/build/cjs/src/social-groups-v2-membership-question.context.js +0 -41
- package/build/cjs/src/social-groups-v2-membership-question.context.js.map +0 -1
- package/build/cjs/src/social-groups-v2-membership-question.http.d.ts +0 -25
- package/build/cjs/src/social-groups-v2-membership-question.http.js +0 -177
- package/build/cjs/src/social-groups-v2-membership-question.http.js.map +0 -1
- package/build/cjs/src/social-groups-v2-membership-question.meta.d.ts +0 -21
- package/build/cjs/src/social-groups-v2-membership-question.meta.js +0 -85
- package/build/cjs/src/social-groups-v2-membership-question.meta.js.map +0 -1
- package/build/cjs/src/social-groups-v2-membership-question.public.d.ts +0 -9
- package/build/cjs/src/social-groups-v2-membership-question.public.js +0 -24
- package/build/cjs/src/social-groups-v2-membership-question.public.js.map +0 -1
- package/build/cjs/src/social-groups-v2-membership-question.types.d.ts +0 -111
- package/build/cjs/src/social-groups-v2-membership-question.types.js +0 -3
- package/build/cjs/src/social-groups-v2-membership-question.types.js.map +0 -1
- package/build/cjs/src/social-groups-v2-membership-question.universal.d.ts +0 -156
- package/build/cjs/src/social-groups-v2-membership-question.universal.js +0 -229
- package/build/cjs/src/social-groups-v2-membership-question.universal.js.map +0 -1
- package/build/cjs/src/social-groups-v3-join-request.http.d.ts +0 -27
- package/build/cjs/src/social-groups-v3-join-request.http.js +0 -141
- package/build/cjs/src/social-groups-v3-join-request.http.js.map +0 -1
- package/build/cjs/src/social-groups-v3-join-request.public.d.ts +0 -11
- package/build/cjs/src/social-groups-v3-join-request.public.js +0 -35
- package/build/cjs/src/social-groups-v3-join-request.public.js.map +0 -1
- package/build/cjs/src/social-groups-v3-join-request.types.d.ts +0 -188
- package/build/cjs/src/social-groups-v3-join-request.types.js +0 -37
- package/build/cjs/src/social-groups-v3-join-request.types.js.map +0 -1
- package/build/cjs/src/social-groups-v3-join-request.universal.d.ts +0 -256
- package/build/cjs/src/social-groups-v3-join-request.universal.js +0 -327
- package/build/cjs/src/social-groups-v3-join-request.universal.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -7
- package/build/es/index.typings.js +0 -8
- package/build/es/index.typings.js.map +0 -1
- package/build/es/src/social-groups-v2-group-member.context.d.ts +0 -8
- package/build/es/src/social-groups-v2-group-member.context.js +0 -68
- package/build/es/src/social-groups-v2-group-member.context.js.map +0 -1
- package/build/es/src/social-groups-v2-group-member.http.d.ts +0 -93
- package/build/es/src/social-groups-v2-group-member.http.js +0 -296
- package/build/es/src/social-groups-v2-group-member.http.js.map +0 -1
- package/build/es/src/social-groups-v2-group-member.meta.d.ts +0 -30
- package/build/es/src/social-groups-v2-group-member.meta.js +0 -110
- package/build/es/src/social-groups-v2-group-member.meta.js.map +0 -1
- package/build/es/src/social-groups-v2-group-member.public.d.ts +0 -14
- package/build/es/src/social-groups-v2-group-member.public.js +0 -35
- package/build/es/src/social-groups-v2-group-member.public.js.map +0 -1
- package/build/es/src/social-groups-v2-group-member.types.d.ts +0 -404
- package/build/es/src/social-groups-v2-group-member.types.js +0 -28
- package/build/es/src/social-groups-v2-group-member.types.js.map +0 -1
- package/build/es/src/social-groups-v2-group-member.universal.d.ts +0 -604
- package/build/es/src/social-groups-v2-group-member.universal.js +0 -479
- package/build/es/src/social-groups-v2-group-member.universal.js.map +0 -1
- package/build/es/src/social-groups-v2-group-request.context.d.ts +0 -6
- package/build/es/src/social-groups-v2-group-request.context.js +0 -46
- package/build/es/src/social-groups-v2-group-request.context.js.map +0 -1
- package/build/es/src/social-groups-v2-group-request.http.d.ts +0 -44
- package/build/es/src/social-groups-v2-group-request.http.js +0 -286
- package/build/es/src/social-groups-v2-group-request.http.js.map +0 -1
- package/build/es/src/social-groups-v2-group-request.meta.d.ts +0 -16
- package/build/es/src/social-groups-v2-group-request.meta.js +0 -74
- package/build/es/src/social-groups-v2-group-request.meta.js.map +0 -1
- package/build/es/src/social-groups-v2-group-request.public.d.ts +0 -12
- package/build/es/src/social-groups-v2-group-request.public.js +0 -25
- package/build/es/src/social-groups-v2-group-request.public.js.map +0 -1
- package/build/es/src/social-groups-v2-group-request.types.d.ts +0 -633
- package/build/es/src/social-groups-v2-group-request.types.js +0 -70
- package/build/es/src/social-groups-v2-group-request.types.js.map +0 -1
- package/build/es/src/social-groups-v2-group-request.universal.d.ts +0 -717
- package/build/es/src/social-groups-v2-group-request.universal.js +0 -338
- package/build/es/src/social-groups-v2-group-request.universal.js.map +0 -1
- package/build/es/src/social-groups-v2-group-role.context.d.ts +0 -4
- package/build/es/src/social-groups-v2-group-role.context.js +0 -24
- package/build/es/src/social-groups-v2-group-role.context.js.map +0 -1
- package/build/es/src/social-groups-v2-group-role.http.d.ts +0 -18
- package/build/es/src/social-groups-v2-group-role.http.js +0 -136
- package/build/es/src/social-groups-v2-group-role.http.js.map +0 -1
- package/build/es/src/social-groups-v2-group-role.meta.d.ts +0 -18
- package/build/es/src/social-groups-v2-group-role.meta.js +0 -38
- package/build/es/src/social-groups-v2-group-role.meta.js.map +0 -1
- package/build/es/src/social-groups-v2-group-role.public.d.ts +0 -10
- package/build/es/src/social-groups-v2-group-role.public.js +0 -15
- package/build/es/src/social-groups-v2-group-role.public.js.map +0 -1
- package/build/es/src/social-groups-v2-group-role.types.d.ts +0 -191
- package/build/es/src/social-groups-v2-group-role.types.js +0 -9
- package/build/es/src/social-groups-v2-group-role.types.js.map +0 -1
- package/build/es/src/social-groups-v2-group-role.universal.d.ts +0 -252
- package/build/es/src/social-groups-v2-group-role.universal.js +0 -171
- package/build/es/src/social-groups-v2-group-role.universal.js.map +0 -1
- package/build/es/src/social-groups-v2-group-rules.context.d.ts +0 -4
- package/build/es/src/social-groups-v2-group-rules.context.js +0 -24
- package/build/es/src/social-groups-v2-group-rules.context.js.map +0 -1
- package/build/es/src/social-groups-v2-group-rules.http.d.ts +0 -16
- package/build/es/src/social-groups-v2-group-rules.http.js +0 -215
- package/build/es/src/social-groups-v2-group-rules.http.js.map +0 -1
- package/build/es/src/social-groups-v2-group-rules.meta.d.ts +0 -18
- package/build/es/src/social-groups-v2-group-rules.meta.js +0 -38
- package/build/es/src/social-groups-v2-group-rules.meta.js.map +0 -1
- package/build/es/src/social-groups-v2-group-rules.public.d.ts +0 -9
- package/build/es/src/social-groups-v2-group-rules.public.js +0 -14
- package/build/es/src/social-groups-v2-group-rules.public.js.map +0 -1
- package/build/es/src/social-groups-v2-group-rules.types.d.ts +0 -120
- package/build/es/src/social-groups-v2-group-rules.types.js +0 -2
- package/build/es/src/social-groups-v2-group-rules.types.js.map +0 -1
- package/build/es/src/social-groups-v2-group-rules.universal.d.ts +0 -157
- package/build/es/src/social-groups-v2-group-rules.universal.js +0 -130
- package/build/es/src/social-groups-v2-group-rules.universal.js.map +0 -1
- package/build/es/src/social-groups-v2-group.context.d.ts +0 -9
- package/build/es/src/social-groups-v2-group.context.js +0 -79
- package/build/es/src/social-groups-v2-group.context.js.map +0 -1
- package/build/es/src/social-groups-v2-group.http.d.ts +0 -70
- package/build/es/src/social-groups-v2-group.http.js +0 -490
- package/build/es/src/social-groups-v2-group.http.js.map +0 -1
- package/build/es/src/social-groups-v2-group.meta.d.ts +0 -27
- package/build/es/src/social-groups-v2-group.meta.js +0 -128
- package/build/es/src/social-groups-v2-group.meta.js.map +0 -1
- package/build/es/src/social-groups-v2-group.public.d.ts +0 -81
- package/build/es/src/social-groups-v2-group.public.js +0 -40
- package/build/es/src/social-groups-v2-group.public.js.map +0 -1
- package/build/es/src/social-groups-v2-group.types.d.ts +0 -778
- package/build/es/src/social-groups-v2-group.types.js +0 -54
- package/build/es/src/social-groups-v2-group.types.js.map +0 -1
- package/build/es/src/social-groups-v2-group.universal.d.ts +0 -869
- package/build/es/src/social-groups-v2-group.universal.js +0 -514
- package/build/es/src/social-groups-v2-group.universal.js.map +0 -1
- package/build/es/src/social-groups-v2-join-group-request.context.d.ts +0 -6
- package/build/es/src/social-groups-v2-join-group-request.context.js +0 -46
- package/build/es/src/social-groups-v2-join-group-request.context.js.map +0 -1
- package/build/es/src/social-groups-v2-join-group-request.http.d.ts +0 -66
- package/build/es/src/social-groups-v2-join-group-request.http.js +0 -243
- package/build/es/src/social-groups-v2-join-group-request.http.js.map +0 -1
- package/build/es/src/social-groups-v2-join-group-request.meta.d.ts +0 -24
- package/build/es/src/social-groups-v2-join-group-request.meta.js +0 -74
- package/build/es/src/social-groups-v2-join-group-request.meta.js.map +0 -1
- package/build/es/src/social-groups-v2-join-group-request.public.d.ts +0 -12
- package/build/es/src/social-groups-v2-join-group-request.public.js +0 -25
- package/build/es/src/social-groups-v2-join-group-request.public.js.map +0 -1
- package/build/es/src/social-groups-v2-join-group-request.types.d.ts +0 -411
- package/build/es/src/social-groups-v2-join-group-request.types.js +0 -45
- package/build/es/src/social-groups-v2-join-group-request.types.js.map +0 -1
- package/build/es/src/social-groups-v2-join-group-request.universal.d.ts +0 -541
- package/build/es/src/social-groups-v2-join-group-request.universal.js +0 -349
- package/build/es/src/social-groups-v2-join-group-request.universal.js.map +0 -1
- package/build/es/src/social-groups-v2-membership-question.context.d.ts +0 -5
- package/build/es/src/social-groups-v2-membership-question.context.js +0 -35
- package/build/es/src/social-groups-v2-membership-question.context.js.map +0 -1
- package/build/es/src/social-groups-v2-membership-question.http.d.ts +0 -25
- package/build/es/src/social-groups-v2-membership-question.http.js +0 -171
- package/build/es/src/social-groups-v2-membership-question.http.js.map +0 -1
- package/build/es/src/social-groups-v2-membership-question.meta.d.ts +0 -21
- package/build/es/src/social-groups-v2-membership-question.meta.js +0 -56
- package/build/es/src/social-groups-v2-membership-question.meta.js.map +0 -1
- package/build/es/src/social-groups-v2-membership-question.public.d.ts +0 -9
- package/build/es/src/social-groups-v2-membership-question.public.js +0 -18
- package/build/es/src/social-groups-v2-membership-question.public.js.map +0 -1
- package/build/es/src/social-groups-v2-membership-question.types.d.ts +0 -111
- package/build/es/src/social-groups-v2-membership-question.types.js +0 -2
- package/build/es/src/social-groups-v2-membership-question.types.js.map +0 -1
- package/build/es/src/social-groups-v2-membership-question.universal.d.ts +0 -156
- package/build/es/src/social-groups-v2-membership-question.universal.js +0 -200
- package/build/es/src/social-groups-v2-membership-question.universal.js.map +0 -1
- package/build/es/src/social-groups-v3-join-request.http.d.ts +0 -27
- package/build/es/src/social-groups-v3-join-request.http.js +0 -134
- package/build/es/src/social-groups-v3-join-request.http.js.map +0 -1
- package/build/es/src/social-groups-v3-join-request.public.d.ts +0 -11
- package/build/es/src/social-groups-v3-join-request.public.js +0 -24
- package/build/es/src/social-groups-v3-join-request.public.js.map +0 -1
- package/build/es/src/social-groups-v3-join-request.types.d.ts +0 -188
- package/build/es/src/social-groups-v3-join-request.types.js +0 -34
- package/build/es/src/social-groups-v3-join-request.types.js.map +0 -1
- package/build/es/src/social-groups-v3-join-request.universal.d.ts +0 -256
- package/build/es/src/social-groups-v3-join-request.universal.js +0 -297
- package/build/es/src/social-groups-v3-join-request.universal.js.map +0 -1
|
@@ -1,717 +0,0 @@
|
|
|
1
|
-
import { EventDefinition } from '@wix/sdk-types';
|
|
2
|
-
/**
|
|
3
|
-
* >**Notes:**
|
|
4
|
-
* > + Site owners may set that members are not permitted to create groups in the Wix Groups application settings.
|
|
5
|
-
* > + In this situation, site members have to submit a Group Request to create a new group.
|
|
6
|
-
* > + Group Requests can be approved or rejected by an admin.
|
|
7
|
-
* > + After a Group Request has been approved, the new group is added to the Group List in the Wix Groups app home page.
|
|
8
|
-
* > + See [Introduction](https://dev.wix.com/api/rest/wix-groups/groups/introduction#wix-groups_groups_introduction_terminology) for more details.
|
|
9
|
-
*/
|
|
10
|
-
export interface GroupRequest {
|
|
11
|
-
/**
|
|
12
|
-
* ID of the request to create a group. Same as group ID.
|
|
13
|
-
* @readonly
|
|
14
|
-
*/
|
|
15
|
-
_id?: string | null;
|
|
16
|
-
/** Group requested to create. */
|
|
17
|
-
group?: Group;
|
|
18
|
-
/**
|
|
19
|
-
* Status of the request to create a group. One of:
|
|
20
|
-
* - `"PENDING"` - Pending group request.
|
|
21
|
-
* - `"APPROVED"` - Approved group request.
|
|
22
|
-
* - `"REJECTED"` - Rejected group request.
|
|
23
|
-
* - `"CANCELED"` - Canceled group request.
|
|
24
|
-
*/
|
|
25
|
-
status?: RequestStatus;
|
|
26
|
-
/** Details of request to create a group. */
|
|
27
|
-
requestDetails?: RequestDetails;
|
|
28
|
-
}
|
|
29
|
-
export interface Group {
|
|
30
|
-
/**
|
|
31
|
-
* Group ID.
|
|
32
|
-
* @readonly
|
|
33
|
-
*/
|
|
34
|
-
_id?: string | null;
|
|
35
|
-
/**
|
|
36
|
-
* Part of a group's URL.
|
|
37
|
-
*
|
|
38
|
-
* 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.
|
|
39
|
-
*/
|
|
40
|
-
slug?: string | null;
|
|
41
|
-
/**
|
|
42
|
-
* @internal
|
|
43
|
-
* @internal */
|
|
44
|
-
privacyLevel?: PrivacyStatus;
|
|
45
|
-
/**
|
|
46
|
-
* Group privacy status.
|
|
47
|
-
* - `"PUBLIC"` - Site visitors can see the group and its content in the list of groups. Members can join the group.
|
|
48
|
-
* - `"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.
|
|
49
|
-
* - `"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.
|
|
50
|
-
*/
|
|
51
|
-
privacyStatus?: PrivacyStatus;
|
|
52
|
-
/**
|
|
53
|
-
* @interal
|
|
54
|
-
* @interal */
|
|
55
|
-
title?: string | null;
|
|
56
|
-
/** Group name. */
|
|
57
|
-
name?: string | null;
|
|
58
|
-
/** Group Description. */
|
|
59
|
-
description?: string | null;
|
|
60
|
-
/** Group teaser. */
|
|
61
|
-
teaser?: string | null;
|
|
62
|
-
/**
|
|
63
|
-
* @internal
|
|
64
|
-
* @internal */
|
|
65
|
-
details?: GroupDetails;
|
|
66
|
-
/**
|
|
67
|
-
* What group members are called.
|
|
68
|
-
*
|
|
69
|
-
* For example, 'Coworkers', 'Friends', or 'Students'.
|
|
70
|
-
*/
|
|
71
|
-
memberTitle?: string | null;
|
|
72
|
-
/**
|
|
73
|
-
* Group cover image. You cannot upload your own cover image.
|
|
74
|
-
*
|
|
75
|
-
*/
|
|
76
|
-
coverImage?: CoverImage;
|
|
77
|
-
/** Group settings. */
|
|
78
|
-
settings?: GroupSettings;
|
|
79
|
-
/**
|
|
80
|
-
* Total number of members in the group.
|
|
81
|
-
* @readonly
|
|
82
|
-
*/
|
|
83
|
-
membersCount?: number | null;
|
|
84
|
-
/**
|
|
85
|
-
* @internal
|
|
86
|
-
* @internal
|
|
87
|
-
* @readonly
|
|
88
|
-
*/
|
|
89
|
-
createdBy?: Identity;
|
|
90
|
-
/**
|
|
91
|
-
* Member ID of the group creator.
|
|
92
|
-
* @readonly
|
|
93
|
-
*/
|
|
94
|
-
ownerId?: string | null;
|
|
95
|
-
/**
|
|
96
|
-
* Date and time the group was created.
|
|
97
|
-
* @readonly
|
|
98
|
-
*/
|
|
99
|
-
_createdDate?: Date;
|
|
100
|
-
/**
|
|
101
|
-
* Date and time the group was last updated.
|
|
102
|
-
* @readonly
|
|
103
|
-
*/
|
|
104
|
-
_updatedDate?: Date;
|
|
105
|
-
/**
|
|
106
|
-
* @internal
|
|
107
|
-
* @internal
|
|
108
|
-
* @readonly
|
|
109
|
-
*/
|
|
110
|
-
recentActivityDate?: Date;
|
|
111
|
-
/**
|
|
112
|
-
* Date and time the group was last active.
|
|
113
|
-
*
|
|
114
|
-
* For example, a post or comment made in the group.
|
|
115
|
-
* @readonly
|
|
116
|
-
*/
|
|
117
|
-
lastActivityDate?: Date;
|
|
118
|
-
}
|
|
119
|
-
export declare enum Type {
|
|
120
|
-
UNKNOWN = "UNKNOWN",
|
|
121
|
-
ADMIN_APPROVAL = "ADMIN_APPROVAL",
|
|
122
|
-
PAID_PLANS = "PAID_PLANS",
|
|
123
|
-
EVENTS = "EVENTS"
|
|
124
|
-
}
|
|
125
|
-
export interface Events {
|
|
126
|
-
eventIds?: string[];
|
|
127
|
-
}
|
|
128
|
-
export interface Logo {
|
|
129
|
-
/** Logo image ID (for internal use). */
|
|
130
|
-
mediaId?: string | null;
|
|
131
|
-
/** Logo image width. */
|
|
132
|
-
width?: number | null;
|
|
133
|
-
/** Logo image height. */
|
|
134
|
-
height?: number | null;
|
|
135
|
-
}
|
|
136
|
-
export interface GroupDetailsPosition {
|
|
137
|
-
/** horizontal coordinate */
|
|
138
|
-
x?: number;
|
|
139
|
-
/** vertical coordinate */
|
|
140
|
-
y?: number;
|
|
141
|
-
}
|
|
142
|
-
export interface Image {
|
|
143
|
-
/** Image ID (for internal use). */
|
|
144
|
-
mediaId?: string | null;
|
|
145
|
-
/** Image width. */
|
|
146
|
-
width?: number | null;
|
|
147
|
-
/** Image height. */
|
|
148
|
-
height?: number | null;
|
|
149
|
-
}
|
|
150
|
-
export interface Position {
|
|
151
|
-
/** horizontal coordinate */
|
|
152
|
-
x?: number;
|
|
153
|
-
/** vertical coordinate */
|
|
154
|
-
y?: number;
|
|
155
|
-
}
|
|
156
|
-
export declare enum AllowPolicy {
|
|
157
|
-
UNKNOWN = "UNKNOWN",
|
|
158
|
-
OWNER_AND_ADMINS = "OWNER_AND_ADMINS",
|
|
159
|
-
OWNER = "OWNER",
|
|
160
|
-
ALL_MEMBERS = "ALL_MEMBERS"
|
|
161
|
-
}
|
|
162
|
-
export interface OnboardingStepSettings {
|
|
163
|
-
stepKey?: StepKey;
|
|
164
|
-
visible?: boolean;
|
|
165
|
-
}
|
|
166
|
-
export declare enum StepKey {
|
|
167
|
-
UNKNOWN = "UNKNOWN",
|
|
168
|
-
CREATE_POST = "CREATE_POST",
|
|
169
|
-
REACT_TO_POST = "REACT_TO_POST",
|
|
170
|
-
INVITE_MEMBERS = "INVITE_MEMBERS"
|
|
171
|
-
}
|
|
172
|
-
export declare enum PrivacyStatus {
|
|
173
|
-
UNKNOWN = "UNKNOWN",
|
|
174
|
-
/** Anyone can see the group in the group list and view its content. Anyone can join. */
|
|
175
|
-
PUBLIC = "PUBLIC",
|
|
176
|
-
/** 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. */
|
|
177
|
-
PRIVATE = "PRIVATE",
|
|
178
|
-
/** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */
|
|
179
|
-
SECRET = "SECRET"
|
|
180
|
-
}
|
|
181
|
-
export interface AccessRestriction extends AccessRestrictionDataOneOf {
|
|
182
|
-
events?: Events;
|
|
183
|
-
type?: Type;
|
|
184
|
-
}
|
|
185
|
-
/** @oneof */
|
|
186
|
-
export interface AccessRestrictionDataOneOf {
|
|
187
|
-
events?: Events;
|
|
188
|
-
}
|
|
189
|
-
export interface GroupDetails {
|
|
190
|
-
/** Group logo. You cannot upload your own logo. */
|
|
191
|
-
logo?: Logo;
|
|
192
|
-
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
193
|
-
membersTitle?: string | null;
|
|
194
|
-
}
|
|
195
|
-
export interface CoverImage {
|
|
196
|
-
/** Cover image. */
|
|
197
|
-
image?: Image;
|
|
198
|
-
/** Position of the corner of the cover image (or logo). */
|
|
199
|
-
position?: Position;
|
|
200
|
-
/** Position of the corner of the cover image (or logo) for mobile browser. */
|
|
201
|
-
mobilePosition?: Position;
|
|
202
|
-
}
|
|
203
|
-
export interface GroupSettings {
|
|
204
|
-
/**
|
|
205
|
-
* 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.
|
|
206
|
-
*
|
|
207
|
-
* Default: `false`
|
|
208
|
-
*/
|
|
209
|
-
membersCanInvite?: boolean | null;
|
|
210
|
-
/**
|
|
211
|
-
* 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.
|
|
212
|
-
*
|
|
213
|
-
* Default: `false`
|
|
214
|
-
*/
|
|
215
|
-
membersCanApprove?: boolean | null;
|
|
216
|
-
/**
|
|
217
|
-
* @internal
|
|
218
|
-
* @internal */
|
|
219
|
-
memberWelcomePostEnabled?: boolean | null;
|
|
220
|
-
/**
|
|
221
|
-
* Whether to create a daily group post welcoming new members.
|
|
222
|
-
*
|
|
223
|
-
* Default: `true`
|
|
224
|
-
*/
|
|
225
|
-
welcomeMemberPostEnabled?: boolean | null;
|
|
226
|
-
/**
|
|
227
|
-
* Whether to create an automatic group post when group details are changed.
|
|
228
|
-
*
|
|
229
|
-
* Default: `true`
|
|
230
|
-
*/
|
|
231
|
-
groupDetailsChangedPostEnabled?: boolean | null;
|
|
232
|
-
/**
|
|
233
|
-
* Whether all group members can view the full list of group members.
|
|
234
|
-
*
|
|
235
|
-
* Default: `true`
|
|
236
|
-
*/
|
|
237
|
-
showMemberList?: boolean | null;
|
|
238
|
-
onboardingStepsSettings?: OnboardingStepSettings[];
|
|
239
|
-
}
|
|
240
|
-
export interface Identity {
|
|
241
|
-
/** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
|
|
242
|
-
_id?: string | null;
|
|
243
|
-
identityType?: IdentityType;
|
|
244
|
-
}
|
|
245
|
-
export declare enum IdentityType {
|
|
246
|
-
USER = "USER",
|
|
247
|
-
MEMBER = "MEMBER"
|
|
248
|
-
}
|
|
249
|
-
export declare enum RequestStatus {
|
|
250
|
-
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
251
|
-
/** Pending request. */
|
|
252
|
-
PENDING = "PENDING",
|
|
253
|
-
/** Approved request. */
|
|
254
|
-
APPROVED = "APPROVED",
|
|
255
|
-
/** Rejected request. */
|
|
256
|
-
REJECTED = "REJECTED",
|
|
257
|
-
/** Cancelled request. */
|
|
258
|
-
CANCELLED = "CANCELLED",
|
|
259
|
-
/** Canceled request. */
|
|
260
|
-
CANCELED = "CANCELED"
|
|
261
|
-
}
|
|
262
|
-
export interface RequestDetails {
|
|
263
|
-
/** Reason the request to create a group is rejected. */
|
|
264
|
-
rejectionReason?: string | null;
|
|
265
|
-
}
|
|
266
|
-
export interface SubmitGroupRequestRequest {
|
|
267
|
-
/** Group submitted for creation. */
|
|
268
|
-
group?: Group;
|
|
269
|
-
}
|
|
270
|
-
export interface SubmitGroupRequestResponse {
|
|
271
|
-
/** Submitted Group Request. */
|
|
272
|
-
groupRequest?: GroupRequest;
|
|
273
|
-
}
|
|
274
|
-
export interface ApproveGroupRequestsRequest {
|
|
275
|
-
/**
|
|
276
|
-
* IDs of the requests create groups to approve.
|
|
277
|
-
*
|
|
278
|
-
* Max: 100 create group request IDs
|
|
279
|
-
*/
|
|
280
|
-
groupRequestIds?: string[];
|
|
281
|
-
}
|
|
282
|
-
export declare enum ItemsToUpdate {
|
|
283
|
-
/** Take into account only items which are listed in request. */
|
|
284
|
-
BY_ID = "BY_ID",
|
|
285
|
-
/** Update all items. */
|
|
286
|
-
ALL_ITEMS = "ALL_ITEMS"
|
|
287
|
-
}
|
|
288
|
-
export interface ApproveGroupRequestsResponse {
|
|
289
|
-
/** Approved request to create a group. */
|
|
290
|
-
groupRequest?: GroupRequest[];
|
|
291
|
-
}
|
|
292
|
-
export interface GroupRequestApproved {
|
|
293
|
-
/** Approved group request. */
|
|
294
|
-
groupRequest?: GroupRequest;
|
|
295
|
-
}
|
|
296
|
-
export interface RejectGroupRequestsRequest {
|
|
297
|
-
/** Rejection data. */
|
|
298
|
-
rejections?: Rejection[];
|
|
299
|
-
}
|
|
300
|
-
export interface Rejection {
|
|
301
|
-
/**
|
|
302
|
-
* ID of the requests to create groups to reject.
|
|
303
|
-
*
|
|
304
|
-
*/
|
|
305
|
-
groupRequestId?: string;
|
|
306
|
-
/**
|
|
307
|
-
* Reason the request to create a group is rejected. This text is displayed to the creator of the rejected request.
|
|
308
|
-
*
|
|
309
|
-
* Max: 1,000 characters.
|
|
310
|
-
*/
|
|
311
|
-
reason?: string | null;
|
|
312
|
-
}
|
|
313
|
-
export interface RejectGroupRequestsResponse {
|
|
314
|
-
/** Rejected Group Requests. */
|
|
315
|
-
groupRequest?: GroupRequest[];
|
|
316
|
-
}
|
|
317
|
-
export interface GroupRequestRejected {
|
|
318
|
-
/** Rejected group request. */
|
|
319
|
-
groupRequest?: GroupRequest;
|
|
320
|
-
}
|
|
321
|
-
export interface CancelGroupRequestRequest {
|
|
322
|
-
/** ID of the Group Request to cancel. */
|
|
323
|
-
groupRequestId?: string;
|
|
324
|
-
}
|
|
325
|
-
export interface CancelGroupRequestResponse {
|
|
326
|
-
/** Canceled Group Request. */
|
|
327
|
-
groupRequest?: GroupRequest;
|
|
328
|
-
}
|
|
329
|
-
export interface ListGroupRequestsRequest {
|
|
330
|
-
/** Number of items to load. Maximum `100`. */
|
|
331
|
-
limit?: number | null;
|
|
332
|
-
/** Number of items to skip in the current sort order. */
|
|
333
|
-
offset?: number | null;
|
|
334
|
-
}
|
|
335
|
-
export declare enum OwnershipFilter {
|
|
336
|
-
/** All items. */
|
|
337
|
-
ALL = "ALL",
|
|
338
|
-
/** Items for current site member. */
|
|
339
|
-
CURRENT_MEMBER = "CURRENT_MEMBER"
|
|
340
|
-
}
|
|
341
|
-
export interface ListGroupRequestsResponse {
|
|
342
|
-
/** List of requests to create a group. */
|
|
343
|
-
groupRequests?: GroupRequest[];
|
|
344
|
-
/** Paging information. */
|
|
345
|
-
metadata?: PagingMetadata;
|
|
346
|
-
}
|
|
347
|
-
export interface PagingMetadata {
|
|
348
|
-
/** Number of items returned in the response. */
|
|
349
|
-
count?: number | null;
|
|
350
|
-
/** Offset that was requested. */
|
|
351
|
-
offset?: number | null;
|
|
352
|
-
/** Total number of items that match the query. */
|
|
353
|
-
total?: number | null;
|
|
354
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
355
|
-
tooManyToCount?: boolean | null;
|
|
356
|
-
}
|
|
357
|
-
export interface QueryGroupRequestsRequest {
|
|
358
|
-
query?: Query;
|
|
359
|
-
}
|
|
360
|
-
export interface Query {
|
|
361
|
-
/**
|
|
362
|
-
* Filter object in the following format:
|
|
363
|
-
* `"filter" : {
|
|
364
|
-
* "fieldName1": "value1",
|
|
365
|
-
* "fieldName2":{"$operator":"value2"}
|
|
366
|
-
* }`
|
|
367
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
368
|
-
*/
|
|
369
|
-
filter?: any;
|
|
370
|
-
/**
|
|
371
|
-
* Sort object in the following format:
|
|
372
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
373
|
-
*/
|
|
374
|
-
sort?: Sorting[];
|
|
375
|
-
/** Paging options to limit and skip the number of items. */
|
|
376
|
-
paging?: Paging;
|
|
377
|
-
/** 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. */
|
|
378
|
-
fields?: string[];
|
|
379
|
-
/** 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. */
|
|
380
|
-
fieldsets?: string[];
|
|
381
|
-
}
|
|
382
|
-
export interface Sorting {
|
|
383
|
-
/** Name of the field to sort by. */
|
|
384
|
-
fieldName?: string;
|
|
385
|
-
/** Sort order. */
|
|
386
|
-
order?: SortOrder;
|
|
387
|
-
}
|
|
388
|
-
export declare enum SortOrder {
|
|
389
|
-
ASC = "ASC",
|
|
390
|
-
DESC = "DESC"
|
|
391
|
-
}
|
|
392
|
-
export interface Paging {
|
|
393
|
-
/**
|
|
394
|
-
* Number of items to load.
|
|
395
|
-
*
|
|
396
|
-
* Max: `100`
|
|
397
|
-
*/
|
|
398
|
-
limit?: number | null;
|
|
399
|
-
/**
|
|
400
|
-
* Number of items to skip in the current sort order.
|
|
401
|
-
*
|
|
402
|
-
*/
|
|
403
|
-
offset?: number | null;
|
|
404
|
-
}
|
|
405
|
-
export interface QueryGroupRequestsResponse {
|
|
406
|
-
/** Retrieved Group Requests. */
|
|
407
|
-
groupRequests?: GroupRequest[];
|
|
408
|
-
metadata?: PagingMetadata;
|
|
409
|
-
}
|
|
410
|
-
export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
|
|
411
|
-
createdEvent?: EntityCreatedEvent<T>;
|
|
412
|
-
updatedEvent?: EntityUpdatedEvent<T>;
|
|
413
|
-
deletedEvent?: EntityDeletedEvent<T>;
|
|
414
|
-
actionEvent?: ActionEvent<T>;
|
|
415
|
-
/**
|
|
416
|
-
* Unique event ID.
|
|
417
|
-
* Allows clients to ignore duplicate webhooks.
|
|
418
|
-
*/
|
|
419
|
-
_id?: string;
|
|
420
|
-
/**
|
|
421
|
-
* Assumes actions are also always typed to an entity_type
|
|
422
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
423
|
-
*/
|
|
424
|
-
entityFqdn?: string;
|
|
425
|
-
/**
|
|
426
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
427
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
428
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
429
|
-
*/
|
|
430
|
-
slug?: string;
|
|
431
|
-
/** ID of the entity associated with the event. */
|
|
432
|
-
entityId?: string;
|
|
433
|
-
/** Event timestamp. */
|
|
434
|
-
eventTime?: Date;
|
|
435
|
-
/**
|
|
436
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
437
|
-
* (for example, GDPR).
|
|
438
|
-
*/
|
|
439
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
440
|
-
/** If present, indicates the action that triggered the event. */
|
|
441
|
-
originatedFrom?: string | null;
|
|
442
|
-
/**
|
|
443
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
444
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
445
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
446
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
447
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
448
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
449
|
-
*/
|
|
450
|
-
entityEventSequence?: string | null;
|
|
451
|
-
}
|
|
452
|
-
export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
|
|
453
|
-
}
|
|
454
|
-
export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
|
|
455
|
-
}
|
|
456
|
-
export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
|
|
457
|
-
}
|
|
458
|
-
export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
|
|
459
|
-
}
|
|
460
|
-
/** @oneof */
|
|
461
|
-
export interface DomainEventBodyOneOf<T> {
|
|
462
|
-
createdEvent?: EntityCreatedEvent<T>;
|
|
463
|
-
updatedEvent?: EntityUpdatedEvent<T>;
|
|
464
|
-
deletedEvent?: EntityDeletedEvent<T>;
|
|
465
|
-
actionEvent?: ActionEvent<T>;
|
|
466
|
-
}
|
|
467
|
-
export interface EntityCreatedEvent<T> {
|
|
468
|
-
entity?: T;
|
|
469
|
-
}
|
|
470
|
-
export interface EntityUpdatedEvent<T> {
|
|
471
|
-
/**
|
|
472
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
473
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
474
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
475
|
-
*/
|
|
476
|
-
currentEntity?: T;
|
|
477
|
-
}
|
|
478
|
-
export interface EntityDeletedEvent<T> {
|
|
479
|
-
/** Entity that was deleted */
|
|
480
|
-
deletedEntity?: T | null;
|
|
481
|
-
}
|
|
482
|
-
export interface ActionEvent<T> {
|
|
483
|
-
body?: T;
|
|
484
|
-
}
|
|
485
|
-
export interface ApproveGroupRequestsResponseNonNullableFields {
|
|
486
|
-
groupRequest: {
|
|
487
|
-
group?: {
|
|
488
|
-
privacyLevel: PrivacyStatus;
|
|
489
|
-
privacyStatus: PrivacyStatus;
|
|
490
|
-
coverImage?: {
|
|
491
|
-
position?: {
|
|
492
|
-
x: number;
|
|
493
|
-
y: number;
|
|
494
|
-
};
|
|
495
|
-
mobilePosition?: {
|
|
496
|
-
x: number;
|
|
497
|
-
y: number;
|
|
498
|
-
};
|
|
499
|
-
};
|
|
500
|
-
settings?: {
|
|
501
|
-
onboardingStepsSettings: {
|
|
502
|
-
stepKey: StepKey;
|
|
503
|
-
visible: boolean;
|
|
504
|
-
}[];
|
|
505
|
-
};
|
|
506
|
-
createdBy?: {
|
|
507
|
-
identityType: IdentityType;
|
|
508
|
-
};
|
|
509
|
-
};
|
|
510
|
-
status: RequestStatus;
|
|
511
|
-
}[];
|
|
512
|
-
}
|
|
513
|
-
export interface RejectGroupRequestsResponseNonNullableFields {
|
|
514
|
-
groupRequest: {
|
|
515
|
-
group?: {
|
|
516
|
-
privacyLevel: PrivacyStatus;
|
|
517
|
-
privacyStatus: PrivacyStatus;
|
|
518
|
-
coverImage?: {
|
|
519
|
-
position?: {
|
|
520
|
-
x: number;
|
|
521
|
-
y: number;
|
|
522
|
-
};
|
|
523
|
-
mobilePosition?: {
|
|
524
|
-
x: number;
|
|
525
|
-
y: number;
|
|
526
|
-
};
|
|
527
|
-
};
|
|
528
|
-
settings?: {
|
|
529
|
-
onboardingStepsSettings: {
|
|
530
|
-
stepKey: StepKey;
|
|
531
|
-
visible: boolean;
|
|
532
|
-
}[];
|
|
533
|
-
};
|
|
534
|
-
createdBy?: {
|
|
535
|
-
identityType: IdentityType;
|
|
536
|
-
};
|
|
537
|
-
};
|
|
538
|
-
status: RequestStatus;
|
|
539
|
-
}[];
|
|
540
|
-
}
|
|
541
|
-
export interface ListGroupRequestsResponseNonNullableFields {
|
|
542
|
-
groupRequests: {
|
|
543
|
-
group?: {
|
|
544
|
-
privacyLevel: PrivacyStatus;
|
|
545
|
-
privacyStatus: PrivacyStatus;
|
|
546
|
-
coverImage?: {
|
|
547
|
-
position?: {
|
|
548
|
-
x: number;
|
|
549
|
-
y: number;
|
|
550
|
-
};
|
|
551
|
-
mobilePosition?: {
|
|
552
|
-
x: number;
|
|
553
|
-
y: number;
|
|
554
|
-
};
|
|
555
|
-
};
|
|
556
|
-
settings?: {
|
|
557
|
-
onboardingStepsSettings: {
|
|
558
|
-
stepKey: StepKey;
|
|
559
|
-
visible: boolean;
|
|
560
|
-
}[];
|
|
561
|
-
};
|
|
562
|
-
createdBy?: {
|
|
563
|
-
identityType: IdentityType;
|
|
564
|
-
};
|
|
565
|
-
};
|
|
566
|
-
status: RequestStatus;
|
|
567
|
-
}[];
|
|
568
|
-
}
|
|
569
|
-
export interface QueryGroupRequestsResponseNonNullableFields {
|
|
570
|
-
groupRequests: {
|
|
571
|
-
group?: {
|
|
572
|
-
privacyLevel: PrivacyStatus;
|
|
573
|
-
privacyStatus: PrivacyStatus;
|
|
574
|
-
coverImage?: {
|
|
575
|
-
position?: {
|
|
576
|
-
x: number;
|
|
577
|
-
y: number;
|
|
578
|
-
};
|
|
579
|
-
mobilePosition?: {
|
|
580
|
-
x: number;
|
|
581
|
-
y: number;
|
|
582
|
-
};
|
|
583
|
-
};
|
|
584
|
-
settings?: {
|
|
585
|
-
onboardingStepsSettings: {
|
|
586
|
-
stepKey: StepKey;
|
|
587
|
-
visible: boolean;
|
|
588
|
-
}[];
|
|
589
|
-
};
|
|
590
|
-
createdBy?: {
|
|
591
|
-
identityType: IdentityType;
|
|
592
|
-
};
|
|
593
|
-
};
|
|
594
|
-
status: RequestStatus;
|
|
595
|
-
}[];
|
|
596
|
-
}
|
|
597
|
-
export declare const onGroupRequestCreated: EventDefinition<DomainCreatedEvent<GroupRequest>, "wix.social_groups.v2.group_request_created">;
|
|
598
|
-
export declare const onGroupRequestApproved: EventDefinition<DomainActionEvent<GroupRequestApproved>, "wix.social_groups.v2.group_request_approved">;
|
|
599
|
-
export declare const onGroupRequestRejected: EventDefinition<DomainActionEvent<GroupRequestRejected>, "wix.social_groups.v2.group_request_rejected">;
|
|
600
|
-
/**
|
|
601
|
-
* Approves requests to create a group.
|
|
602
|
-
*
|
|
603
|
-
* The `approveGroupRequests()` function returns a Promise that resolves when a site member's request to create a group is approved. Only site admins can approve requests to create a group. When the request is approved, the new group is added to the Groups List page of your site.
|
|
604
|
-
*
|
|
605
|
-
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
606
|
-
* @param groupRequestIds - IDs of the requests create groups to approve.
|
|
607
|
-
*
|
|
608
|
-
* Max: 100 create group request IDs
|
|
609
|
-
* @public
|
|
610
|
-
* @documentationMaturity preview
|
|
611
|
-
* @requiredField groupRequestIds
|
|
612
|
-
*/
|
|
613
|
-
export declare function approveGroupRequests(groupRequestIds: string[]): Promise<ApproveGroupRequestsResponse & ApproveGroupRequestsResponseNonNullableFields>;
|
|
614
|
-
/**
|
|
615
|
-
* Rejects a request to create a group.
|
|
616
|
-
*
|
|
617
|
-
* The `rejectGroupRequests()` function returns a Promise that resolves when a member's request to create a group is rejected. Only site admins can reject requests to create a group.
|
|
618
|
-
*
|
|
619
|
-
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
620
|
-
* @param rejections - Rejection data.
|
|
621
|
-
* @public
|
|
622
|
-
* @documentationMaturity preview
|
|
623
|
-
* @requiredField rejections
|
|
624
|
-
*/
|
|
625
|
-
export declare function rejectGroupRequests(rejections: Rejection[]): Promise<RejectGroupRequestsResponse & RejectGroupRequestsResponseNonNullableFields>;
|
|
626
|
-
/**
|
|
627
|
-
* Lists requests to create a group.
|
|
628
|
-
*
|
|
629
|
-
* The `listGroupRequests()` function returns a Promise that resolves to a list of up to 1,000 create group requests on your site.
|
|
630
|
-
*
|
|
631
|
-
* Using the options parameter, you can filter your list of posts, set the amount of posts to be returned, and sort your list in a specified order.
|
|
632
|
-
*
|
|
633
|
-
* By default, the list is sorted by `_createdDate` in descending order. Only admins can see create group requests. Members can access their own create group requests in their site.
|
|
634
|
-
*
|
|
635
|
-
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
636
|
-
*
|
|
637
|
-
* @public
|
|
638
|
-
* @documentationMaturity preview
|
|
639
|
-
* @param options - Paging options.
|
|
640
|
-
*/
|
|
641
|
-
export declare function listGroupRequests(options?: ListGroupRequestsOptions): Promise<ListGroupRequestsResponse & ListGroupRequestsResponseNonNullableFields>;
|
|
642
|
-
export interface ListGroupRequestsOptions {
|
|
643
|
-
/**
|
|
644
|
-
* Number of items to load.
|
|
645
|
-
*
|
|
646
|
-
* Max: `100`
|
|
647
|
-
*
|
|
648
|
-
*/
|
|
649
|
-
limit?: number | null;
|
|
650
|
-
/** Number of items to skip in the current sort order. */
|
|
651
|
-
offset?: number | null;
|
|
652
|
-
}
|
|
653
|
-
/**
|
|
654
|
-
* Creates a query to retrieve a list of create requests.
|
|
655
|
-
*
|
|
656
|
-
* The `queryGroupRequests()` function builds a query to retrieve a list of all requests to create a group, and returns a [`GroupRequestsQueryBuilder`](#grouprequestsquerybuilder) object.
|
|
657
|
-
*
|
|
658
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#grouprequestsquerybuilder/find) function. You can refine the query by chaining `GroupRequestQueryBuilder` functions onto the query. `GroupRequestQueryBuilder` functions enable you to sort, filter, and control the results that `queryGroupRequests()` returns.
|
|
659
|
-
*
|
|
660
|
-
* `queryGorupRequests()` runs with these `GroupRequestsQueryBuilder` defaults, which you can override:
|
|
661
|
-
* - [`limit(1000)`](#grouprequestsquerybuilder/limit)
|
|
662
|
-
* - [`descending('_createdDate')`](#grouprequestsquerybuilder/descending)
|
|
663
|
-
*
|
|
664
|
-
* The following `GroupRequestsQueryBuilder` functions are supported for `queryGroupRequests()`. For a full description of the `GroupRequests` object, see the object returned for the [`items`](#grouprequestsqueryresult/items) property in [`GroupRequestsQueryResult`](#grouprequestsqueryresult).
|
|
665
|
-
* @public
|
|
666
|
-
* @documentationMaturity preview
|
|
667
|
-
*/
|
|
668
|
-
export declare function queryGroupRequests(options?: QueryGroupRequestsOptions): GroupRequestsQueryBuilder;
|
|
669
|
-
export interface QueryGroupRequestsOptions {
|
|
670
|
-
}
|
|
671
|
-
interface QueryOffsetResult {
|
|
672
|
-
currentPage: number | undefined;
|
|
673
|
-
totalPages: number | undefined;
|
|
674
|
-
totalCount: number | undefined;
|
|
675
|
-
hasNext: () => boolean;
|
|
676
|
-
hasPrev: () => boolean;
|
|
677
|
-
length: number;
|
|
678
|
-
pageSize: number;
|
|
679
|
-
}
|
|
680
|
-
export interface GroupRequestsQueryResult extends QueryOffsetResult {
|
|
681
|
-
items: GroupRequest[];
|
|
682
|
-
query: GroupRequestsQueryBuilder;
|
|
683
|
-
next: () => Promise<GroupRequestsQueryResult>;
|
|
684
|
-
prev: () => Promise<GroupRequestsQueryResult>;
|
|
685
|
-
}
|
|
686
|
-
export interface GroupRequestsQueryBuilder {
|
|
687
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
688
|
-
* @param value - Value to compare against.
|
|
689
|
-
* @documentationMaturity preview
|
|
690
|
-
*/
|
|
691
|
-
eq: (propertyName: 'status', value: any) => GroupRequestsQueryBuilder;
|
|
692
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
693
|
-
* @param value - Value to compare against.
|
|
694
|
-
* @documentationMaturity preview
|
|
695
|
-
*/
|
|
696
|
-
ne: (propertyName: 'status', value: any) => GroupRequestsQueryBuilder;
|
|
697
|
-
/** @param propertyName - Property whose value is compared with `values`.
|
|
698
|
-
* @param values - List of values to compare against.
|
|
699
|
-
* @documentationMaturity preview
|
|
700
|
-
*/
|
|
701
|
-
hasSome: (propertyName: 'status', value: any[]) => GroupRequestsQueryBuilder;
|
|
702
|
-
/** @documentationMaturity preview */
|
|
703
|
-
in: (propertyName: 'status', value: any) => GroupRequestsQueryBuilder;
|
|
704
|
-
/** @documentationMaturity preview */
|
|
705
|
-
exists: (propertyName: 'status', value: boolean) => GroupRequestsQueryBuilder;
|
|
706
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
707
|
-
* @documentationMaturity preview
|
|
708
|
-
*/
|
|
709
|
-
limit: (limit: number) => GroupRequestsQueryBuilder;
|
|
710
|
-
/** @param skip - Number of items to skip in the query results before returning the results.
|
|
711
|
-
* @documentationMaturity preview
|
|
712
|
-
*/
|
|
713
|
-
skip: (skip: number) => GroupRequestsQueryBuilder;
|
|
714
|
-
/** @documentationMaturity preview */
|
|
715
|
-
find: () => Promise<GroupRequestsQueryResult>;
|
|
716
|
-
}
|
|
717
|
-
export {};
|