usergroups

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Slack Web API methods for user groups.

Types

Create

Identifies usergroups.create in the slackline.Call that create returns.

pub type Create

CreateResponse

</>

A successful response from usergroups.create.

pub type CreateResponse {
  CreateResponse(usergroup: option.Option(usergroup.Usergroup))
}

Constructors

```
CreateResponse(usergroup: option.Option(usergroup.Usergroup))
```
Arguments

usergroup

The new user group, including its preferences.

Disable

</>

Identifies usergroups.disable in the slackline.Call that disable returns.

pub type Disable

DisableResponse

</>

A successful response from usergroups.disable.

pub type DisableResponse {
  DisableResponse(usergroup: option.Option(usergroup.Usergroup))
}

Constructors

```
DisableResponse(usergroup: option.Option(usergroup.Usergroup))
```
Arguments

usergroup

The disabled user group. Its date_delete is non-zero.

Enable

</>

Identifies usergroups.enable in the slackline.Call that enable returns.

pub type Enable

ListMethod

</>

Identifies usergroups.list in the slackline.Call that list returns.

pub type ListMethod

ListResponse

</>

A successful response from usergroups.list.

pub type ListResponse {
  ListResponse(
    usergroups: option.Option(List(usergroup.Usergroup)),
  )
}

Constructors

ListResponse(
  usergroups: option.Option(List(usergroup.Usergroup)),
)

Arguments

usergroups: The user groups, in no particular order.

Update

</>

Identifies usergroups.update in the slackline.Call that update returns.

pub type Update

UsersList

</>

Identifies usergroups.users.list in the slackline.Call that users_list returns.

pub type UsersList

UsersListResponse

</>

A successful response from usergroups.users.list.

pub type UsersListResponse {
  UsersListResponse(users: option.Option(List(String)))
}

Constructors

UsersListResponse(users: option.Option(List(String)))

Arguments

users: The IDs of the users in the user group.

UsersUpdate

</>

Identifies usergroups.users.update in the slackline.Call that users_update returns.

pub type UsersUpdate

Values

create

</>

pub fn create(
  name name: String,
) -> slackline.Call(Create, CreateResponse)

usergroups.create: Create a User Group.

usergroups.Create identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/usergroups/create.

Bot token scopes: usergroups:write. User token scopes: usergroups:write.

Rate limit tier: t2.

Documented errors: bad_handle, description_too_long, forbidden_handle, handle_already_exists, invalid_channel_provided, invalid_group_provided, missing_subteam_name, name_already_exists, name_too_long, paid_teams_only, permission_denied, plan_upgrade_required, target_team_must_be_specified_in_org_context, target_team_not_on_org.

create_response_decoder

</>

pub fn create_response_decoder() -> decode.Decoder(CreateResponse)

Decodes the response from usergroups.create.

disable

</>

pub fn disable(
  usergroup usergroup: String,
) -> slackline.Call(Disable, DisableResponse)

usergroups.disable: Disable an existing User Group.

usergroups.Disable identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/usergroups/disable.

Bot token scopes: usergroups:write. User token scopes: usergroups:write.

Rate limit tier: t2.

Documented errors: permission_denied, plan_upgrade_required, target_team_must_be_specified_in_org_context, target_team_not_on_org.

disable_response_decoder

</>

pub fn disable_response_decoder() -> decode.Decoder(
  DisableResponse,
)

Decodes the response from usergroups.disable.

enable

</>

pub fn enable(
  usergroup usergroup: String,
) -> slackline.Call(Enable, EnableResponse)

usergroups.enable: Enable a User Group.

usergroups.Enable identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/usergroups/enable.

Bot token scopes: usergroups:write. User token scopes: usergroups:write.

Rate limit tier: t2.

Documented errors: permission_denied, plan_upgrade_required.

enable_response_decoder

</>

pub fn enable_response_decoder() -> decode.Decoder(EnableResponse)

Decodes the response from usergroups.enable.

list

</>

pub fn list() -> slackline.Call(ListMethod, ListResponse)

usergroups.list: List all User Groups for a team.

usergroups.ListMethod identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/usergroups/list.

Bot token scopes: usergroups:read. User token scopes: usergroups:read.

Rate limit tier: t2.

Documented errors: invalid_cursor, invalid_team, plan_upgrade_required, users_not_found.

list_response_decoder

</>

pub fn list_response_decoder() -> decode.Decoder(ListResponse)

Decodes the response from usergroups.list.

update

</>

pub fn update(
  usergroup usergroup: String,
) -> slackline.Call(Update, UpdateResponse)

usergroups.update: Update an existing User Group.

usergroups.Update identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/usergroups/update.

Bot token scopes: usergroups:write. User token scopes: usergroups:write.

Rate limit tier: t2.

Documented errors: paid_teams_only, permission_denied, too_many_linked_channels, user_channel_limit_exceeded.

update_response_decoder

</>

pub fn update_response_decoder() -> decode.Decoder(UpdateResponse)

Decodes the response from usergroups.update.

users_list

</>

pub fn users_list(
  usergroup usergroup: String,
) -> slackline.Call(UsersList, UsersListResponse)

usergroups.users.list: List all users in a User Group.

usergroups.UsersList identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/usergroups/users_list.

Bot token scopes: usergroups:read. User token scopes: usergroups:read.

Rate limit tier: t2.

Documented errors: invalid_cursor, no_such_subteam, plan_upgrade_required.

users_list_response_decoder

</>

pub fn users_list_response_decoder() -> decode.Decoder(
  UsersListResponse,
)

Decodes the response from usergroups.users.list.

users_update

</>

pub fn users_update(
  usergroup usergroup: String,
  users users: List(String),
) -> slackline.Call(UsersUpdate, UsersUpdateResponse)

usergroups.users.update: Update the list of users for a user group.

usergroups.UsersUpdate identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/usergroups/users_update.

Bot token scopes: usergroups:write. User token scopes: usergroups:write.

Rate limit tier: t2.

Documented errors: cannot_modify_role_admin, failed_for_some_users, invalid_users, no_users_provided, permission_denied, plan_upgrade_required, subteam_max_users_exceeded.

users_update_response_decoder

</>

pub fn users_update_response_decoder() -> decode.Decoder(
  UsersUpdateResponse,
)

Decodes the response from usergroups.users.update.