slackbot

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

Admin API methods for managing Slackbot skills across an org.

Types

AutoEnabledStatus

Filter skills by whether they are enabled automatically.

pub type AutoEnabledStatus {
  AnyAutoEnabledStatus
  Enabled
  Disabled
}

Constructors

```
AnyAutoEnabledStatus
```
all
```
Enabled
```
enabled
```
Disabled
```
disabled

PublishStatus

</>

Filter skills by whether they are published.

pub type PublishStatus {
  AnyPublishStatus
  Published
  Unpublished
}

Constructors

```
AnyPublishStatus
```
all
```
Published
```
published
```
Unpublished
```
unpublished

SkillAutoEnabled

</>

How a skill is deployed across the org.

pub type SkillAutoEnabled {
  SkillAutoEnabled(
    permission_type: option.Option(SkillPermissionType),
    usergroup_ids: option.Option(List(String)),
  )
}

Constructors

SkillAutoEnabled(
  permission_type: option.Option(SkillPermissionType),
  usergroup_ids: option.Option(List(String)),
)

Arguments

permission_type: The deployment audience.
usergroup_ids: User groups the skill is deployed to, for named_entities.

SkillPermissionType

</>

Who a skill is deployed to.

pub type SkillPermissionType {
  Everyone
  NamedEntities
  NoOne
  UnknownSkillPermissionType(String)
}

Constructors

```
Everyone
```
everyone
```
NamedEntities
```
named_entities
```
NoOne
```
no_one
```
UnknownSkillPermissionType(String)
```
A value that this version of slackline does not know.

SkillSort

</>

How to sort skills.

pub type SkillSort {
  SortByName
  UsageCount
  DateUpdated
}

Constructors

```
SortByName
```
name
```
UsageCount
```
usage_count
```
DateUpdated
```
date_updated

SkillsList

</>

Identifies admin.slackbot.skills.list in the slackline.Call that skills_list returns.

pub type SkillsList

SkillsListResponse

</>

A successful response from admin.slackbot.skills.list.

