@wix/groups 1.0.25 → 1.0.26

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.
@@ -1,16 +1,19 @@
1
1
  import { RequestOptionsFactory } from '@wix/sdk-types';
2
2
  import { AssignRoleRequest, AssignRoleResponse, UnassignRoleRequest, UnassignRoleResponse } from './social-groups-v2-group-role.types';
3
3
  /**
4
- * Assigns a specific role to members.
5
- * >**Notes:**
6
- * > + Only admins can assign roles.
7
- * > + You cannot create new members via this endpoint.
4
+ * Assigns a specific role to group members.
5
+ *
6
+ *
7
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
8
+ *
9
+ * The `assignRole()` function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.
8
10
  */
9
11
  export declare function assignRole(payload: AssignRoleRequest): RequestOptionsFactory<AssignRoleResponse>;
10
12
  /**
11
- * Unassigns a role from members.
12
- * >**Notes:**
13
- * > + Only admins can unassign roles.
14
- * > + You cannot remove members via this endpoint.
13
+ * Unassigns a role from group members.
14
+ *
15
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
16
+ *
17
+ * The `unassignRole()` function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.
15
18
  */
16
19
  export declare function unassignRole(payload: UnassignRoleRequest): RequestOptionsFactory<UnassignRoleResponse>;
@@ -173,10 +173,12 @@ function resolveWixSocialGroupsApiV2GroupRolesServiceUrl(opts) {
173
173
  return (0, metro_runtime_1.resolveUrl)(Object.assign(opts, { domainToMappings }));
174
174
  }
175
175
  /**
176
- * Assigns a specific role to members.
177
- * >**Notes:**
178
- * > + Only admins can assign roles.
179
- * > + You cannot create new members via this endpoint.
176
+ * Assigns a specific role to group members.
177
+ *
178
+ *
179
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
180
+ *
181
+ * The `assignRole()` function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.
180
182
  */
181
183
  function assignRole(payload) {
182
184
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_assignRoleRequest, {});
@@ -202,10 +204,11 @@ function assignRole(payload) {
202
204
  }
203
205
  exports.assignRole = assignRole;
204
206
  /**
205
- * Unassigns a role from members.
206
- * >**Notes:**
207
- * > + Only admins can unassign roles.
208
- * > + You cannot remove members via this endpoint.
207
+ * Unassigns a role from group members.
208
+ *
209
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
210
+ *
211
+ * The `unassignRole()` function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.
209
212
  */
