conversations

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

Admin conversations: manage channels across an Enterprise organization.

Types

BulkActionFailure

A channel that could not be added to a bulk action.

pub type BulkActionFailure {
  BulkActionFailure(
    channel_id: String,
    error: option.Option(String),
  )
}

Constructors

BulkActionFailure(
  channel_id: String,
  error: option.Option(String),
)

Arguments

error: Why the channel was not added, such as invalid_channel.

BulkActionResponse

</>

The response from the admin.conversations.bulk* methods.

pub type BulkActionResponse {
  BulkActionResponse(
    bulk_action_id: option.Option(String),
    not_added: option.Option(List(BulkActionFailure)),
  )
}

Constructors

```
BulkActionResponse(
  bulk_action_id: option.Option(String),
  not_added: option.Option(List(BulkActionFailure)),
)
```
Arguments

bulk_action_id

The ID of the bulk action that was started.

not_added

Channels left out of the bulk action because they failed validation.

BulkArchive

</>

Identifies admin.conversations.bulkArchive in the slackline.Call that bulk_archive returns.

pub type BulkArchive

BulkDelete

</>

Identifies admin.conversations.bulkDelete in the slackline.Call that bulk_delete returns.

pub type BulkDelete

BulkMove

</>

Identifies admin.conversations.bulkMove in the slackline.Call that bulk_move returns.

pub type BulkMove

BulkSetExcludeFromSlackAi

</>

Identifies admin.conversations.bulkSetExcludeFromSlackAi in the slackline.Call that bulk_set_exclude_from_slack_ai returns.

pub type BulkSetExcludeFromSlackAi

BulkSetProperties

</>

Identifies admin.conversations.bulkSetProperties in the slackline.Call that bulk_set_properties returns.

pub type BulkSetProperties

ConversationPermission

</>

Who a conversation permission applies to.

pub type ConversationPermission {
  ConversationPermission(
    type_: option.Option(PrefValues),
    user: option.Option(PrefValues),
  )
}

Constructors

ConversationPermission(
  type_: option.Option(PrefValues),
  user: option.Option(PrefValues),
)

Arguments

type_: Kinds of users, such as admin, org_admin, regular or ra (everyone).
user: Specific user IDs.

ConversationPrefs

</>

Posting, threading, huddle and mention permissions for a channel.

pub type ConversationPrefs {
  ConversationPrefs(
    who_can_post: option.Option(ConversationPermission),
    can_thread: option.Option(ConversationPermission),
    can_huddle: option.Option(value.Value),
    enable_at_channel: option.Option(EnabledPref),
    enable_at_here: option.Option(EnabledPref),
  )
}

Constructors

ConversationPrefs(
  who_can_post: option.Option(ConversationPermission),
  can_thread: option.Option(ConversationPermission),
  can_huddle: option.Option(value.Value),
  enable_at_channel: option.Option(EnabledPref),
  enable_at_here: option.Option(EnabledPref),
)

Arguments

who_can_post: Who can post in the channel.
can_thread: Who can respond in threads.
can_huddle: Whether a huddle can start in the channel.
enable_at_channel: Whether @channel mentions can be used. Enabled when absent.
enable_at_here: Whether @here mentions can be used. Enabled when absent.

ConversationSearchSort

</>

How to sort conversation search results.

pub type ConversationSearchSort {
  Relevant
  SortByName
  MemberCount
  Created
}

Constructors

```
Relevant
```
relevant
```
SortByName
```
name
```
MemberCount
```
member_count
```
Created
```
created

ConvertToPrivate

</>

Identifies admin.conversations.convertToPrivate in the slackline.Call that convert_to_private returns.

pub type ConvertToPrivate

ConvertToPublic

</>

Identifies admin.conversations.convertToPublic in the slackline.Call that convert_to_public returns.

pub type ConvertToPublic

Create

</>

Identifies admin.conversations.create in the slackline.Call that create returns.

pub type Create

CreateForObjects

</>

Identifies admin.conversations.createForObjects in the slackline.Call that create_for_objects returns.

pub type CreateForObjects

CreatedChannel

</>

The response from methods that create a channel.

pub type CreatedChannel {
  CreatedChannel(channel_id: String)
}

Constructors

```
CreatedChannel(channel_id: String)
```
Arguments

channel_id

The ID of the new channel.

Delete

</>

Identifies admin.conversations.delete in the slackline.Call that delete returns.

pub type Delete

DisconnectShared

</>

Identifies admin.conversations.disconnectShared in the slackline.Call that disconnect_shared returns.

pub type DisconnectShared

