slackline/team

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

Workspaces (teams), Enterprise organizations and team profiles.

Types

SlackbotAvailability

Whether Slackbot is available in a workspace. Advisory only.

pub type SlackbotAvailability {
  Available
  Restricted
  Unavailable
  Unknown
  UnknownSlackbotAvailability(String)
}

Constructors

```
Available
```
The workspace or organization normally has access to Slackbot.
```
Restricted
```
An admin has limited Slackbot access to certain people or workspaces.
```
Unavailable
```
Unavailable because of the plan, an admin setting or another restriction.
```
Unknown
```
Slack could not determine availability.
```
UnknownSlackbotAvailability(String)
```
A value that this version of slackline does not know.

Team

</>

A workspace or Enterprise organization.

pub type Team {
  Team(
    id: String,
    name: option.Option(String),
    domain: option.Option(String),
    email_domain: option.Option(String),
    icon: option.Option(TeamIcon),
    enterprise_id: option.Option(String),
    enterprise_name: option.Option(String),
    slackbot_availability: option.Option(SlackbotAvailability),
    avatar_base_url: option.Option(String),
    is_verified: option.Option(Bool),
    date_created: option.Option(Int),
    requires_sponsorship: option.Option(Bool),
    is_migrating: option.Option(Bool),
  )
}

Constructors

Team(
  id: String,
  name: option.Option(String),
  domain: option.Option(String),
  email_domain: option.Option(String),
  icon: option.Option(TeamIcon),
  enterprise_id: option.Option(String),
  enterprise_name: option.Option(String),
  slackbot_availability: option.Option(SlackbotAvailability),
  avatar_base_url: option.Option(String),
  is_verified: option.Option(Bool),
  date_created: option.Option(Int),
  requires_sponsorship: option.Option(Bool),
  is_migrating: option.Option(Bool),
)

Arguments

id: The workspace (T...) or organization (E...) ID.
domain: The workspace’s Slack subdomain.
slackbot_availability: Advisory Slackbot availability, only with include_slackbot_availability.
is_migrating: Whether the team is migrating between organizations.

TeamIcon

</>

A workspace icon in several sizes.

pub type TeamIcon {
  TeamIcon(
    image_34: option.Option(String),
    image_44: option.Option(String),
    image_68: option.Option(String),
    image_88: option.Option(String),
    image_102: option.Option(String),
    image_132: option.Option(String),
    image_230: option.Option(String),
    image_original: option.Option(String),
    image_default: option.Option(Bool),
  )
}

Constructors

TeamIcon(
  image_34: option.Option(String),
  image_44: option.Option(String),
  image_68: option.Option(String),
  image_88: option.Option(String),
  image_102: option.Option(String),
  image_132: option.Option(String),
  image_230: option.Option(String),
  image_original: option.Option(String),
  image_default: option.Option(Bool),
)

Arguments

image_default: true when the workspace uses the default icon.

TeamProfile

</>

The profile fields and sections defined for a workspace (team.profile.get).

pub type TeamProfile {
  TeamProfile(
    fields: option.Option(List(TeamProfileField)),
    sections: option.Option(List(TeamProfileSection)),
  )
}

Constructors

TeamProfile(
  fields: option.Option(List(TeamProfileField)),
  sections: option.Option(List(TeamProfileSection)),
)

Arguments

fields: The profile fields.
sections: The profile sections.

TeamProfileField

</>

A profile field definition.

pub type TeamProfileField {
  TeamProfileField(
    id: String,
    ordering: option.Option(Int),
    field_name: option.Option(String),
    label: option.Option(String),
    hint: option.Option(String),
    type_: option.Option(TeamProfileFieldType),
    possible_values: option.Option(List(String)),
    options: option.Option(TeamProfileFieldOptions),
    is_hidden: option.Option(Bool),
    section_id: option.Option(String),
  )
}

Constructors

```
TeamProfileField(
  id: String,
  ordering: option.Option(Int),
  field_name: option.Option(String),
  label: option.Option(String),
  hint: option.Option(String),
  type_: option.Option(TeamProfileFieldType),
  possible_values: option.Option(List(String)),
  options: option.Option(TeamProfileFieldOptions),
  is_hidden: option.Option(Bool),
  section_id: option.Option(String),
)
```
Arguments

id

The field ID.

ordering

The placement of the field on the profile.

field_name

The name of the field.

label

The text shown for the field.

hint

Additional context to help the user fill in the field.

type_

The format the field supports.

possible_values

The values the user can choose from, for options_list fields.

options

SCIM and protection options.

is_hidden

Whether the field is hidden.

section_id

The ID of the section the field is in.

TeamProfileFieldOptions

</>

Options on a custom profile field.

pub type TeamProfileFieldOptions {
  TeamProfileFieldOptions(
    is_scim: option.Option(Bool),
    is_protected: option.Option(Bool),
  )
}

Constructors