210
213
  function unassignRole(payload) {
211
214
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_unassignRoleRequest, {});
@@ -1 +1 @@
1
- {"version":3,"file":"social-groups-v2-group-role.http.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-role.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAUhD,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC,SAAS,+CAA+C,CACtD,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;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,kBAAkB,EAClB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAElE,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,uDAAuD;YAClE,GAAG,EAAE,+CAA+C,CAAC;gBACnD,SAAS,EAAE,mCAAmC;gBAC9C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/B,OAAO,YAAY,CAAC;AACtB,CAAC;AA9BD,gCA8BC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,OAA4B;IAE5B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,oBAAoB,EACpB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;IAEpE,SAAS,cAAc,CAAC,EAAE,IAAI,EAAO;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,yDAAyD;YACpE,GAAG,EAAE,+CAA+C,CAAC;gBACnD,SAAS,EAAE,qCAAqC;gBAChD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;IAEjC,OAAO,cAAc,CAAC;AACxB,CAAC;AA9BD,oCA8BC"}
1
+ {"version":3,"file":"social-groups-v2-group-role.http.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-role.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAUhD,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC,SAAS,+CAA+C,CACtD,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;;;;;;;GAOG;AACH,SAAgB,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,kBAAkB,EAClB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAElE,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,uDAAuD;YAClE,GAAG,EAAE,+CAA+C,CAAC;gBACnD,SAAS,EAAE,mCAAmC;gBAC9C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/B,OAAO,YAAY,CAAC;AACtB,CAAC;AA9BD,gCA8BC;AAED;;;;;;GAMG;AACH,SAAgB,YAAY,CAC1B,OAA4B;IAE5B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,oBAAoB,EACpB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;IAEpE,SAAS,cAAc,CAAC,EAAE,IAAI,EAAO;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,yDAAyD;YACpE,GAAG,EAAE,+CAA+C,CAAC;gBACnD,SAAS,EAAE,qCAAqC;gBAChD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;IAEjC,OAAO,cAAc,CAAC;AACxB,CAAC;AA9BD,oCA8BC"}
@@ -27,11 +27,14 @@ export interface AssignRoleRequest {
27
27
  /** Group ID. */
28
28
  groupId: string;
29
29
  /**
30
- * __Deprecated.__ Use `memberIds` instead.
31
- * This parameter will be removed on June 30, 2022.
32
- */
30
+ * @internal
31
+ * @internal */
33
32
  siteMemberIds?: string[];
34
- /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
33
+ /**
34
+ * Member IDs.
35
+ *
36
+ * Max: 100 member IDs
37
+ */
35
38
  memberIds?: string[];
36
39
  /** Role to assign. */
37
40
  role?: GroupRole;
@@ -40,11 +43,10 @@ export interface AssignRoleResponse {
40
43
  /** Group ID. */
41
44
  groupId?: string;
42
45
  /**
43
- * __Deprecated.__ Use `memberIds` instead.
44
- * This parameter will be removed on June 30, 2022.
45
- */
46
+ * @internal
47
+ * @internal */
46
48
  siteMemberIds?: string[];
47
- /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
49
+ /** Member IDs */
48
50
  memberIds?: string[];
49
51
  /** Assigned role. */
50
52
  role?: GroupRole;
@@ -83,11 +85,14 @@ export interface UnassignRoleRequest {
83
85
  /** Group ID. */
84
86
  groupId: string;
85
87
  /**
86
- * __Deprecated.__ Use `memberIds` instead.
87
- * This parameter will be removed on June 30, 2022.
88
- */
88
+ * @internal
89
+ * @internal */
89
90
  siteMemberIds?: string[];
90
- /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
91
+ /**
92
+ * Member IDs.
93
+ *
94
+ * Max: 100 member IDs
95
+ */
91
96
  memberIds?: string[];
92
97
  /** Role to unassign. */
93
98
  role?: GroupRole;
@@ -95,9 +100,11 @@ export interface UnassignRoleRequest {
95
100
  export interface UnassignRoleResponse {
96
101
  /** Group ID. */
97
102
  groupId?: string;
98
- /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
103
+ /**
104
+ * @internal
105
+ * @internal */
99
106
  siteMemberIds?: string[];
100
- /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
107
+ /** Member IDs. */
101
108
  memberIds?: string[];
102
109
  /** Unassigned role. */
103
110
  role?: GroupRole;
@@ -113,15 +120,18 @@ export interface RoleUnassignedFromGroupMember {
113
120
  unassignedById?: string | null;
114
121
  }
115
122
  /**
116
- * Assigns a specific role to members.
117
- * >**Notes:**
118
- * > + Only admins can assign roles.
119
- * > + You cannot create new members via this endpoint.
123
+ * Assigns a specific role to group members.
124
+ *
125
+ *
126
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
127
+ *
128
+ * The `assignRole()` function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.
120
129
  * @param groupId - Group ID.
121
- * @param memberIds - Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
130
+ * @param memberIds - Member IDs.
131
+ *
132
+ * Max: 100 member IDs
122
133
  * @param role - Role to assign.
123
134
  * @public
124
- * @documentationMaturity preview
125
135
  * @requiredField groupId
126
136
  * @requiredField memberIds
127
137
  * @requiredField role
@@ -129,22 +139,21 @@ export interface RoleUnassignedFromGroupMember {
129
139
  */
130
140
  export declare function assignRole(groupId: string, memberIds: string[], role: GroupRole, options?: AssignRoleOptions): Promise<AssignRoleResponse>;
131
141
  export interface AssignRoleOptions {
132
- /**
133
- * __Deprecated.__ Use `memberIds` instead.
134
- * This parameter will be removed on June 30, 2022.
135
- */
142
+ /** @internal */
136
143
  siteMemberIds?: string[];
137
144
  }
138
145
  /**
139
- * Unassigns a role from members.
140
- * >**Notes:**
141
- * > + Only admins can unassign roles.
142
- * > + You cannot remove members via this endpoint.
146
+ * Unassigns a role from group members.
147
+ *
148
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
149
+ *
150
+ * The `unassignRole()` function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.
143
151
  * @param groupId - Group ID.
144
- * @param memberIds - Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
152
+ * @param memberIds - Member IDs.
153
+ *
154
+ * Max: 100 member IDs
145
155
  * @param role - Role to unassign.
146
156
  * @public
147
- * @documentationMaturity preview
148
157
  * @requiredField groupId
149
158
  * @requiredField memberIds
150
159
  * @requiredField role
@@ -152,9 +161,6 @@ export interface AssignRoleOptions {
152
161
  */
153
162
  export declare function unassignRole(groupId: string, memberIds: string[], role: GroupRole, options?: UnassignRoleOptions): Promise<UnassignRoleResponse>;
154
163
  export interface UnassignRoleOptions {
155
- /**
156
- * __Deprecated.__ Use `memberIds` instead.
157
- * This parameter will be removed on June 30, 2022.
158
- */
164
+ /** @internal */
159
165
  siteMemberIds?: string[];
160
166
  }
@@ -59,15 +59,18 @@ const _assignRoleResponse = {};
59
59
  const _unassignRoleRequest = {};
60
60
  const _unassignRoleResponse = {};
61
61
  /**
62
- * Assigns a specific role to members.
63
- * >**Notes:**
64
- * > + Only admins can assign roles.
65
- * > + You cannot create new members via this endpoint.
62
+ * Assigns a specific role to group members.
63
+ *
64
+ *
65
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
66
+ *
67
+ * The `assignRole()` function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.
66
68
  * @param groupId - Group ID.
67
- * @param memberIds - Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
69
+ * @param memberIds - Member IDs.
70
+ *
71
+ * Max: 100 member IDs
68
72
  * @param role - Role to assign.
69
73
  * @public
70
- * @documentationMaturity preview
71
74
  * @requiredField groupId
72
75
  * @requiredField memberIds
73
76
  * @requiredField role
@@ -126,15 +129,17 @@ function assignRole(groupId, memberIds, role, options) {
126
129
  }
127
130
  exports.assignRole = assignRole;
128
131
  /**
129
- * Unassigns a role from members.
130
- * >**Notes:**
131
- * > + Only admins can unassign roles.
132
- * > + You cannot remove members via this endpoint.
132
+ * Unassigns a role from group members.
133
+ *
134
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
135
+ *
136
+ * The `unassignRole()` function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.
133
137
  * @param groupId - Group ID.
134
- * @param memberIds - Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
138
+ * @param memberIds - Member IDs.
139
+ *
140
+ * Max: 100 member IDs
135
141
  * @param role - Role to unassign.
136
142
  * @public
137
- * @documentationMaturity preview
138
143
  * @requiredField groupId
139
144
  * @requiredField memberIds
140
145
  * @requiredField role
@@ -1 +1 @@
1
- {"version":3,"file":"social-groups-v2-group-role.universal.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-role.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,yGAA2F;AAE3F,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;AAe5B,IAAY,IAMX;AAND,WAAY,IAAI;IACd,qCAA6B,CAAA;IAC7B,4BAA4B;IAC5B,yBAAiB,CAAA;IACjB,2BAA2B;IAC3B,uBAAe,CAAA;AACjB,CAAC,EANW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAMf;AAkGD,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC;;;;;;;;;;;;;;GAcG;AACH,SAAsB,UAAU,CAC9B,OAAe,EACf,SAAmB,EACnB,IAAe,EACf,OAA2B;;;QAE3B,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,MAAM;YACZ,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,kBAAkB;YAC9B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,mBAAmB;YAC/B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,oCAAoC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEzE,KAAK,CAAC,sCAAsC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAElE,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,MAAM;gBACN,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;AA/DD,gCA+DC;AAUD;;;;;;;;;;;;;;GAcG;AACH,SAAsB,YAAY,CAChC,OAAe,EACf,SAAmB,EACnB,IAAe,EACf,OAA6B;;;QAE7B,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,MAAM;YACZ,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,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,qBAAqB;YACjC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,oCAAoC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAE3E,KAAK,CAAC,wCAAwC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEpE,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,MAAM;gBACN,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;AA/DD,oCA+DC"}
1
+ {"version":3,"file":"social-groups-v2-group-role.universal.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-role.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,yGAA2F;AAE3F,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;AAe5B,IAAY,IAMX;AAND,WAAY,IAAI;IACd,qCAA6B,CAAA;IAC7B,4BAA4B;IAC5B,yBAAiB,CAAA;IACjB,2BAA2B;IAC3B,uBAAe,CAAA;AACjB,CAAC,EANW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAMf;AAyGD,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAsB,UAAU,CAC9B,OAAe,EACf,SAAmB,EACnB,IAAe,EACf,OAA2B;;;QAE3B,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,MAAM;YACZ,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,kBAAkB;YAC9B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,mBAAmB;YAC/B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,oCAAoC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEzE,KAAK,CAAC,sCAAsC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAElE,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,MAAM;gBACN,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;AA/DD,gCA+DC;AAOD;;;;;;;;;;;;;;;;GAgBG;AACH,SAAsB,YAAY,CAChC,OAAe,EACf,SAAmB,EACnB,IAAe,EACf,OAA6B;;;QAE7B,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,MAAM;YACZ,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,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,qBAAqB;YACjC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,oCAAoC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAE3E,KAAK,CAAC,wCAAwC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEpE,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,MAAM;gBACN,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;AA/DD,oCA+DC"}
@@ -1,16 +1,19 @@
1
1
  import { RequestOptionsFactory } from '@wix/sdk-types';
2
2
  import { AssignRoleRequest, AssignRoleResponse, UnassignRoleRequest, UnassignRoleResponse } from './social-groups-v2-group-role.types';
3
3
  /**
4
- * Assigns a specific role to members.
5
- * >**Notes:**
6
- * > + Only admins can assign roles.
7
- * > + You cannot create new members via this endpoint.
4
+ * Assigns a specific role to group members.
5
+ *
6
+ *
7
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
8
+ *
9
+ * The `assignRole()` function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.
8
10
  */
9
11
  export declare function assignRole(payload: AssignRoleRequest): RequestOptionsFactory<AssignRoleResponse>;
10
12
  /**
11
- * Unassigns a role from members.
12
- * >**Notes:**
13
- * > + Only admins can unassign roles.
14
- * > + You cannot remove members via this endpoint.
13
+ * Unassigns a role from group members.
14
+ *
15
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
16
+ *
17
+ * The `unassignRole()` function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.
15
18
  */
16
19
  export declare function unassignRole(payload: UnassignRoleRequest): RequestOptionsFactory<UnassignRoleResponse>;
@@ -170,10 +170,12 @@ function resolveWixSocialGroupsApiV2GroupRolesServiceUrl(opts) {
170
170
  return resolveUrl(Object.assign(opts, { domainToMappings }));
171
171
  }
172
172
  /**
173
- * Assigns a specific role to members.
174
- * >**Notes:**
175
- * > + Only admins can assign roles.
176
- * > + You cannot create new members via this endpoint.
173
+ * Assigns a specific role to group members.
174
+ *
175
+ *
176
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
177
+ *
178
+ * The `assignRole()` function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.
177
179
  */
178
180
  export function assignRole(payload) {
179
181
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_assignRoleRequest, {});
@@ -198,10 +200,11 @@ export function assignRole(payload) {
198
200
  return __assignRole;
199
201
  }
200
202
  /**
201
- * Unassigns a role from members.
202
- * >**Notes:**
203
- * > + Only admins can unassign roles.
204
- * > + You cannot remove members via this endpoint.
203
+ * Unassigns a role from group members.
204
+ *
205
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
206
+ *
207
+ * The `unassignRole()` function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.
205
208
  */
206
209
  export function unassignRole(payload) {
207
210
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_unassignRoleRequest, {});
@@ -1 +1 @@
1
- {"version":3,"file":"social-groups-v2-group-role.http.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-role.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAUhD,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC,SAAS,+CAA+C,CACtD,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,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,kBAAkB,EAClB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAElE,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,uDAAuD;YAClE,GAAG,EAAE,+CAA+C,CAAC;gBACnD,SAAS,EAAE,mCAAmC;gBAC9C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/B,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,OAA4B;IAE5B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,oBAAoB,EACpB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;IAEpE,SAAS,cAAc,CAAC,EAAE,IAAI,EAAO;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,yDAAyD;YACpE,GAAG,EAAE,+CAA+C,CAAC;gBACnD,SAAS,EAAE,qCAAqC;gBAChD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;IAEjC,OAAO,cAAc,CAAC;AACxB,CAAC"}
1
+ {"version":3,"file":"social-groups-v2-group-role.http.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-role.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAUhD,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC,SAAS,+CAA+C,CACtD,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,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,kBAAkB,EAClB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAElE,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,uDAAuD;YAClE,GAAG,EAAE,+CAA+C,CAAC;gBACnD,SAAS,EAAE,mCAAmC;gBAC9C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/B,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,OAA4B;IAE5B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,oBAAoB,EACpB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;IAEpE,SAAS,cAAc,CAAC,EAAE,IAAI,EAAO;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,yDAAyD;YACpE,GAAG,EAAE,+CAA+C,CAAC;gBACnD,SAAS,EAAE,qCAAqC;gBAChD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;IAEjC,OAAO,cAAc,CAAC;AACxB,CAAC"}
@@ -27,11 +27,14 @@ export interface AssignRoleRequest {
27
27
  /** Group ID. */
28
28
  groupId: string;
29
29
  /**
30
- * __Deprecated.__ Use `memberIds` instead.
31
- * This parameter will be removed on June 30, 2022.
32
- */
30
+ * @internal
31
+ * @internal */
33
32
  siteMemberIds?: string[];
34
- /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
33
+ /**
34
+ * Member IDs.
35
+ *
36
+ * Max: 100 member IDs
37
+ */
35
38
  memberIds?: string[];
36
39
  /** Role to assign. */
37
40
  role?: GroupRole;
@@ -40,11 +43,10 @@ export interface AssignRoleResponse {
40
43
  /** Group ID. */
41
44
  groupId?: string;
42
45
  /**
43
- * __Deprecated.__ Use `memberIds` instead.
44
- * This parameter will be removed on June 30, 2022.
45
- */
46
+ * @internal
47
+ * @internal */
46
48
  siteMemberIds?: string[];
47
- /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
49
+ /** Member IDs */
48
50
  memberIds?: string[];
49
51
  /** Assigned role. */
50
52
  role?: GroupRole;
@@ -83,11 +85,14 @@ export interface UnassignRoleRequest {
83
85
  /** Group ID. */
84
86
  groupId: string;
85
87
  /**
86
- * __Deprecated.__ Use `memberIds` instead.
87
- * This parameter will be removed on June 30, 2022.
88
- */
88
+ * @internal
89
+ * @internal */
89
90
  siteMemberIds?: string[];
90
- /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
91
+ /**
92
+ * Member IDs.
93
+ *
94
+ * Max: 100 member IDs
95
+ */
91
96
  memberIds?: string[];
92
97
  /** Role to unassign. */
93
98
  role?: GroupRole;
@@ -95,9 +100,11 @@ export interface UnassignRoleRequest {
95
100
  export interface UnassignRoleResponse {
96
101
  /** Group ID. */
97
102
  groupId?: string;
98
- /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
103
+ /**
104
+ * @internal
105
+ * @internal */
99
106
  siteMemberIds?: string[];
100
- /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
107
+ /** Member IDs. */
101
108
  memberIds?: string[];
102
109
  /** Unassigned role. */
103
110
  role?: GroupRole;
@@ -113,15 +120,18 @@ export interface RoleUnassignedFromGroupMember {
113
120
  unassignedById?: string | null;
114
121
  }
115
122
  /**
116
- * Assigns a specific role to members.
117
- * >**Notes:**
118
- * > + Only admins can assign roles.
119
- * > + You cannot create new members via this endpoint.
123
+ * Assigns a specific role to group members.
124
+ *
125
+ *
126
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
127
+ *
128
+ * The `assignRole()` function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.
120
129
  * @param groupId - Group ID.
121
- * @param memberIds - Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
130
+ * @param memberIds - Member IDs.
131
+ *
132
+ * Max: 100 member IDs
122
133
  * @param role - Role to assign.
123
134
  * @public
124
- * @documentationMaturity preview
125
135
  * @requiredField groupId
126
136
  * @requiredField memberIds
127
137
  * @requiredField role
@@ -129,22 +139,21 @@ export interface RoleUnassignedFromGroupMember {
129
139
  */
130
140
  export declare function assignRole(groupId: string, memberIds: string[], role: GroupRole, options?: AssignRoleOptions): Promise<AssignRoleResponse>;
131
141
  export interface AssignRoleOptions {
132
- /**
133
- * __Deprecated.__ Use `memberIds` instead.
134
- * This parameter will be removed on June 30, 2022.
135
- */
142
+ /** @internal */
136
143
  siteMemberIds?: string[];
137
144
  }
138
145
  /**
139
- * Unassigns a role from members.
140
- * >**Notes:**
141
- * > + Only admins can unassign roles.
142
- * > + You cannot remove members via this endpoint.
146
+ * Unassigns a role from group members.
147
+ *
148
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
149
+ *
150
+ * The `unassignRole()` function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.
143
151
  * @param groupId - Group ID.
144
- * @param memberIds - Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
152
+ * @param memberIds - Member IDs.
153
+ *
154
+ * Max: 100 member IDs
145
155
  * @param role - Role to unassign.
146
156
  * @public
147
- * @documentationMaturity preview
148
157
  * @requiredField groupId
149
158
  * @requiredField memberIds
150
159
  * @requiredField role
@@ -152,9 +161,6 @@ export interface AssignRoleOptions {
152
161
  */
153
162
  export declare function unassignRole(groupId: string, memberIds: string[], role: GroupRole, options?: UnassignRoleOptions): Promise<UnassignRoleResponse>;
154
163
  export interface UnassignRoleOptions {
155
- /**
156
- * __Deprecated.__ Use `memberIds` instead.
157
- * This parameter will be removed on June 30, 2022.
158
- */
164
+ /** @internal */
159
165
  siteMemberIds?: string[];
160
166
  }
@@ -37,15 +37,18 @@ const _assignRoleResponse = {};
37
37
  const _unassignRoleRequest = {};
38
38
  const _unassignRoleResponse = {};
39
39
  /**
40
- * Assigns a specific role to members.
41
- * >**Notes:**
42
- * > + Only admins can assign roles.
43
- * > + You cannot create new members via this endpoint.
40
+ * Assigns a specific role to group members.
41
+ *
42
+ *
43
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
44
+ *
45
+ * The `assignRole()` function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.
44
46
  * @param groupId - Group ID.
45
- * @param memberIds - Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
47
+ * @param memberIds - Member IDs.
48
+ *
49
+ * Max: 100 member IDs
46
50
  * @param role - Role to assign.
47
51
  * @public
48
- * @documentationMaturity preview
49
52
  * @requiredField groupId
50
53
  * @requiredField memberIds
51
54
  * @requiredField role
@@ -103,15 +106,17 @@ export function assignRole(groupId, memberIds, role, options) {
103
106
  });
104
107
  }
105
108
  /**
106
- * Unassigns a role from members.
107
- * >**Notes:**
108
- * > + Only admins can unassign roles.
109
- * > + You cannot remove members via this endpoint.
109
+ * Unassigns a role from group members.
110
+ *
111
+ * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.
112
+ *
113
+ * The `unassignRole()` function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.
110
114
  * @param groupId - Group ID.
111
- * @param memberIds - Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
115
+ * @param memberIds - Member IDs.
116
+ *
117
+ * Max: 100 member IDs
112
118
  * @param role - Role to unassign.
113
119
  * @public
114
- * @documentationMaturity preview
115
120
  * @requiredField groupId
116
121
  * @requiredField memberIds
117
122
  * @requiredField role
@@ -1 +1 @@
1
- {"version":3,"file":"social-groups-v2-group-role.universal.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-role.universal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,oCAAoC,MAAM,oCAAoC,CAAC;AAE3F,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;AAED,MAAM,CAAC,MAAM,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;AAe5B,MAAM,CAAN,IAAY,IAMX;AAND,WAAY,IAAI;IACd,qCAA6B,CAAA;IAC7B,4BAA4B;IAC5B,yBAAiB,CAAA;IACjB,2BAA2B;IAC3B,uBAAe,CAAA;AACjB,CAAC,EANW,IAAI,KAAJ,IAAI,QAMf;AAkGD,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAgB,UAAU,CAC9B,OAAe,EACf,SAAmB,EACnB,IAAe,EACf,OAA2B;;;QAE3B,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,MAAM;YACZ,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,UAAU,CAAC;YACzC,UAAU,EAAE,kBAAkB;YAC9B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,mBAAmB;YAC/B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,oCAAoC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEzE,KAAK,CAAC,sCAAsC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAElE,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,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;gBACT,WAAW;gBACX,MAAM;gBACN,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;AAUD;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAgB,YAAY,CAChC,OAAe,EACf,SAAmB,EACnB,IAAe,EACf,OAA6B;;;QAE7B,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,MAAM;YACZ,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,UAAU,CAAC;YACzC,UAAU,EAAE,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,qBAAqB;YACjC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,oCAAoC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAE3E,KAAK,CAAC,wCAAwC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEpE,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,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;gBACT,WAAW;gBACX,MAAM;gBACN,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"}
1
+ {"version":3,"file":"social-groups-v2-group-role.universal.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-role.universal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,KAAK,oCAAoC,MAAM,oCAAoC,CAAC;AAE3F,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;AAED,MAAM,CAAC,MAAM,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;AAe5B,MAAM,CAAN,IAAY,IAMX;AAND,WAAY,IAAI;IACd,qCAA6B,CAAA;IAC7B,4BAA4B;IAC5B,yBAAiB,CAAA;IACjB,2BAA2B;IAC3B,uBAAe,CAAA;AACjB,CAAC,EANW,IAAI,KAAJ,IAAI,QAMf;AAyGD,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAgB,UAAU,CAC9B,OAAe,EACf,SAAmB,EACnB,IAAe,EACf,OAA2B;;;QAE3B,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,MAAM;YACZ,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,UAAU,CAAC;YACzC,UAAU,EAAE,kBAAkB;YAC9B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,mBAAmB;YAC/B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,oCAAoC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEzE,KAAK,CAAC,sCAAsC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAElE,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,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;gBACT,WAAW;gBACX,MAAM;gBACN,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;AAOD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAgB,YAAY,CAChC,OAAe,EACf,SAAmB,EACnB,IAAe,EACf,OAA6B;;;QAE7B,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,MAAM;YACZ,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,UAAU,CAAC;YACzC,UAAU,EAAE,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,qBAAqB;YACjC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,oCAAoC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAE3E,KAAK,CAAC,wCAAwC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEpE,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,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,SAAS;gBACT,WAAW;gBACX,MAAM;gBACN,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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/groups",
3
- "version": "1.0.25",
3
+ "version": "1.0.26",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -33,5 +33,5 @@
33
33
  "groupId": "com.wixpress.public-sdk-autogen"
34
34
  }
35
35
  },
36
- "falconPackageHash": "14bea0e2d54dafc681458c3b59cd08d299beec126b8f8ceb09584c30"
36
+ "falconPackageHash": "c865c9edd134a76d74fd14c1925f1e68a0d0ffd5a3c24de45ce98247"
37
37
  }