EkmChannelInfo

</>

A read-only (frozen) channel and the original channel used for its EKM keys.

pub type EkmChannelInfo {
  EkmChannelInfo(
    id: String,
    internal_team_ids: option.Option(EkmInternalTeamIds),
    original_connected_host_id: option.Option(String),
    original_connected_channel_id: option.Option(String),
  )
}

Constructors

EkmChannelInfo(
  id: String,
  internal_team_ids: option.Option(EkmInternalTeamIds),
  original_connected_host_id: option.Option(String),
  original_connected_channel_id: option.Option(String),
)

EkmInternalTeamIds

</>

internal_team_ids of a frozen channel: a list, or a placeholder string.

pub type EkmInternalTeamIds {
  EkmInternalTeamIdList(List(String))
  EkmInternalTeamIdsOther(value.Value)
}

Constructors

```
EkmInternalTeamIdList(List(String))
```
```
EkmInternalTeamIdsOther(value.Value)
```

EkmListOriginalConnectedChannelInfo

</>

Identifies admin.conversations.ekm.listOriginalConnectedChannelInfo in the slackline.Call that ekm_list_original_connected_channel_info returns.

pub type EkmListOriginalConnectedChannelInfo

EkmListOriginalConnectedChannelInfoResponse

</>

A successful response from admin.conversations.ekm.listOriginalConnectedChannelInfo.