pub type SkillsListResponse {
  SkillsListResponse(
    skills: option.Option(List(SlackbotSkill)),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

SkillsListResponse(
  skills: option.Option(List(SlackbotSkill)),
  response_metadata: option.Option(slackline.ResponseMetadata),
)

SkillsPublish

</>

Identifies admin.slackbot.skills.publish in the slackline.Call that skills_publish returns.

pub type SkillsPublish

SkillsSetAutoEnabled

</>

Identifies admin.slackbot.skills.setAutoEnabled in the slackline.Call that skills_set_auto_enabled returns.

pub type SkillsSetAutoEnabled

SkillsSetAutoEnabledResponse

</>

A successful response from admin.slackbot.skills.setAutoEnabled.

pub type SkillsSetAutoEnabledResponse {
  SkillsSetAutoEnabledResponse(
    skill_id: option.Option(String),
    permission_type: option.Option(SkillPermissionType),
    usergroup_ids: option.Option(List(String)),
  )
}

Constructors

SkillsSetAutoEnabledResponse(
  skill_id: option.Option(String),
  permission_type: option.Option(SkillPermissionType),
  usergroup_ids: option.Option(List(String)),
)

Arguments

skill_id: The skill that was deployed.

SkillsUnpublish

</>

Identifies admin.slackbot.skills.unpublish in the slackline.Call that skills_unpublish returns.

pub type SkillsUnpublish

SlackbotSkill

</>

A Slackbot skill (a canvas skill) in the org inventory.

pub type SlackbotSkill {
  SlackbotSkill(
    id: String,
    display_name: option.Option(String),
    description: option.Option(String),
    category: option.Option(common.SkillCategory),
    creator_id: option.Option(String),
    date_created: option.Option(Int),
    date_updated: option.Option(Int),
    visibility: option.Option(String),
    is_official: option.Option(Bool),
    usage_count: option.Option(Int),
    library_count: option.Option(Int),
    auto_enabled: option.Option(SkillAutoEnabled),
  )
}

Constructors

SlackbotSkill(
  id: String,
  display_name: option.Option(String),
  description: option.Option(String),
  category: option.Option(common.SkillCategory),
  creator_id: option.Option(String),
  date_created: option.Option(Int),
  date_updated: option.Option(Int),
  visibility: option.Option(String),
  is_official: option.Option(Bool),
  usage_count: option.Option(Int),
  library_count: option.Option(Int),
  auto_enabled: option.Option(SkillAutoEnabled),
)

Arguments

id: The skill ID, which is a file ID such as F0123ABCD.
creator_id: ID of the user who created the skill.
date_created: When the skill was created, in Unix seconds.
date_updated: When the skill was last edited, in Unix seconds.
visibility: Who can see the skill, such as invite_only.
auto_enabled: Org deployment, independent of publication.

Values

auto_enabled_status_decoder

</>

pub fn auto_enabled_status_decoder() -> decode.Decoder(
  AutoEnabledStatus,
)

Decodes AutoEnabledStatus from a json string.

auto_enabled_status_from_string

</>

pub fn auto_enabled_status_from_string(
  string: String,
) -> Result(AutoEnabledStatus, Nil)

Parses AutoEnabledStatus from its json string.

auto_enabled_status_to_json

</>

pub fn auto_enabled_status_to_json(
  it: AutoEnabledStatus,
) -> json.Json

Encodes AutoEnabledStatus as a json string.

publish_status_decoder

</>

pub fn publish_status_decoder() -> decode.Decoder(PublishStatus)

Decodes PublishStatus from a json string.

publish_status_from_string

</>

pub fn publish_status_from_string(
  string: String,
) -> Result(PublishStatus, Nil)

Parses PublishStatus from its json string.

publish_status_to_json

</>

pub fn publish_status_to_json(it: PublishStatus) -> json.Json

Encodes PublishStatus as a json string.

skill_permission_type_decoder

</>

pub fn skill_permission_type_decoder() -> decode.Decoder(
  SkillPermissionType,
)

Decodes SkillPermissionType from a json string.

skill_permission_type_from_string

</>

pub fn skill_permission_type_from_string(
  string: String,
) -> SkillPermissionType

Parses SkillPermissionType from its json string.

skill_permission_type_to_json

</>

pub fn skill_permission_type_to_json(
  it: SkillPermissionType,
) -> json.Json

Encodes SkillPermissionType as a json string.

skill_permission_type_to_string

</>

pub fn skill_permission_type_to_string(
  it: SkillPermissionType,
) -> String

The json string of SkillPermissionType.

skills_list

</>

pub fn skills_list() -> slackline.Call(
  SkillsList,
  SkillsListResponse,
)

admin.slackbot.skills.list: Lists metadata for Slackbot skills owned by an organization.

slackbot.SkillsList identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/slackbot/skills_list.

User token scopes: admin.skills:read.

Rate limit tier: t2.

Documented errors: feature_not_enabled, invalid_category, invalid_cursor, restricted_action.

skills_list_response_decoder

</>

pub fn skills_list_response_decoder() -> decode.Decoder(
  SkillsListResponse,
)

Decodes the response from admin.slackbot.skills.list.

skills_publish

</>

pub fn skills_publish(
  skill_ids skill_ids: List(String),
) -> slackline.Call(SkillsPublish, Nil)

admin.slackbot.skills.publish: Publishes Slackbot skills to an organization’s catalog.

slackbot.SkillsPublish identifies this method in slackline.Call.

User token scopes: admin.skills:write.

Rate limit tier: t2.

Documented errors: failed_for_some_skills, feature_not_enabled, restricted_action.

skills_set_auto_enabled

</>

pub fn skills_set_auto_enabled(
  skill_id skill_id: String,
  permission_type permission_type: SkillPermissionType,
) -> slackline.Call(
  SkillsSetAutoEnabled,
  SkillsSetAutoEnabledResponse,
)

admin.slackbot.skills.setAutoEnabled: Sets who a Slackbot skill is automatically turned on for.

slackbot.SkillsSetAutoEnabled identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/slackbot/skills_set_auto_enabled.

User token scopes: admin.skills:write.

Rate limit tier: t2.

Documented errors: audience_too_large, feature_not_enabled, invalid_permission_type, method_not_supported_for_skill_type, named_entities_cannot_be_empty, restricted_action, skill_not_found, skill_not_visible_to_audience, too_many_named_entities, usergroup_ids_not_allowed, usergroup_not_found.

skills_set_auto_enabled_response_decoder

</>

pub fn skills_set_auto_enabled_response_decoder() -> decode.Decoder(
  SkillsSetAutoEnabledResponse,
)

Decodes the response from admin.slackbot.skills.setAutoEnabled.

skills_unpublish

</>

pub fn skills_unpublish(
  skill_ids skill_ids: List(String),
) -> slackline.Call(SkillsUnpublish, Nil)

admin.slackbot.skills.unpublish: Removes Slackbot skills from the org catalog, preserving access, libraries, and deployments.

slackbot.SkillsUnpublish identifies this method in slackline.Call.

User token scopes: admin.skills:write.

Rate limit tier: t2.

Documented errors: failed_for_some_skills, feature_not_enabled, restricted_action.

slackbot_skill_decoder

</>

pub fn slackbot_skill_decoder() -> decode.Decoder(SlackbotSkill)

Decodes SlackbotSkill from json.

slackbot_skill_to_json

</>

pub fn slackbot_skill_to_json(it: SlackbotSkill) -> json.Json

Encodes SlackbotSkill as json.