UNPKG

2.47 kBTypeScriptView Raw
1import { OptionalTeamAssignable, TokenOverridable } from './common';
2interface UsergroupsIncludeCount {
3 /** @description Include the number of users in each User Group. */
4 include_count?: boolean;
5}
6export interface UsergroupsCreateArguments extends TokenOverridable, OptionalTeamAssignable, UsergroupsIncludeCount {
7 /** @description A name for the User Group. Must be unique among User Groups. */
8 name: string;
9 /** @description A comma separated string of encoded channel IDs for which the User Group uses as a default. */
10 channels?: string;
11 /** @description A short description of the User Group. */
12 description?: string;
13 /** @description A mention handle. Must be unique among channels, users and User Groups. */
14 handle?: string;
15}
16export interface UsergroupsDisableArguments extends TokenOverridable, OptionalTeamAssignable, UsergroupsIncludeCount {
17 /** @description The encoded ID of the User Group to disable. */
18 usergroup: string;
19}
20export interface UsergroupsEnableArguments extends TokenOverridable, OptionalTeamAssignable, UsergroupsIncludeCount {
21 /** @description The encoded ID of the User Group to enable. */
22 usergroup: string;
23}
24export interface UsergroupsListArguments extends TokenOverridable, OptionalTeamAssignable, UsergroupsIncludeCount {
25 /** @description Include disabled User Groups. */
26 include_disabled?: boolean;
27 /** @description Include the list of users for each User Group. */
28 include_users?: boolean;
29}
30export interface UsergroupsUpdateArguments extends TokenOverridable, OptionalTeamAssignable, Partial<UsergroupsCreateArguments> {
31 /** @description The encoded ID of the User Group to update. */
32 usergroup: string;
33}
34export interface UsergroupsUsersListArguments extends TokenOverridable, OptionalTeamAssignable {
35 /** @description The encoded ID of the User Group to list users for. */
36 usergroup: string;
37 /** @description Allow results that involve disabled User Groups. */
38 include_disabled?: boolean;
39}
40export interface UsergroupsUsersUpdateArguments extends TokenOverridable, OptionalTeamAssignable, UsergroupsIncludeCount {
41 /** @description The encoded ID of the User Group to update users for. */
42 usergroup: string;
43 /**
44 * @description A comma separated string of encoded user IDs that represent the entire list of users for
45 * the User Group.
46 */
47 users: string;
48}
49export {};
50//# sourceMappingURL=usergroups.d.ts.map
\No newline at end of file