```
TeamProfileFieldOptions(
  is_scim: option.Option(Bool),
  is_protected: option.Option(Bool),
)
```
Arguments

is_scim

If true, the field is updated through the SCIM API rather than users.profile.set.

is_protected

Whether the field is protected.

TeamProfileFieldType

</>

The format a custom profile field supports.

pub type TeamProfileFieldType {
  DateField
  LinkField
  LongTextField
  OptionsListField
  TagsField
  TextField
  UserField
  FileField
  UnknownTeamProfileFieldType(String)
}

Constructors

```
DateField
```
date
```
LinkField
```
link
```
LongTextField
```
long_text
```
OptionsListField
```
options_list
```
TagsField
```
tags
```
TextField
```
text
```
UserField
```
user
```
FileField
```
file
```
UnknownTeamProfileFieldType(String)
```
A value that this version of slackline does not know.

TeamProfileSection

</>

A profile section definition.

pub type TeamProfileSection {
  TeamProfileSection(
    id: String,
    team_id: option.Option(String),
    section_type: option.Option(String),
    label: option.Option(String),
    order: option.Option(Int),
    is_hidden: option.Option(Bool),
  )
}

Constructors

```
TeamProfileSection(
  id: String,
  team_id: option.Option(String),
  section_type: option.Option(String),
  label: option.Option(String),
  order: option.Option(Int),
  is_hidden: option.Option(Bool),
)
```
Arguments

id

The section ID.

team_id

The workspace ID.

section_type

The type of content in the section. Users can only create custom sections.

label

The text shown for the section.

order

The placement of the section on the profile.

is_hidden

Whether the section is hidden.

Values

slackbot_availability_decoder

</>

pub fn slackbot_availability_decoder() -> decode.Decoder(
  SlackbotAvailability,
)

Decodes SlackbotAvailability from a json string.

slackbot_availability_from_string

</>

pub fn slackbot_availability_from_string(
  string: String,
) -> SlackbotAvailability

Parses SlackbotAvailability from its json string.

slackbot_availability_to_json

</>

pub fn slackbot_availability_to_json(
  it: SlackbotAvailability,
) -> json.Json

Encodes SlackbotAvailability as a json string.

slackbot_availability_to_string

</>

pub fn slackbot_availability_to_string(
  it: SlackbotAvailability,
) -> String

The json string of SlackbotAvailability.

team_decoder

</>

pub fn team_decoder() -> decode.Decoder(Team)

Decodes Team from json.

team_icon_decoder

</>

pub fn team_icon_decoder() -> decode.Decoder(TeamIcon)

Decodes TeamIcon from json.

team_icon_to_json

</>

pub fn team_icon_to_json(it: TeamIcon) -> json.Json

Encodes TeamIcon as json.

team_profile_decoder

</>

pub fn team_profile_decoder() -> decode.Decoder(TeamProfile)

Decodes TeamProfile from json.

team_profile_field_decoder

</>

pub fn team_profile_field_decoder() -> decode.Decoder(
  TeamProfileField,
)

Decodes TeamProfileField from json.

team_profile_field_options_decoder

</>

pub fn team_profile_field_options_decoder() -> decode.Decoder(
  TeamProfileFieldOptions,
)

Decodes TeamProfileFieldOptions from json.

team_profile_field_options_to_json

</>

pub fn team_profile_field_options_to_json(
  it: TeamProfileFieldOptions,
) -> json.Json

Encodes TeamProfileFieldOptions as json.

team_profile_field_to_json

</>

pub fn team_profile_field_to_json(
  it: TeamProfileField,
) -> json.Json

Encodes TeamProfileField as json.

team_profile_field_type_decoder

</>

pub fn team_profile_field_type_decoder() -> decode.Decoder(
  TeamProfileFieldType,
)

Decodes TeamProfileFieldType from a json string.

team_profile_field_type_from_string

</>

pub fn team_profile_field_type_from_string(
  string: String,
) -> TeamProfileFieldType

Parses TeamProfileFieldType from its json string.

team_profile_field_type_to_json

</>

pub fn team_profile_field_type_to_json(
  it: TeamProfileFieldType,
) -> json.Json

Encodes TeamProfileFieldType as a json string.

team_profile_field_type_to_string

</>

pub fn team_profile_field_type_to_string(
  it: TeamProfileFieldType,
) -> String

The json string of TeamProfileFieldType.

team_profile_section_decoder

</>

pub fn team_profile_section_decoder() -> decode.Decoder(
  TeamProfileSection,
)

Decodes TeamProfileSection from json.

team_profile_section_to_json

</>

pub fn team_profile_section_to_json(
  it: TeamProfileSection,
) -> json.Json

Encodes TeamProfileSection as json.

team_profile_to_json

</>

pub fn team_profile_to_json(it: TeamProfile) -> json.Json

Encodes TeamProfile as json.

team_to_json

</>

pub fn team_to_json(it: Team) -> json.Json

Encodes Team as json.