@slack/web-api/dist/types/request/usergroups.d.ts

Official library for using the Slack Platform's Web API

import type { OptionalArgument } from '../helpers';
import type { OptionalTeamAssignable, TokenOverridable } from './common';
export interface UsergroupsIncludeCount {
    /** @description Include the number of users in each User Group. */
    include_count?: boolean;
}
export interface UsergroupsCreateArguments extends TokenOverridable, OptionalTeamAssignable, UsergroupsIncludeCount {
    /** @description A name for the User Group. Must be unique among User Groups. */
    name: string;
    /** @description A comma separated string of encoded channel IDs for which the User Group uses as a default. */
    channels?: string;
    /** @description A short description of the User Group. */
    description?: string;
    /** @description A mention handle. Must be unique among channels, users and User Groups. */
    handle?: string;
}
export interface UsergroupsDisableArguments extends TokenOverridable, OptionalTeamAssignable, UsergroupsIncludeCount {
    /** @description The encoded ID of the User Group to disable. */
    usergroup: string;
}
export interface UsergroupsEnableArguments extends TokenOverridable, OptionalTeamAssignable, UsergroupsIncludeCount {
    /** @description The encoded ID of the User Group to enable. */
    usergroup: string;
}
export type UsergroupsListArguments = OptionalArgument<TokenOverridable & OptionalTeamAssignable & UsergroupsIncludeCount & {
    /** @description Include disabled User Groups. */
    include_disabled?: boolean;
    /** @description Include the list of users for each User Group. */
    include_users?: boolean;
}>;
export interface UsergroupsUpdateArguments extends TokenOverridable, OptionalTeamAssignable, Partial<UsergroupsCreateArguments> {
    /** @description The encoded ID of the User Group to update. */
    usergroup: string;
}
export interface UsergroupsUsersListArguments extends TokenOverridable, OptionalTeamAssignable {
    /** @description The encoded ID of the User Group to list users for. */
    usergroup: string;
    /** @description Allow results that involve disabled User Groups. */
    include_disabled?: boolean;
}
export interface UsergroupsUsersUpdateArguments extends TokenOverridable, OptionalTeamAssignable, UsergroupsIncludeCount {
    /** @description The encoded ID of the User Group to update users for. */
    usergroup: string;
    /**
     * @description A comma separated string of encoded user IDs that represent the entire list of users for
     * the User Group.
     */
    users: string;
}
//# sourceMappingURL=usergroups.d.ts.map