pub type EkmListOriginalConnectedChannelInfoResponse {
  EkmListOriginalConnectedChannelInfoResponse(
    channels: option.Option(List(EkmChannelInfo)),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

EkmListOriginalConnectedChannelInfoResponse(
  channels: option.Option(List(EkmChannelInfo)),
  response_metadata: option.Option(slackline.ResponseMetadata),
)

EnabledPref

</>

A pref that is either enabled or not.

pub type EnabledPref {
  EnabledPref(enabled: option.Option(Bool))
}

Constructors

EnabledPref(enabled: option.Option(Bool))

GetConversationPrefs

</>

Identifies admin.conversations.getConversationPrefs in the slackline.Call that get_conversation_prefs returns.

pub type GetConversationPrefs

GetConversationPrefsResponse

</>

A successful response from admin.conversations.getConversationPrefs.

pub type GetConversationPrefsResponse {
  GetConversationPrefsResponse(
    prefs: option.Option(ConversationPrefs),
  )
}

Constructors

GetConversationPrefsResponse(
  prefs: option.Option(ConversationPrefs),
)

GetCustomRetention

</>

Identifies admin.conversations.getCustomRetention in the slackline.Call that get_custom_retention returns.

pub type GetCustomRetention

GetCustomRetentionResponse

</>

A successful response from admin.conversations.getCustomRetention.

pub type GetCustomRetentionResponse {
  GetCustomRetentionResponse(
    is_policy_enabled: option.Option(Bool),
    duration_days: option.Option(Int),
  )
}

Constructors

```
GetCustomRetentionResponse(
  is_policy_enabled: option.Option(Bool),
  duration_days: option.Option(Int),
)
```
Arguments

is_policy_enabled

Whether a custom retention policy is enabled for the conversation.

duration_days

The message retention duration in days.

GetTeams

</>

Identifies admin.conversations.getTeams in the slackline.Call that get_teams returns.

pub type GetTeams

GetTeamsResponse

</>

A successful response from admin.conversations.getTeams.

pub type GetTeamsResponse {
  GetTeamsResponse(
    team_ids: option.Option(List(String)),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

GetTeamsResponse(
  team_ids: option.Option(List(String)),
  response_metadata: option.Option(slackline.ResponseMetadata),
)

Invite

</>

Identifies admin.conversations.invite in the slackline.Call that invite returns.

pub type Invite

Kick

</>

Identifies admin.conversations.kick in the slackline.Call that kick returns.

pub type Kick

KickResponse

</>

A successful response from admin.conversations.kick.

pub type KickResponse {
  KickResponse(
    removed_user_ids: option.Option(List(String)),
    failed_user_ids: option.Option(List(KickFailure)),
    warning: option.Option(String),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

KickResponse(
  removed_user_ids: option.Option(List(String)),
  failed_user_ids: option.Option(List(KickFailure)),
  warning: option.Option(String),
  response_metadata: option.Option(slackline.ResponseMetadata),
)

Arguments

warning: failed_for_some_users when some users could not be removed.

LinkObjects

</>

Identifies admin.conversations.linkObjects in the slackline.Call that link_objects returns.

pub type LinkObjects

Lookup

</>

Identifies admin.conversations.lookup in the slackline.Call that lookup returns.

pub type Lookup

LookupResponse

</>

A successful response from admin.conversations.lookup.

pub type LookupResponse {
  LookupResponse(
    channels: option.Option(List(String)),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

LookupResponse(
  channels: option.Option(List(String)),
  response_metadata: option.Option(slackline.ResponseMetadata),
)

Arguments

channels: IDs of the matching channels.

PrefValues

</>

A string Slack sends either as one comma separated string or as a list.

pub type PrefValues {
  PrefValueList(List(String))
  PrefValueString(String)
}

Constructors

```
PrefValueList(List(String))
```
```
PrefValueString(String)
```

RemoveCustomRetention

</>

Identifies admin.conversations.removeCustomRetention in the slackline.Call that remove_custom_retention returns.

pub type RemoveCustomRetention

Rename

</>

Identifies admin.conversations.rename in the slackline.Call that rename returns.

pub type Rename

RestrictAccessAddGroup

</>

Identifies admin.conversations.restrictAccess.addGroup in the slackline.Call that restrict_access_add_group returns.

pub type RestrictAccessAddGroup

RestrictAccessListGroups

</>

Identifies admin.conversations.restrictAccess.listGroups in the slackline.Call that restrict_access_list_groups returns.

pub type RestrictAccessListGroups

RestrictAccessListGroupsResponse

</>

A successful response from admin.conversations.restrictAccess.listGroups.

pub type RestrictAccessListGroupsResponse {
  RestrictAccessListGroupsResponse(
    group_ids: option.Option(List(String)),
  )
}

Constructors

RestrictAccessListGroupsResponse(
  group_ids: option.Option(List(String)),
)

Arguments

group_ids: IDP groups allowed to access the private channel.

RestrictAccessRemoveGroup

</>

Identifies admin.conversations.restrictAccess.removeGroup in the slackline.Call that restrict_access_remove_group returns.

pub type RestrictAccessRemoveGroup

Search

</>

Identifies admin.conversations.search in the slackline.Call that search returns.

pub type Search

SearchResponse

</>

A successful response from admin.conversations.search.

pub type SearchResponse {
  SearchResponse(
    conversations: option.Option(List(SearchedConversation)),
    next_cursor: option.Option(String),
    total_count: option.Option(Int),
  )
}

Constructors

SearchResponse(
  conversations: option.Option(List(SearchedConversation)),
  next_cursor: option.Option(String),
  total_count: option.Option(Int),
)

Arguments

next_cursor: Pass as cursor to get the next page. Empty or absent on the last page.
total_count: Total number of matching channels.

SearchedConversation

</>

A channel from admin.conversations.search.

pub type SearchedConversation {
  SearchedConversation(
    id: String,
    name: option.Option(String),
    purpose: option.Option(String),
    member_count: option.Option(Int),
    created: option.Option(Int),
    creator_id: option.Option(String),
    is_private: option.Option(Bool),
    is_archived: option.Option(Bool),
    is_general: option.Option(Bool),
    last_activity_ts: option.Option(Int),
    is_ext_shared: option.Option(Bool),
    is_global_shared: option.Option(Bool),
    is_org_default: option.Option(Bool),
    is_org_mandatory: option.Option(Bool),
    is_org_shared: option.Option(Bool),
    is_frozen: option.Option(Bool),
    connected_team_ids: option.Option(List(String)),
    internal_team_ids_count: option.Option(Int),
    internal_team_ids_sample_team: option.Option(String),
    pending_connected_team_ids: option.Option(List(String)),
    is_pending_ext_shared: option.Option(Bool),
  )
}

Constructors

SearchedConversation(
  id: String,
  name: option.Option(String),
  purpose: option.Option(String),
  member_count: option.Option(Int),
  created: option.Option(Int),
  creator_id: option.Option(String),
  is_private: option.Option(Bool),
  is_archived: option.Option(Bool),
  is_general: option.Option(Bool),
  last_activity_ts: option.Option(Int),
  is_ext_shared: option.Option(Bool),
  is_global_shared: option.Option(Bool),
  is_org_default: option.Option(Bool),
  is_org_mandatory: option.Option(Bool),
  is_org_shared: option.Option(Bool),
  is_frozen: option.Option(Bool),
  connected_team_ids: option.Option(List(String)),
  internal_team_ids_count: option.Option(Int),
  internal_team_ids_sample_team: option.Option(String),
  pending_connected_team_ids: option.Option(List(String)),
  is_pending_ext_shared: option.Option(Bool),
)

Arguments

member_count: -1 when the channel is archived.
last_activity_ts: Time of the last activity, in microseconds.

SetConversationPrefs

</>

Identifies admin.conversations.setConversationPrefs in the slackline.Call that set_conversation_prefs returns.

pub type SetConversationPrefs

SetCustomRetention

</>

Identifies admin.conversations.setCustomRetention in the slackline.Call that set_custom_retention returns.

pub type SetCustomRetention

SetTeams

</>

Identifies admin.conversations.setTeams in the slackline.Call that set_teams returns.

pub type SetTeams

Unarchive

</>

Identifies admin.conversations.unarchive in the slackline.Call that unarchive returns.

pub type Unarchive

UnlinkObjects

</>

Identifies admin.conversations.unlinkObjects in the slackline.Call that unlink_objects returns.

pub type UnlinkObjects

Values

bulk_archive

</>

pub fn bulk_archive(
  channel_ids channel_ids: List(String),
) -> slackline.Call(BulkArchive, BulkActionResponse)

admin.conversations.bulkArchive: Archive public or private channels in bulk.

conversations.BulkArchive identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: action_already_in_progress, invalid_enterprise, no_valid_channels, restricted_action, team_not_found.

bulk_delete

</>

pub fn bulk_delete(
  channel_ids channel_ids: List(String),
) -> slackline.Call(BulkDelete, BulkActionResponse)

admin.conversations.bulkDelete: Delete public or private channels in bulk

conversations.BulkDelete identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: action_already_in_progress, no_valid_channels, restricted_action.

bulk_move

</>

pub fn bulk_move(
  target_team_id target_team_id: String,
  channel_ids channel_ids: List(String),
) -> slackline.Call(BulkMove, BulkActionResponse)

admin.conversations.bulkMove: Move public or private channels in bulk.

conversations.BulkMove identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: action_already_in_progress, no_valid_channels, restricted_action, target_team_not_found, team_not_found.

bulk_set_exclude_from_slack_ai

</>

pub fn bulk_set_exclude_from_slack_ai(
  channel_ids channel_ids: List(String),
  exclude exclude: Bool,
) -> slackline.Call(BulkSetExcludeFromSlackAi, BulkActionResponse)

admin.conversations.bulkSetExcludeFromSlackAi: Exclude channels from Slack AI in bulk

conversations.BulkSetExcludeFromSlackAi identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: action_already_in_progress, disallowed_action, feature_not_enabled, no_valid_channels, restricted_action.

bulk_set_properties

</>

pub fn bulk_set_properties(
  channel_ids channel_ids: List(String),
  property property: value.Value,
) -> slackline.Call(BulkSetProperties, BulkActionResponse)

admin.conversations.bulkSetProperties: Set properties on channels in bulk

conversations.BulkSetProperties identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: action_already_in_progress, disallowed_action, feature_not_enabled, no_valid_channels, property_not_allowed, restricted_action, restricted_plan_level, too_many_properties.

conversation_permission_decoder

</>

pub fn conversation_permission_decoder() -> decode.Decoder(
  ConversationPermission,
)

Decodes ConversationPermission from json.

conversation_permission_to_json

</>

pub fn conversation_permission_to_json(
  it: ConversationPermission,
) -> json.Json

Encodes ConversationPermission as json.

conversation_prefs_decoder

</>

pub fn conversation_prefs_decoder() -> decode.Decoder(
  ConversationPrefs,
)

Decodes ConversationPrefs from json.

conversation_prefs_to_json

</>

pub fn conversation_prefs_to_json(
  it: ConversationPrefs,
) -> json.Json

Encodes ConversationPrefs as json.

conversation_search_sort_decoder

</>

pub fn conversation_search_sort_decoder() -> decode.Decoder(
  ConversationSearchSort,
)

Decodes ConversationSearchSort from a json string.

conversation_search_sort_from_string

</>

pub fn conversation_search_sort_from_string(
  string: String,
) -> Result(ConversationSearchSort, Nil)

Parses ConversationSearchSort from its json string.

conversation_search_sort_to_json

</>

pub fn conversation_search_sort_to_json(
  it: ConversationSearchSort,
) -> json.Json

Encodes ConversationSearchSort as a json string.

conversation_search_sort_to_string

</>

pub fn conversation_search_sort_to_string(
  it: ConversationSearchSort,
) -> String

The json string of ConversationSearchSort.

convert_to_private

</>

pub fn convert_to_private(
  channel_id channel_id: String,
) -> slackline.Call(ConvertToPrivate, Nil)

admin.conversations.convertToPrivate: Convert a public channel to a private channel.

conversations.ConvertToPrivate identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/conversations/convert_to_private.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: channel_not_found, channel_type_not_supported, could_not_convert_channel, default_org_wide_channel, external_channel_migrating, feature_not_enabled, method_not_supported_for_channel_type, name_taken, restricted_action.

convert_to_public

</>

pub fn convert_to_public(
  channel_id channel_id: String,
) -> slackline.Call(ConvertToPublic, Nil)

admin.conversations.convertToPublic: Convert a private channel to a public channel.

conversations.ConvertToPublic identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: channel_not_found, channel_owner_restriction, could_not_convert_channel, external_limited_restriction, feature_not_enabled, invalid_user, is_idp_managed, not_an_enterprise, not_supported, restricted_action.

create

</>

pub fn create(
  name name: String,
  is_private is_private: Bool,
) -> slackline.Call(Create, CreatedChannel)

admin.conversations.create: Create a public or private channel-based conversation.

conversations.Create identifies this method in slackline.Call.

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

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: could_not_create_channel, feature_not_enabled, invalid_name, invalid_team, name_taken, no_local_user_on_team, restricted_action, team_id_or_org_required, team_not_found.

create_for_objects

</>

pub fn create_for_objects(
  object_id object_id: String,
  salesforce_org_id salesforce_org_id: String,
) -> slackline.Call(CreateForObjects, CreatedChannel)

admin.conversations.createForObjects: Create a Salesforce channel for the corresponding object provided.

conversations.CreateForObjects identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/conversations/create_for_objects.

User token scopes: admin.conversations:manage_objects.

Rate limit tier: t2.

Documented errors: channel_already_exists, feature_not_enabled, missing_record_channel_config, record_not_found, restricted_action.

created_channel_decoder

</>

pub fn created_channel_decoder() -> decode.Decoder(CreatedChannel)

Decodes CreatedChannel from json.

created_channel_to_json

</>

pub fn created_channel_to_json(it: CreatedChannel) -> json.Json

Encodes CreatedChannel as json.

delete

</>

pub fn delete(
  channel_id channel_id: String,
) -> slackline.Call(Delete, Nil)

admin.conversations.delete: Delete a public or private channel.

conversations.Delete identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: channel_not_found, channel_type_not_supported, could_not_delete_channel, default_org_wide_channel, feature_not_enabled, not_an_admin, restricted_action.

disconnect_shared

</>

pub fn disconnect_shared(
  channel_id channel_id: String,
) -> slackline.Call(DisconnectShared, Nil)

admin.conversations.disconnectShared: Disconnect a connected channel from one or more workspaces.

conversations.DisconnectShared identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/conversations/disconnect_shared.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: cannot_kick_home_team, cannot_kick_team, channel_not_found, channel_type_not_supported, default_org_wide_channel, external_channel_migrating, feature_not_enabled, leaving_team_not_in_channel, leaving_team_required, no_teams_to_disconnect, not_an_admin, not_an_enterprise, not_supported, restricted_action, team_not_found.

ekm_channel_info_decoder

</>

pub fn ekm_channel_info_decoder() -> decode.Decoder(
  EkmChannelInfo,
)

Decodes EkmChannelInfo from json.

ekm_channel_info_to_json

</>

pub fn ekm_channel_info_to_json(it: EkmChannelInfo) -> json.Json

Encodes EkmChannelInfo as json.

ekm_internal_team_ids_decoder

</>

pub fn ekm_internal_team_ids_decoder() -> decode.Decoder(
  EkmInternalTeamIds,
)

Decodes EkmInternalTeamIds from json. It tries each alternative in order.

ekm_internal_team_ids_to_json

</>

pub fn ekm_internal_team_ids_to_json(
  it: EkmInternalTeamIds,
) -> json.Json

Encodes EkmInternalTeamIds as json.

ekm_list_original_connected_channel_info

</>

pub fn ekm_list_original_connected_channel_info() -> slackline.Call(
  EkmListOriginalConnectedChannelInfo,
  EkmListOriginalConnectedChannelInfoResponse,
)

admin.conversations.ekm.listOriginalConnectedChannelInfo: List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM.

conversations.EkmListOriginalConnectedChannelInfo identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/conversations/ekm_list_original_connected_channel_info.

User token scopes: admin.conversations:read.

Rate limit tier: t2.

Documented errors: invalid_cursor, invalid_limit, not_an_admin, not_enabled, restricted_action, unsupported_arguments.

ekm_list_original_connected_channel_info_response_decoder

</>

pub fn ekm_list_original_connected_channel_info_response_decoder() -> decode.Decoder(
  EkmListOriginalConnectedChannelInfoResponse,
)

Decodes the response from admin.conversations.ekm.listOriginalConnectedChannelInfo.

enabled_pref_decoder

</>

pub fn enabled_pref_decoder() -> decode.Decoder(EnabledPref)

Decodes EnabledPref from json.

enabled_pref_to_json

</>

pub fn enabled_pref_to_json(it: EnabledPref) -> json.Json

Encodes EnabledPref as json.

get_conversation_prefs

</>

pub fn get_conversation_prefs(
  channel_id channel_id: String,
) -> slackline.Call(
  GetConversationPrefs,
  GetConversationPrefsResponse,
)

admin.conversations.getConversationPrefs: Get conversation preferences for a public or private channel.

conversations.GetConversationPrefs identifies this method in slackline.Call.

User token scopes: admin.conversations:read.

Rate limit tier: t2.

Documented errors: channel_not_found, channel_type_not_supported, could_not_get_conversation_prefs, feature_not_enabled, not_an_admin, not_an_enterprise, restricted_action, target_team_not_on_org.

get_conversation_prefs_response_decoder

</>

pub fn get_conversation_prefs_response_decoder() -> decode.Decoder(
  GetConversationPrefsResponse,
)

Decodes the response from admin.conversations.getConversationPrefs.

get_custom_retention

</>

pub fn get_custom_retention(
  channel_id channel_id: String,
) -> slackline.Call(
  GetCustomRetention,
  GetCustomRetentionResponse,
)

admin.conversations.getCustomRetention: This API endpoint can be used by any admin to get a conversation’s retention policy.

conversations.GetCustomRetention identifies this method in slackline.Call.

User token scopes: admin.conversations:read.

Rate limit tier: t2.

Documented errors: channel_not_found, channel_type_not_supported, could_not_get_retention, default_org_wide_channel, external_channel_migrating, feature_not_enabled, not_an_admin, not_supported, restricted_action, retention_override_not_allowed.

get_custom_retention_response_decoder

</>

pub fn get_custom_retention_response_decoder() -> decode.Decoder(
  GetCustomRetentionResponse,
)

Decodes the response from admin.conversations.getCustomRetention.

get_teams

</>

pub fn get_teams(
  channel_id channel_id: String,
) -> slackline.Call(GetTeams, GetTeamsResponse)

admin.conversations.getTeams: Get all the workspaces a given public or private channel is connected to within this Enterprise org.

conversations.GetTeams identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/conversations/get_teams.

User token scopes: admin.conversations:read.

Rate limit tier: t3.

Documented errors: channel_not_found, channel_type_not_supported, could_not_get_teams, default_org_wide_channel, external_channel_migrating, feature_not_enabled, invalid_cursor, invalid_limit, not_supported, restricted_action, target_team_not_on_org, unsupported_team_type.

get_teams_response_decoder

</>

pub fn get_teams_response_decoder() -> decode.Decoder(
  GetTeamsResponse,
)

Decodes the response from admin.conversations.getTeams.

invite

</>

pub fn invite(
  user_ids user_ids: List(String),
  channel_id channel_id: String,
) -> slackline.Call(Invite, Nil)

admin.conversations.invite: Invite a user to a public or private channel.

conversations.Invite identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: channel_not_found, channel_type_not_supported, default_org_wide_channel, failed_for_some_users, feature_not_enabled, restricted_action, user_must_be_admin.

kick

</>

pub fn kick(
  channel_id channel_id: String,
  user_ids user_ids: List(String),
) -> slackline.Call(Kick, KickResponse)

admin.conversations.kick: Remove multiple users from a conversation. Admin version of conversations.kick with support for bulk user removal.

conversations.Kick identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: channel_not_found, channel_type_not_supported, external_channel_migrating, failed_for_all_users, not_supported, permission_denied, restricted_action, too_many_users.

kick_failure_decoder

</>

pub fn kick_failure_decoder() -> decode.Decoder(KickFailure)

Decodes KickFailure from json.

kick_failure_to_json

</>

pub fn kick_failure_to_json(it: KickFailure) -> json.Json

Encodes KickFailure as json.

kick_response_decoder

</>

pub fn kick_response_decoder() -> decode.Decoder(KickResponse)

Decodes the response from admin.conversations.kick.

link_objects

</>

pub fn link_objects(
  channel channel: String,
  record_id record_id: String,
  salesforce_org_id salesforce_org_id: String,
) -> slackline.Call(LinkObjects, Nil)

admin.conversations.linkObjects: Link a Salesforce record to a channel

conversations.LinkObjects identifies this method in slackline.Call.

User token scopes: admin.conversations:manage_objects.

Rate limit tier: t2.

Documented errors: channel_already_exists, channel_conversion_incomplete, channel_is_archived, channel_not_found, channel_not_org_wide_shared, channel_shared_with_nonapproved_team, config_not_found, invalid_channel_type, name_taken, not_allowed_for_grid_workspace, record_channel_already_exists, record_channel_cannot_be_externally_shared, record_not_found, restricted_action.

lookup

</>

pub fn lookup(
  team_ids team_ids: List(String),
  last_message_activity_before last_message_activity_before: Int,
) -> slackline.Call(Lookup, LookupResponse)

admin.conversations.lookup: Returns channels on the given team using the filters.

conversations.Lookup identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/conversations/lookup.

User token scopes: admin.conversations:read.

Rate limit tier: t2.

Documented errors: feature_not_enabled, invalid_cursor, no_valid_teams.

lookup_response_decoder

</>

pub fn lookup_response_decoder() -> decode.Decoder(LookupResponse)

Decodes the response from admin.conversations.lookup.

pref_values_decoder

</>

pub fn pref_values_decoder() -> decode.Decoder(PrefValues)

Decodes PrefValues from json. It tries each alternative in order.

pref_values_to_json

</>

pub fn pref_values_to_json(it: PrefValues) -> json.Json

Encodes PrefValues as json.

remove_custom_retention

</>

pub fn remove_custom_retention(
  channel_id channel_id: String,
) -> slackline.Call(RemoveCustomRetention, Nil)

admin.conversations.removeCustomRetention: This API endpoint can be used by any admin to remove a conversation’s retention policy.

conversations.RemoveCustomRetention identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: channel_not_found, channel_type_not_supported, could_not_remove_retention, default_org_wide_channel, external_channel_migrating, feature_not_enabled, not_an_admin, not_supported, restricted_action, retention_override_not_allowed.

rename

</>

pub fn rename(
  channel_id channel_id: String,
  name name: String,
) -> slackline.Call(Rename, Nil)

admin.conversations.rename: Rename a public or private channel.

conversations.Rename identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: channel_not_found, channel_type_not_supported, could_not_rename_channel, default_org_wide_channel, external_channel_migrating, feature_not_enabled, invalid_name_maxlength, name_taken, not_supported, restricted_action.

restrict_access_add_group

</>

pub fn restrict_access_add_group(
  group_id group_id: String,
  channel_id channel_id: String,
) -> slackline.Call(RestrictAccessAddGroup, Nil)

admin.conversations.restrictAccess.addGroup: Add an allowlist of IDP groups for accessing a channel

conversations.RestrictAccessAddGroup identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/conversations/restrict_access_add_group.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: cannot_add_more_channels_to_group, cannot_add_more_groups_to_channel, channel_is_not_private, channel_not_found, default_channel_restricted, feature_not_enabled, group_already_linked_to_channel, group_must_not_be_empty, group_not_found, invalid_channel, invalid_channel_type, no_channel_memberships, not_an_admin, team_not_found, unable_to_link_idp_group_and_channel.

restrict_access_list_groups

</>

pub fn restrict_access_list_groups(
  channel_id channel_id: String,
) -> slackline.Call(
  RestrictAccessListGroups,
  RestrictAccessListGroupsResponse,
)

admin.conversations.restrictAccess.listGroups: List all IDP Groups linked to a channel

conversations.RestrictAccessListGroups identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/conversations/restrict_access_list_groups.

User token scopes: admin.conversations:read.

Rate limit tier: t2.

Documented errors: channel_not_found, feature_not_enabled, invalid_channel, not_an_admin, team_not_found.

restrict_access_list_groups_response_decoder

</>

pub fn restrict_access_list_groups_response_decoder() -> decode.Decoder(
  RestrictAccessListGroupsResponse,
)

Decodes the response from admin.conversations.restrictAccess.listGroups.

restrict_access_remove_group

</>

pub fn restrict_access_remove_group(
  group_id group_id: String,
  channel_id channel_id: String,
) -> slackline.Call(RestrictAccessRemoveGroup, Nil)

admin.conversations.restrictAccess.removeGroup: Remove a linked IDP group linked from a private channel

conversations.RestrictAccessRemoveGroup identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/conversations/restrict_access_remove_group.

User token scopes: admin.conversations:write.

Rate limit tier: t1.

Documented errors: channel_not_found, failed_to_remove_group_users, failed_to_unlink_channel, feature_not_enabled, group_not_found, invalid_channel, link_not_found, not_an_admin, team_not_found, unable_to_unlink_idp_group_and_channel.

search

</>

pub fn search() -> slackline.Call(Search, SearchResponse)

admin.conversations.search: Search for public or private channels in an Enterprise organization.

conversations.Search identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/conversations/search.

User token scopes: admin.conversations:read.

Rate limit tier: t2.

Documented errors: connected_team_passed_in_is_not_top_level_team, external_team_not_connected_to_this_org, feature_not_enabled, invalid_cursor, invalid_search_channel_type, invalid_sort, invalid_sort_dir, not_allowed, not_an_admin, not_an_enterprise, target_team_not_on_org, team_not_found.

search_next_page

</>

pub fn search_next_page(
  call: slackline.Call(Search, SearchResponse),
  response: SearchResponse,
) -> option.Option(slackline.Call(Search, SearchResponse))

The call for the page after response, or None when it was the last page. admin.conversations.search returns its cursor at the top level as next_cursor rather than inside response_metadata, so slackline.next_page does not apply.

search_response_decoder

</>

pub fn search_response_decoder() -> decode.Decoder(SearchResponse)

Decodes the response from admin.conversations.search.

searched_conversation_decoder

</>

pub fn searched_conversation_decoder() -> decode.Decoder(
  SearchedConversation,
)

Decodes SearchedConversation from json.

searched_conversation_to_json

</>

pub fn searched_conversation_to_json(
  it: SearchedConversation,
) -> json.Json

Encodes SearchedConversation as json.

set_conversation_prefs

</>

pub fn set_conversation_prefs(
  channel_id channel_id: String,
  prefs prefs: String,
) -> slackline.Call(SetConversationPrefs, Nil)

admin.conversations.setConversationPrefs: Set the posting permissions for a public or private channel.

conversations.SetConversationPrefs identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t3.

Documented errors: channel_mention_sync_required, channel_not_found, channel_type_not_supported, could_not_set_channel_pref, default_org_wide_channel, feature_not_enabled, invalid_value, not_an_admin, restricted_action.

set_custom_retention

</>

pub fn set_custom_retention(
  channel_id channel_id: String,
  duration_days duration_days: Int,
) -> slackline.Call(SetCustomRetention, Nil)

admin.conversations.setCustomRetention: This API endpoint can be used by any admin to set a conversation’s retention policy.

conversations.SetCustomRetention identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: channel_not_found, channel_type_not_supported, could_not_set_retention, default_org_wide_channel, external_channel_migrating, feature_not_enabled, invalid_duration, not_an_admin, not_supported, restricted_action, retention_override_not_allowed.

set_teams

</>

pub fn set_teams(
  channel_id channel_id: String,
) -> slackline.Call(SetTeams, Nil)

admin.conversations.setTeams: Set the workspaces in an Enterprise org that connect to a public or private channel.

conversations.SetTeams identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/conversations/set_teams.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: cannot_add_legacy_disconnected_channel_to_workspaces, cannot_move_local_channel, channel_cannot_be_unshared, channel_not_found, channel_type_not_supported, could_not_set_teams_for_channel, default_org_wide_channel, externally_shared_or_disconnected_channel, insufficient_permissions_to_share_channel, invalid_channel_id, invalid_target_team, managed_channel_not_supported, name_taken, not_allowed_for_grid_workspace, not_enabled, restricted_action, too_many_target_teams, unsupported_arguments.

unarchive

</>

pub fn unarchive(
  channel_id channel_id: String,
) -> slackline.Call(Unarchive, Nil)

admin.conversations.unarchive: Unarchive a public or private channel.

conversations.Unarchive identifies this method in slackline.Call.

User token scopes: admin.conversations:write.

Rate limit tier: t2.

Documented errors: channel_not_archived, channel_not_found, channel_type_not_supported, could_not_unarchive_channel, default_org_wide_channel, feature_not_enabled, restricted_action, target_team_not_on_org.

unlink_objects

</>

pub fn unlink_objects(
  channel channel: String,
  new_name new_name: String,
) -> slackline.Call(UnlinkObjects, Nil)

admin.conversations.unlinkObjects: Unlink a Salesforce record from a channel

conversations.UnlinkObjects identifies this method in slackline.Call.

User token scopes: admin.conversations:manage_objects.

Rate limit tier: t2.

Documented errors: channel_not_found, invalid_name_specials, name_taken, restricted_action.