@wix/groups 1.0.16 → 1.0.17
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/src/social-groups-v2-group-member.http.d.ts +15 -15
- package/build/cjs/src/social-groups-v2-group-member.http.js +15 -15
- package/build/cjs/src/social-groups-v2-group-member.universal.d.ts +19 -39
- package/build/cjs/src/social-groups-v2-group-member.universal.js +15 -21
- package/build/cjs/src/social-groups-v2-group-member.universal.js.map +1 -1
- package/build/cjs/src/social-groups-v2-join-group-request.http.d.ts +11 -9
- package/build/cjs/src/social-groups-v2-join-group-request.http.js +11 -9
- package/build/cjs/src/social-groups-v2-join-group-request.http.js.map +1 -1
- package/build/cjs/src/social-groups-v2-join-group-request.universal.d.ts +15 -31
- package/build/cjs/src/social-groups-v2-join-group-request.universal.js +11 -13
- package/build/cjs/src/social-groups-v2-join-group-request.universal.js.map +1 -1
- package/build/es/src/social-groups-v2-group-member.http.d.ts +15 -15
- package/build/es/src/social-groups-v2-group-member.http.js +15 -15
- package/build/es/src/social-groups-v2-group-member.universal.d.ts +19 -39
- package/build/es/src/social-groups-v2-group-member.universal.js +15 -21
- package/build/es/src/social-groups-v2-group-member.universal.js.map +1 -1
- package/build/es/src/social-groups-v2-join-group-request.http.d.ts +11 -9
- package/build/es/src/social-groups-v2-join-group-request.http.js +11 -9
- package/build/es/src/social-groups-v2-join-group-request.http.js.map +1 -1
- package/build/es/src/social-groups-v2-join-group-request.universal.d.ts +15 -31
- package/build/es/src/social-groups-v2-join-group-request.universal.js +11 -13
- package/build/es/src/social-groups-v2-join-group-request.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"social-groups-v2-join-group-request.http.js","sourceRoot":"","sources":["../../../src/social-groups-v2-join-group-request.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAchD,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG;IACxC,iBAAiB,EAAE,mBAAmB;CACvC,CAAC;AACF,MAAM,iBAAiB,GAAG,EAAE,WAAW,EAAE,2BAA2B,EAAE,CAAC;AACvE,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG;IACrC,iBAAiB,EAAE,mBAAmB;CACvC,CAAC;AACF,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAC1C,MAAM,+BAA+B,GAAG;IACtC,iBAAiB,EAAE,mBAAmB;CACvC,CAAC;AACF,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAC3C,MAAM,gCAAgC,GAAG;IACvC,iBAAiB,EAAE,mBAAmB;CACvC,CAAC;AAEF,SAAS,sDAAsD,CAC7D,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,yBAAyB,EAAE;YACzB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,wBAAwB,CACtC,OAAwC;IAExC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,gCAAgC,EAChC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,iCAAiC,EAAE;QAC1E,iBAAiB;KAClB,CAAC,CAAC;IAEH,SAAS,0BAA0B,CAAC,EAAE,IAAI,EAAO;QAC/C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,4EAA4E;YAC9E,GAAG,EAAE,sDAAsD,CAAC;gBAC1D,SAAS,EAAE,4CAA4C;gBACvD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,0BAA0B,CAAC,OAAO,GAAG,OAAO,CAAC;IAE7C,OAAO,0BAA0B,CAAC;AACpC,CAAC;AAjCD,4DAiCC;AAED
|
|
1
|
+
{"version":3,"file":"social-groups-v2-join-group-request.http.js","sourceRoot":"","sources":["../../../src/social-groups-v2-join-group-request.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAchD,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG;IACxC,iBAAiB,EAAE,mBAAmB;CACvC,CAAC;AACF,MAAM,iBAAiB,GAAG,EAAE,WAAW,EAAE,2BAA2B,EAAE,CAAC;AACvE,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG;IACrC,iBAAiB,EAAE,mBAAmB;CACvC,CAAC;AACF,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAC1C,MAAM,+BAA+B,GAAG;IACtC,iBAAiB,EAAE,mBAAmB;CACvC,CAAC;AACF,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAC3C,MAAM,gCAAgC,GAAG;IACvC,iBAAiB,EAAE,mBAAmB;CACvC,CAAC;AAEF,SAAS,sDAAsD,CAC7D,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,yBAAyB,EAAE;YACzB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,wBAAwB,CACtC,OAAwC;IAExC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,gCAAgC,EAChC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,iCAAiC,EAAE;QAC1E,iBAAiB;KAClB,CAAC,CAAC;IAEH,SAAS,0BAA0B,CAAC,EAAE,IAAI,EAAO;QAC/C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,4EAA4E;YAC9E,GAAG,EAAE,sDAAsD,CAAC;gBAC1D,SAAS,EAAE,4CAA4C;gBACvD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,0BAA0B,CAAC,OAAO,GAAG,OAAO,CAAC;IAE7C,OAAO,0BAA0B,CAAC;AACpC,CAAC;AAjCD,4DAiCC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,uBAAuB,CACrC,OAAuC;IAEvC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,+BAA+B,EAC/B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,gCAAgC,EAAE;QACzE,iBAAiB;KAClB,CAAC,CAAC;IAEH,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,2EAA2E;YAC7E,GAAG,EAAE,sDAAsD,CAAC;gBAC1D,SAAS,EAAE,2CAA2C;gBACtD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,yBAAyB,CAAC,OAAO,GAAG,OAAO,CAAC;IAE5C,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAjCD,0DAiCC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,qBAAqB,CACnC,OAAqC;IAErC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,6BAA6B,EAC7B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,8BAA8B,EAAE;QACvE,iBAAiB;KAClB,CAAC,CAAC;IAEH,SAAS,uBAAuB,CAAC,EAAE,IAAI,EAAO;QAC5C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,yEAAyE;YAC3E,GAAG,EAAE,sDAAsD,CAAC;gBAC1D,SAAS,EAAE,oCAAoC;gBAC/C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,uBAAuB,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1C,OAAO,uBAAuB,CAAC;AACjC,CAAC;AAjCD,sDAiCC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,sBAAsB,CACpC,OAAsC;IAEtC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,8BAA8B,EAC9B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,+BAA+B,EAAE;QACxE,iBAAiB;KAClB,CAAC,CAAC;IAEH,SAAS,wBAAwB,CAAC,EAAE,IAAI,EAAO;QAC7C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yCAAyC;YACrD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,0EAA0E;YAC5E,GAAG,EAAE,sDAAsD,CAAC;gBAC1D,SAAS,EAAE,0CAA0C;gBACrD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,wBAAwB,CAAC,OAAO,GAAG,OAAO,CAAC;IAE3C,OAAO,wBAAwB,CAAC;AAClC,CAAC;AAjCD,wDAiCC"}
|
|
@@ -269,7 +269,7 @@ export interface ListAllJoinGroupRequestsResponse {
|
|
|
269
269
|
/**
|
|
270
270
|
* Approves requests to join a group.
|
|
271
271
|
*
|
|
272
|
-
* > **Note
|
|
272
|
+
* > **Note:** This function is only relevant for private groups.
|
|
273
273
|
*
|
|
274
274
|
* The `approveJoinRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.
|
|
275
275
|
* Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
@@ -279,7 +279,6 @@ export interface ListAllJoinGroupRequestsResponse {
|
|
|
279
279
|
* -->
|
|
280
280
|
* @param memberIds - IDs of the site members to approve.
|
|
281
281
|
* @public
|
|
282
|
-
* @documentationMaturity preview
|
|
283
282
|
* @requiredField groupId
|
|
284
283
|
* @requiredField memberIds
|
|
285
284
|
* @param groupId - ID of the group requested to join.
|
|
@@ -293,7 +292,8 @@ export interface ApproveJoinGroupRequestsOptions {
|
|
|
293
292
|
}
|
|
294
293
|
/**
|
|
295
294
|
* Rejects requests to join a group.
|
|
296
|
-
*
|
|
295
|
+
*
|
|
296
|
+
* > **Note:** This function is only relevant for private groups.
|
|
297
297
|
*
|
|
298
298
|
* The `rejectJoinRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.
|
|
299
299
|
* Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
@@ -304,7 +304,6 @@ export interface ApproveJoinGroupRequestsOptions {
|
|
|
304
304
|
*
|
|
305
305
|
* @param rejections - Rejection data.
|
|
306
306
|
* @public
|
|
307
|
-
* @documentationMaturity preview
|
|
308
307
|
* @requiredField groupId
|
|
309
308
|
* @requiredField rejections
|
|
310
309
|
* @param groupId - ID of the group requested to join.
|
|
@@ -312,7 +311,8 @@ export interface ApproveJoinGroupRequestsOptions {
|
|
|
312
311
|
export declare function rejectJoinGroupRequests(groupId: string, rejections: Rejection[]): Promise<RejectJoinGroupRequestsResponse>;
|
|
313
312
|
/**
|
|
314
313
|
* Lists requests to join a group.
|
|
315
|
-
*
|
|
314
|
+
*
|
|
315
|
+
* > **Note:** This function is only relevant for private groups.
|
|
316
316
|
*
|
|
317
317
|
* The `listJoinRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.
|
|
318
318
|
* Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.
|
|
@@ -320,7 +320,6 @@ export declare function rejectJoinGroupRequests(groupId: string, rejections: Rej
|
|
|
320
320
|
* > **Notes:**
|
|
321
321
|
* <!-- > + If the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can see requests to join a group. -->
|
|
322
322
|
* @public
|
|
323
|
-
* @documentationMaturity preview
|
|
324
323
|
* @requiredField groupId
|
|
325
324
|
* @param groupId - ID of the group requested to join.
|
|
326
325
|
*/
|
|
@@ -334,27 +333,26 @@ export interface ListJoinGroupRequestsOptions {
|
|
|
334
333
|
*
|
|
335
334
|
* > **Notes:**
|
|
336
335
|
* + This function is only relevant for private groups.
|
|
337
|
-
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group.
|
|
336
|
+
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. -->
|
|
338
337
|
*
|
|
339
|
-
* The `queryJoinRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [JoinRequestsQueryBuilder](
|
|
338
|
+
* The `queryJoinRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [JoinRequestsQueryBuilder](#/joinrequestsquerybuilder) object.
|
|
340
339
|
*
|
|
341
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
340
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#/joinrequestsquerybuilder/find) function.
|
|
342
341
|
*
|
|
343
342
|
* You can refine the query by chaining `JoinRequestsQueryBuilder` functions onto the query. `JoinRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryJoinRequests()` returns.
|
|
344
343
|
*
|
|
345
344
|
* The results of the `queryJoinRequests()` function are sorted by `_createdDate` in descending order.
|
|
346
345
|
*
|
|
347
346
|
* `queryJoinRequests()` runs with this `JoinRequestsQueryBuilder` default, which you can override:
|
|
348
|
-
* + [`limit(100)`](
|
|
347
|
+
* + [`limit(100)`](#/joinrequestsquerybuilder/limit)
|
|
349
348
|
*
|
|
350
|
-
* The following `JoinRequestsQueryBuilder` functions are supported for `queryJoinRequests()`. For a full description of the JoinRequests object, see the object returned for the [`items`](
|
|
349
|
+
* The following `JoinRequestsQueryBuilder` functions are supported for `queryJoinRequests()`. For a full description of the JoinRequests object, see the object returned for the [`items`](#/joinrequestsqueryresult/items) property in [`JoinRequestsQueryResult`](#/joinrequestsqueryresult).
|
|
351
350
|
*
|
|
352
351
|
* | Property | Supported Filters & Sorting |
|
|
353
352
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
354
|
-
* | `status` | [`eq()`](
|
|
353
|
+
* | `status` | [`eq()`](#/joinrequestsquerybuilder/eq), [`ne()`](#/joinrequestsquerybuilder/ne), [`hasSome()`](#/joinrequestsquerybuilder/hasSome), [`or()`](#/joinrequestsquerybuilder/or) |
|
|
355
354
|
*
|
|
356
355
|
* @public
|
|
357
|
-
* @documentationMaturity preview
|
|
358
356
|
* @requiredField groupId
|
|
359
357
|
* @param groupId - Group ID.
|
|
360
358
|
*/
|
|
@@ -379,40 +377,26 @@ export interface JoinGroupRequestsQueryResult extends QueryOffsetResult {
|
|
|
379
377
|
export interface JoinGroupRequestsQueryBuilder {
|
|
380
378
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
381
379
|
* @param value - Value to compare against.
|
|
382
|
-
* @documentationMaturity preview
|
|
383
380
|
*/
|
|
384
381
|
eq: (propertyName: 'status', value: any) => JoinGroupRequestsQueryBuilder;
|
|
385
382
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
386
383
|
* @param value - Value to compare against.
|
|
387
|
-
* @documentationMaturity preview
|
|
388
384
|
*/
|
|
389
385
|
ne: (propertyName: 'status', value: any) => JoinGroupRequestsQueryBuilder;
|
|
390
386
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
391
387
|
* @param values - List of values to compare against.
|
|
392
|
-
* @documentationMaturity preview
|
|
393
388
|
*/
|
|
394
389
|
hasSome: (propertyName: 'status', value: any[]) => JoinGroupRequestsQueryBuilder;
|
|
395
|
-
/** @documentationMaturity preview */
|
|
396
390
|
in: (propertyName: 'status', value: any) => JoinGroupRequestsQueryBuilder;
|
|
397
|
-
/** @documentationMaturity preview */
|
|
398
391
|
exists: (propertyName: 'status', value: boolean) => JoinGroupRequestsQueryBuilder;
|
|
399
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
400
|
-
* @documentationMaturity preview
|
|
401
|
-
*/
|
|
392
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
402
393
|
ascending: (...propertyNames: Array<string>) => JoinGroupRequestsQueryBuilder;
|
|
403
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
404
|
-
* @documentationMaturity preview
|
|
405
|
-
*/
|
|
394
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
406
395
|
descending: (...propertyNames: Array<string>) => JoinGroupRequestsQueryBuilder;
|
|
407
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
408
|
-
* @documentationMaturity preview
|
|
409
|
-
*/
|
|
396
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
410
397
|
limit: (limit: number) => JoinGroupRequestsQueryBuilder;
|
|
411
|
-
/** @param skip - Number of items to skip in the query results before returning the results.
|
|
412
|
-
* @documentationMaturity preview
|
|
413
|
-
*/
|
|
398
|
+
/** @param skip - Number of items to skip in the query results before returning the results. */
|
|
414
399
|
skip: (skip: number) => JoinGroupRequestsQueryBuilder;
|
|
415
|
-
/** @documentationMaturity preview */
|
|
416
400
|
find: () => Promise<JoinGroupRequestsQueryResult>;
|
|
417
401
|
}
|
|
418
402
|
export {};
|
|
@@ -103,7 +103,7 @@ const _rejectJoinGroupRequestsResponse = {};
|
|
|
103
103
|
/**
|
|
104
104
|
* Approves requests to join a group.
|
|
105
105
|
*
|
|
106
|
-
* > **Note
|
|
106
|
+
* > **Note:** This function is only relevant for private groups.
|
|
107
107
|
*
|
|
108
108
|
* The `approveJoinRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.
|
|
109
109
|
* Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
@@ -113,7 +113,6 @@ const _rejectJoinGroupRequestsResponse = {};
|
|
|
113
113
|
* -->
|
|
114
114
|
* @param memberIds - IDs of the site members to approve.
|
|
115
115
|
* @public
|
|
116
|
-
* @documentationMaturity preview
|
|
117
116
|
* @requiredField groupId
|
|
118
117
|
* @requiredField memberIds
|
|
119
118
|
* @param groupId - ID of the group requested to join.
|
|
@@ -170,7 +169,8 @@ function approveJoinGroupRequests(groupId, memberIds, options) {
|
|
|
170
169
|
exports.approveJoinGroupRequests = approveJoinGroupRequests;
|
|
171
170
|
/**
|
|
172
171
|
* Rejects requests to join a group.
|
|
173
|
-
*
|
|
172
|
+
*
|
|
173
|
+
* > **Note:** This function is only relevant for private groups.
|
|
174
174
|
*
|
|
175
175
|
* The `rejectJoinRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.
|
|
176
176
|
* Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
@@ -181,7 +181,6 @@ exports.approveJoinGroupRequests = approveJoinGroupRequests;
|
|
|
181
181
|
*
|
|
182
182
|
* @param rejections - Rejection data.
|
|
183
183
|
* @public
|
|
184
|
-
* @documentationMaturity preview
|
|
185
184
|
* @requiredField groupId
|
|
186
185
|
* @requiredField rejections
|
|
187
186
|
* @param groupId - ID of the group requested to join.
|
|
@@ -233,7 +232,8 @@ function rejectJoinGroupRequests(groupId, rejections) {
|
|
|
233
232
|
exports.rejectJoinGroupRequests = rejectJoinGroupRequests;
|
|
234
233
|
/**
|
|
235
234
|
* Lists requests to join a group.
|
|
236
|
-
*
|
|
235
|
+
*
|
|
236
|
+
* > **Note:** This function is only relevant for private groups.
|
|
237
237
|
*
|
|
238
238
|
* The `listJoinRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.
|
|
239
239
|
* Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.
|
|
@@ -241,7 +241,6 @@ exports.rejectJoinGroupRequests = rejectJoinGroupRequests;
|
|
|
241
241
|
* > **Notes:**
|
|
242
242
|
* <!-- > + If the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can see requests to join a group. -->
|
|
243
243
|
* @public
|
|
244
|
-
* @documentationMaturity preview
|
|
245
244
|
* @requiredField groupId
|
|
246
245
|
* @param groupId - ID of the group requested to join.
|
|
247
246
|
*/
|
|
@@ -299,27 +298,26 @@ exports.listJoinGroupRequests = listJoinGroupRequests;
|
|
|
299
298
|
*
|
|
300
299
|
* > **Notes:**
|
|
301
300
|
* + This function is only relevant for private groups.
|
|
302
|
-
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group.
|
|
301
|
+
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. -->
|
|
303
302
|
*
|
|
304
|
-
* The `queryJoinRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [JoinRequestsQueryBuilder](
|
|
303
|
+
* The `queryJoinRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [JoinRequestsQueryBuilder](#/joinrequestsquerybuilder) object.
|
|
305
304
|
*
|
|
306
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
305
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#/joinrequestsquerybuilder/find) function.
|
|
307
306
|
*
|
|
308
307
|
* You can refine the query by chaining `JoinRequestsQueryBuilder` functions onto the query. `JoinRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryJoinRequests()` returns.
|
|
309
308
|
*
|
|
310
309
|
* The results of the `queryJoinRequests()` function are sorted by `_createdDate` in descending order.
|
|
311
310
|
*
|
|
312
311
|
* `queryJoinRequests()` runs with this `JoinRequestsQueryBuilder` default, which you can override:
|
|
313
|
-
* + [`limit(100)`](
|
|
312
|
+
* + [`limit(100)`](#/joinrequestsquerybuilder/limit)
|
|
314
313
|
*
|
|
315
|
-
* The following `JoinRequestsQueryBuilder` functions are supported for `queryJoinRequests()`. For a full description of the JoinRequests object, see the object returned for the [`items`](
|
|
314
|
+
* The following `JoinRequestsQueryBuilder` functions are supported for `queryJoinRequests()`. For a full description of the JoinRequests object, see the object returned for the [`items`](#/joinrequestsqueryresult/items) property in [`JoinRequestsQueryResult`](#/joinrequestsqueryresult).
|
|
316
315
|
*
|
|
317
316
|
* | Property | Supported Filters & Sorting |
|
|
318
317
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
319
|
-
* | `status` | [`eq()`](
|
|
318
|
+
* | `status` | [`eq()`](#/joinrequestsquerybuilder/eq), [`ne()`](#/joinrequestsquerybuilder/ne), [`hasSome()`](#/joinrequestsquerybuilder/hasSome), [`or()`](#/joinrequestsquerybuilder/or) |
|
|
320
319
|
*
|
|
321
320
|
* @public
|
|
322
|
-
* @documentationMaturity preview
|
|
323
321
|
* @requiredField groupId
|
|
324
322
|
* @param groupId - Group ID.
|
|
325
323
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"social-groups-v2-join-group-request.universal.js","sourceRoot":"","sources":["../../../src/social-groups-v2-join-group-request.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAIiC;AAEjC,wHAA0G;AAC1G,aAAa;AACb,4FAA6E;AAE7E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAyB5B,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,kDAAiC,CAAA;IACjC,uBAAuB;IACvB,oCAAmB,CAAA;IACnB,wBAAwB;IACxB,sCAAqB,CAAA;IACrB,wBAAwB;IACxB,sCAAqB,CAAA;IACrB,yBAAyB;IACzB,wCAAuB,CAAA;IACvB,wBAAwB;IACxB,sCAAqB,CAAA;AACvB,CAAC,EAZW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAYxB;AAiCD,IAAY,aASX;AATD,WAAY,aAAa;IACvB,8BAAa,CAAA;IACb,gDAA+B,CAAA;IAC/B,kDAAiC,CAAA;IACjC,8CAA6B,CAAA;IAC7B,kCAAiB,CAAA;IACjB,gDAA+B,CAAA;IAC/B,8DAA6C,CAAA;IAC7C,kDAAiC,CAAA;AACnC,CAAC,EATW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QASxB;AAyED,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,gEAAgE;IAChE,gCAAe,CAAA;IACf,wBAAwB;IACxB,wCAAuB,CAAA;AACzB,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AA+CD,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,iBAAiB;IACjB,8BAAW,CAAA;IACX,qCAAqC;IACrC,oDAAiC,CAAA;AACnC,CAAC,EALW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAK1B;AAuDD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAoCD,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAC1C,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAC1C,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAC3C,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAC3C,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAE5C
|
|
1
|
+
{"version":3,"file":"social-groups-v2-join-group-request.universal.js","sourceRoot":"","sources":["../../../src/social-groups-v2-join-group-request.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAIiC;AAEjC,wHAA0G;AAC1G,aAAa;AACb,4FAA6E;AAE7E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAyB5B,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,kDAAiC,CAAA;IACjC,uBAAuB;IACvB,oCAAmB,CAAA;IACnB,wBAAwB;IACxB,sCAAqB,CAAA;IACrB,wBAAwB;IACxB,sCAAqB,CAAA;IACrB,yBAAyB;IACzB,wCAAuB,CAAA;IACvB,wBAAwB;IACxB,sCAAqB,CAAA;AACvB,CAAC,EAZW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAYxB;AAiCD,IAAY,aASX;AATD,WAAY,aAAa;IACvB,8BAAa,CAAA;IACb,gDAA+B,CAAA;IAC/B,kDAAiC,CAAA;IACjC,8CAA6B,CAAA;IAC7B,kCAAiB,CAAA;IACjB,gDAA+B,CAAA;IAC/B,8DAA6C,CAAA;IAC7C,kDAAiC,CAAA;AACnC,CAAC,EATW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QASxB;AAyED,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,gEAAgE;IAChE,gCAAe,CAAA;IACf,wBAAwB;IACxB,wCAAuB,CAAA;AACzB,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AA+CD,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,iBAAiB;IACjB,8BAAW,CAAA;IACX,qCAAqC;IACrC,oDAAiC,CAAA;AACnC,CAAC,EALW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAK1B;AAuDD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAoCD,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAC5C,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAC1C,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAC1C,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAC3C,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAC3C,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAE5C;;;;;;;;;;;;;;;;GAgBG;AACH,SAAsB,wBAAwB,CAC5C,OAAe,EACf,SAAmB,EACnB,OAAyC;;;QAEzC,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,MAAM;YACjB,aAAa,EAAE,oBAAoB;SACpC,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,gCAAgC;YAC5C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,iCAAiC;YAC7C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;gBACvC,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;QAEnE,MAAM,OAAO,GACX,2CAA2C,CAAC,wBAAwB,CAClE,OAAO,CACR,CAAC;QAEJ,KAAK,CACH,oDAAoD,SAAS,CAAC,OAAO,CAAC,EAAE,CACzE,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;gBACT,WAAW;gBACX,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAjED,4DAiEC;AASD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAsB,uBAAuB,CAC3C,OAAe,EACf,UAAuB;;;QAEvB,MAAM,qBAAqB,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QACtE,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,+BAA+B;YAC3C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,gCAAgC;YAC5C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;gBACvC,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;QAE3D,MAAM,OAAO,GACX,2CAA2C,CAAC,uBAAuB,CACjE,OAAO,CACR,CAAC;QAEJ,KAAK,CACH,mDAAmD,SAAS,CAAC,OAAO,CAAC,EAAE,CACxE,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;gBACT,YAAY;aACb,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AA3DD,0DA2DC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAsB,qBAAqB,CACzC,OAAe,EACf,OAAsC;;;QAEtC,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,aAAa;SACtB,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,8BAA8B;YAC1C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;gBACvC,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAExD,MAAM,OAAO,GACX,2CAA2C,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAE7E,KAAK,CAAC,iDAAiD,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE7E,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;gBACT,SAAS;aACV,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AA3DD,sDA2DC;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAgB,sBAAsB,CACpC,OAAe,EACf,OAAuC;IAEvC,MAAM,qBAAqB,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC9E,MAAM,sBAAsB,GAAG;QAC7B,KAAK,EAAE,qBAAqB;QAC5B,cAAc,EAAE,YAAY;KAC7B,CAAC;IAEF,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;QACzC,UAAU,EAAE,8BAA8B;QAC1C,UAAU,EAAE,EAAE;QACd,kBAAkB,EAAE;YAClB,KAAK,EAAE,EAAE;YACT,cAAc,EAAE,eAAe;SAChC;QACD,oBAAoB,EAAE,qBAAqB;KAC5C,CAAC,CAAC;IAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;QAC9B,UAAU,EAAE,+BAA+B;QAC3C,UAAU,EAAE,EAAE;QACd,kBAAkB,EAAE;YAClB,KAAK,EAAE,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;YACvC,cAAc,EAAE,aAAa;SAC9B;QACD,oBAAoB,EAAE,sBAAsB;KAC7C,CAAC,CAAC;IAEH,OAAO,IAAA,uDAAoB,EAAC;QAC1B,IAAI,EAAE,CAAO,OAAY,EAAE,EAAE;;YAC3B,MAAM,OAAO,GACX,2CAA2C,CAAC,sBAAsB,+CAC7D,OAAO,GACP,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,KAClB,OAAO,IACP,CAAC;YAEL,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;YAC5B,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;aACf;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;aACX;QACH,CAAC,CAAA;QACD,kBAAkB,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC;QACjE,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtD,gBAAgB,EAAE,CAAC,GAAQ,EAAE,EAAE;YAC7B,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;YAEpE,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,IAAA,4CAAqC,EAAC,aAAa,CAAC;KAC1E,CAAC,CAAC,EAAE,4BAA4B,EAAE,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC;AAjED,wDAiEC"}
|
|
@@ -45,24 +45,24 @@ export declare function listGroupMembers(payload: ListGroupMembersRequest): Requ
|
|
|
45
45
|
*
|
|
46
46
|
* Creates a query to retrieve a list of group members.
|
|
47
47
|
*
|
|
48
|
-
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can query group members. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query group members.
|
|
48
|
+
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can query group members. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query group members. -->
|
|
49
49
|
*
|
|
50
|
-
* The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](
|
|
50
|
+
* The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](#/membersquerybuilder) object.
|
|
51
51
|
*
|
|
52
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
52
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#/membersquerybuilder/find) function.
|
|
53
53
|
*
|
|
54
54
|
* You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns.
|
|
55
55
|
*
|
|
56
56
|
* `queryGroupMembers()` runs with these `GroupMembersQueryBuilder` defaults, which you can override:
|
|
57
|
-
* + [`limit(100)`](
|
|
58
|
-
* + [`descending("joinedDate")`](
|
|
57
|
+
* + [`limit(100)`](#/membersquerybuilder/limit)
|
|
58
|
+
* + [`descending("joinedDate")`](#/membersquerybuilder/descending)
|
|
59
59
|
*
|
|
60
|
-
* The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](
|
|
60
|
+
* The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](#/membersqueryresult/items) property in [`GroupMembersQueryResult`](#/membersqueryresult).
|
|
61
61
|
*
|
|
62
62
|
* | Property | Supported Filters & Sorting |
|
|
63
63
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
64
|
-
* | `role` | [`eq()`](
|
|
65
|
-
* | `joinedDate` | [`ascending()`](
|
|
64
|
+
* | `role` | [`eq()`](#/membersquerybuilder/eq), [`ne()`](#/membersquerybuilder/ne) |
|
|
65
|
+
* | `joinedDate` | [`ascending()`](#/membersquerybuilder/ascending), [`descending()`](#/membersquerybuilder/descending) |
|
|
66
66
|
*
|
|
67
67
|
*
|
|
68
68
|
*/
|
|
@@ -86,25 +86,25 @@ export declare function listMemberships(payload: ListMembershipsRequest): Reques
|
|
|
86
86
|
*
|
|
87
87
|
* Creates a query to retrieve a list of memberships.
|
|
88
88
|
*
|
|
89
|
-
* > **Note:** Only site admins can query a site member's memberships. Site members can query their memberships. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query a site member's memberships.
|
|
89
|
+
* > **Note:** Only site admins can query a site member's memberships. Site members can query their memberships. <!--However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query a site member's memberships. -->
|
|
90
90
|
*
|
|
91
|
-
* The `queryMemberships()` function builds a query to retrieve a list of all memberships, and returns a [MembershipsQueryBuilder](
|
|
91
|
+
* The `queryMemberships()` function builds a query to retrieve a list of all memberships, and returns a [MembershipsQueryBuilder](#/membershipsquerybuilder) object.
|
|
92
92
|
*
|
|
93
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
93
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#/membershipsquerybuilder/find) function.
|
|
94
94
|
*
|
|
95
95
|
* You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMemberships()` returns.
|
|
96
96
|
*
|
|
97
97
|
* The results of the `queryMemberships()` function are sorted by `groupId` in descending order.
|
|
98
98
|
*
|
|
99
99
|
* `queryMemberships()` runs with this `GroupMembersQueryBuilder` default, which you can override:
|
|
100
|
-
* + [`limit(100)`](
|
|
100
|
+
* + [`limit(100)`](#/membershipsquerybuilder/limit)
|
|
101
101
|
*
|
|
102
|
-
* The following `GroupMembersQueryBuilder` functions are supported for `queryMemberships()`. For a full description of the Memberships object, see the object returned for the [`items`](
|
|
102
|
+
* The following `GroupMembersQueryBuilder` functions are supported for `queryMemberships()`. For a full description of the Memberships object, see the object returned for the [`items`](#/membershipsqueryresult/items) property in [`MembershipsQueryResult`](#/membershipsqueryresult).
|
|
103
103
|
*
|
|
104
104
|
* | Property | Supported Filters & Sorting |
|
|
105
105
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
106
|
-
* | `status` | [`eq()`](
|
|
107
|
-
* | `role` | [`eq()`](
|
|
106
|
+
* | `status` | [`eq()`](#/membershipsquerybuilder/eq), [`ne()`](#/membershipsquerybuilder/ne) |
|
|
107
|
+
* | `role` | [`eq()`](#/membershipsquerybuilder/eq), [`ne()`](#/membershipsquerybuilder/ne) |
|
|
108
108
|
*
|
|
109
109
|
*/
|
|
110
110
|
export declare function queryMemberships(payload: QueryMembershipsRequest): RequestOptionsFactory<QueryMembershipsResponse>;
|
|
@@ -291,24 +291,24 @@ export function listGroupMembers(payload) {
|
|
|
291
291
|
*
|
|
292
292
|
* Creates a query to retrieve a list of group members.
|
|
293
293
|
*
|
|
294
|
-
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can query group members. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query group members.
|
|
294
|
+
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can query group members. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query group members. -->
|
|
295
295
|
*
|
|
296
|
-
* The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](
|
|
296
|
+
* The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](#/membersquerybuilder) object.
|
|
297
297
|
*
|
|
298
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
298
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#/membersquerybuilder/find) function.
|
|
299
299
|
*
|
|
300
300
|
* You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns.
|
|
301
301
|
*
|
|
302
302
|
* `queryGroupMembers()` runs with these `GroupMembersQueryBuilder` defaults, which you can override:
|
|
303
|
-
* + [`limit(100)`](
|
|
304
|
-
* + [`descending("joinedDate")`](
|
|
303
|
+
* + [`limit(100)`](#/membersquerybuilder/limit)
|
|
304
|
+
* + [`descending("joinedDate")`](#/membersquerybuilder/descending)
|
|
305
305
|
*
|
|
306
|
-
* The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](
|
|
306
|
+
* The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](#/membersqueryresult/items) property in [`GroupMembersQueryResult`](#/membersqueryresult).
|
|
307
307
|
*
|
|
308
308
|
* | Property | Supported Filters & Sorting |
|
|
309
309
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
310
|
-
* | `role` | [`eq()`](
|
|
311
|
-
* | `joinedDate` | [`ascending()`](
|
|
310
|
+
* | `role` | [`eq()`](#/membersquerybuilder/eq), [`ne()`](#/membersquerybuilder/ne) |
|
|
311
|
+
* | `joinedDate` | [`ascending()`](#/membersquerybuilder/ascending), [`descending()`](#/membersquerybuilder/descending) |
|
|
312
312
|
*
|
|
313
313
|
*
|
|
314
314
|
*/
|
|
@@ -376,25 +376,25 @@ export function listMemberships(payload) {
|
|
|
376
376
|
*
|
|
377
377
|
* Creates a query to retrieve a list of memberships.
|
|
378
378
|
*
|
|
379
|
-
* > **Note:** Only site admins can query a site member's memberships. Site members can query their memberships. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query a site member's memberships.
|
|
379
|
+
* > **Note:** Only site admins can query a site member's memberships. Site members can query their memberships. <!--However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query a site member's memberships. -->
|
|
380
380
|
*
|
|
381
|
-
* The `queryMemberships()` function builds a query to retrieve a list of all memberships, and returns a [MembershipsQueryBuilder](
|
|
381
|
+
* The `queryMemberships()` function builds a query to retrieve a list of all memberships, and returns a [MembershipsQueryBuilder](#/membershipsquerybuilder) object.
|
|
382
382
|
*
|
|
383
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
383
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#/membershipsquerybuilder/find) function.
|
|
384
384
|
*
|
|
385
385
|
* You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMemberships()` returns.
|
|
386
386
|
*
|
|
387
387
|
* The results of the `queryMemberships()` function are sorted by `groupId` in descending order.
|
|
388
388
|
*
|
|
389
389
|
* `queryMemberships()` runs with this `GroupMembersQueryBuilder` default, which you can override:
|
|
390
|
-
* + [`limit(100)`](
|
|
390
|
+
* + [`limit(100)`](#/membershipsquerybuilder/limit)
|
|
391
391
|
*
|
|
392
|
-
* The following `GroupMembersQueryBuilder` functions are supported for `queryMemberships()`. For a full description of the Memberships object, see the object returned for the [`items`](
|
|
392
|
+
* The following `GroupMembersQueryBuilder` functions are supported for `queryMemberships()`. For a full description of the Memberships object, see the object returned for the [`items`](#/membershipsqueryresult/items) property in [`MembershipsQueryResult`](#/membershipsqueryresult).
|
|
393
393
|
*
|
|
394
394
|
* | Property | Supported Filters & Sorting |
|
|
395
395
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
396
|
-
* | `status` | [`eq()`](
|
|
397
|
-
* | `role` | [`eq()`](
|
|
396
|
+
* | `status` | [`eq()`](#/membershipsquerybuilder/eq), [`ne()`](#/membershipsquerybuilder/ne) |
|
|
397
|
+
* | `role` | [`eq()`](#/membershipsquerybuilder/eq), [`ne()`](#/membershipsquerybuilder/ne) |
|
|
398
398
|
*
|
|
399
399
|
*/
|
|
400
400
|
export function queryMemberships(payload) {
|
|
@@ -276,7 +276,6 @@ export interface QueryMembershipsResponse {
|
|
|
276
276
|
* @param groupId - Group ID.
|
|
277
277
|
* @param memberIds - IDs of the site members to add to the group.
|
|
278
278
|
* @public
|
|
279
|
-
* @documentationMaturity preview
|
|
280
279
|
* @requiredField groupId
|
|
281
280
|
* @requiredField memberIds
|
|
282
281
|
*/
|
|
@@ -298,7 +297,6 @@ export interface AddGroupMembersOptions {
|
|
|
298
297
|
* @param groupId - Group ID.
|
|
299
298
|
* @param memberIds - IDs of the site members to remove from the group.
|
|
300
299
|
* @public
|
|
301
|
-
* @documentationMaturity preview
|
|
302
300
|
* @requiredField groupId
|
|
303
301
|
* @requiredField memberIds
|
|
304
302
|
*/
|
|
@@ -322,7 +320,6 @@ export interface RemoveGroupMembersOptions {
|
|
|
322
320
|
*
|
|
323
321
|
* @param groupId - Group ID.
|
|
324
322
|
* @public
|
|
325
|
-
* @documentationMaturity preview
|
|
326
323
|
* @requiredField groupId
|
|
327
324
|
* @param options - Paging options.
|
|
328
325
|
*/
|
|
@@ -339,28 +336,27 @@ export interface ListGroupMembersOptions {
|
|
|
339
336
|
*
|
|
340
337
|
* Creates a query to retrieve a list of group members.
|
|
341
338
|
*
|
|
342
|
-
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can query group members. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query group members.
|
|
339
|
+
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can query group members. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query group members. -->
|
|
343
340
|
*
|
|
344
|
-
* The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](
|
|
341
|
+
* The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](#/membersquerybuilder) object.
|
|
345
342
|
*
|
|
346
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
343
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#/membersquerybuilder/find) function.
|
|
347
344
|
*
|
|
348
345
|
* You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns.
|
|
349
346
|
*
|
|
350
347
|
* `queryGroupMembers()` runs with these `GroupMembersQueryBuilder` defaults, which you can override:
|
|
351
|
-
* + [`limit(100)`](
|
|
352
|
-
* + [`descending("joinedDate")`](
|
|
348
|
+
* + [`limit(100)`](#/membersquerybuilder/limit)
|
|
349
|
+
* + [`descending("joinedDate")`](#/membersquerybuilder/descending)
|
|
353
350
|
*
|
|
354
|
-
* The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](
|
|
351
|
+
* The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](#/membersqueryresult/items) property in [`GroupMembersQueryResult`](#/membersqueryresult).
|
|
355
352
|
*
|
|
356
353
|
* | Property | Supported Filters & Sorting |
|
|
357
354
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
358
|
-
* | `role` | [`eq()`](
|
|
359
|
-
* | `joinedDate` | [`ascending()`](
|
|
355
|
+
* | `role` | [`eq()`](#/membersquerybuilder/eq), [`ne()`](#/membersquerybuilder/ne) |
|
|
356
|
+
* | `joinedDate` | [`ascending()`](#/membersquerybuilder/ascending), [`descending()`](#/membersquerybuilder/descending) |
|
|
360
357
|
*
|
|
361
358
|
*
|
|
362
359
|
* @public
|
|
363
|
-
* @documentationMaturity preview
|
|
364
360
|
* @requiredField groupId
|
|
365
361
|
* @param groupId - Group ID.
|
|
366
362
|
*/
|
|
@@ -383,40 +379,26 @@ export interface MembersQueryResult extends QueryOffsetResult {
|
|
|
383
379
|
export interface MembersQueryBuilder {
|
|
384
380
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
385
381
|
* @param value - Value to compare against.
|
|
386
|
-
* @documentationMaturity preview
|
|
387
382
|
*/
|
|
388
383
|
eq: (propertyName: 'role', value: any) => MembersQueryBuilder;
|
|
389
384
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
390
385
|
* @param value - Value to compare against.
|
|
391
|
-
* @documentationMaturity preview
|
|
392
386
|
*/
|
|
393
387
|
ne: (propertyName: 'role', value: any) => MembersQueryBuilder;
|
|
394
388
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
395
389
|
* @param values - List of values to compare against.
|
|
396
|
-
* @documentationMaturity preview
|
|
397
390
|
*/
|
|
398
391
|
hasSome: (propertyName: 'role', value: any[]) => MembersQueryBuilder;
|
|
399
|
-
/** @documentationMaturity preview */
|
|
400
392
|
in: (propertyName: 'role', value: any) => MembersQueryBuilder;
|
|
401
|
-
/** @documentationMaturity preview */
|
|
402
393
|
exists: (propertyName: 'role', value: boolean) => MembersQueryBuilder;
|
|
403
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
404
|
-
* @documentationMaturity preview
|
|
405
|
-
*/
|
|
394
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
406
395
|
ascending: (...propertyNames: Array<'role' | 'joinedDate'>) => MembersQueryBuilder;
|
|
407
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
408
|
-
* @documentationMaturity preview
|
|
409
|
-
*/
|
|
396
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
410
397
|
descending: (...propertyNames: Array<'role' | 'joinedDate'>) => MembersQueryBuilder;
|
|
411
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
412
|
-
* @documentationMaturity preview
|
|
413
|
-
*/
|
|
398
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
414
399
|
limit: (limit: number) => MembersQueryBuilder;
|
|
415
|
-
/** @param skip - Number of items to skip in the query results before returning the results.
|
|
416
|
-
* @documentationMaturity preview
|
|
417
|
-
*/
|
|
400
|
+
/** @param skip - Number of items to skip in the query results before returning the results. */
|
|
418
401
|
skip: (skip: number) => MembersQueryBuilder;
|
|
419
|
-
/** @documentationMaturity preview */
|
|
420
402
|
find: () => Promise<MembersQueryResult>;
|
|
421
403
|
}
|
|
422
404
|
/**
|
|
@@ -431,7 +413,6 @@ export interface MembersQueryBuilder {
|
|
|
431
413
|
* > + This function's parameters are positional, and must be specified in the sequence shown in the syntax below. When specifying a parameter, use `null` as a placeholder for any unspecified parameters. For example, to specify `limit` only, call `listMemberships(memberId, paging, null)`. To specify `supressAuth` only, call `listMemberships(memberId, null, options)`.
|
|
432
414
|
*
|
|
433
415
|
* @public
|
|
434
|
-
* @documentationMaturity preview
|
|
435
416
|
* @requiredField memberId
|
|
436
417
|
* @param memberId - Site member ID.
|
|
437
418
|
* @param options - Paging options.
|
|
@@ -449,28 +430,27 @@ export interface ListMembershipsOptions {
|
|
|
449
430
|
*
|
|
450
431
|
* Creates a query to retrieve a list of memberships.
|
|
451
432
|
*
|
|
452
|
-
* > **Note:** Only site admins can query a site member's memberships. Site members can query their memberships. However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query a site member's memberships.
|
|
433
|
+
* > **Note:** Only site admins can query a site member's memberships. Site members can query their memberships. <!--However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query a site member's memberships. -->
|
|
453
434
|
*
|
|
454
|
-
* The `queryMemberships()` function builds a query to retrieve a list of all memberships, and returns a [MembershipsQueryBuilder](
|
|
435
|
+
* The `queryMemberships()` function builds a query to retrieve a list of all memberships, and returns a [MembershipsQueryBuilder](#/membershipsquerybuilder) object.
|
|
455
436
|
*
|
|
456
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
437
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#/membershipsquerybuilder/find) function.
|
|
457
438
|
*
|
|
458
439
|
* You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMemberships()` returns.
|
|
459
440
|
*
|
|
460
441
|
* The results of the `queryMemberships()` function are sorted by `groupId` in descending order.
|
|
461
442
|
*
|
|
462
443
|
* `queryMemberships()` runs with this `GroupMembersQueryBuilder` default, which you can override:
|
|
463
|
-
* + [`limit(100)`](
|
|
444
|
+
* + [`limit(100)`](#/membershipsquerybuilder/limit)
|
|
464
445
|
*
|
|
465
|
-
* The following `GroupMembersQueryBuilder` functions are supported for `queryMemberships()`. For a full description of the Memberships object, see the object returned for the [`items`](
|
|
446
|
+
* The following `GroupMembersQueryBuilder` functions are supported for `queryMemberships()`. For a full description of the Memberships object, see the object returned for the [`items`](#/membershipsqueryresult/items) property in [`MembershipsQueryResult`](#/membershipsqueryresult).
|
|
466
447
|
*
|
|
467
448
|
* | Property | Supported Filters & Sorting |
|
|
468
449
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
469
|
-
* | `status` | [`eq()`](
|
|
470
|
-
* | `role` | [`eq()`](
|
|
450
|
+
* | `status` | [`eq()`](#/membershipsquerybuilder/eq), [`ne()`](#/membershipsquerybuilder/ne) |
|
|
451
|
+
* | `role` | [`eq()`](#/membershipsquerybuilder/eq), [`ne()`](#/membershipsquerybuilder/ne) |
|
|
471
452
|
*
|
|
472
453
|
* @public
|
|
473
|
-
* @documentationMaturity preview
|
|
474
454
|
* @requiredField memberId
|
|
475
455
|
* @param memberId - Site member ID.
|
|
476
456
|
*/
|