UNPKG

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