slackline/api/migration

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

Slack Web API methods for migrating workspaces into an Enterprise organization.

Types

Identifies migration.exchange in the slackline.Call that exchange returns.

pub type Exchange

A successful response from migration.exchange.

pub type ExchangeResponse {
  ExchangeResponse(
    team_id: option.Option(String),
    enterprise_id: option.Option(String),
    user_id_map: option.Option(dict.Dict(String, String)),
    invalid_user_ids: option.Option(List(String)),
  )
}

Constructors

  • ExchangeResponse(
      team_id: option.Option(String),
      enterprise_id: option.Option(String),
      user_id_map: option.Option(dict.Dict(String, String)),
      invalid_user_ids: option.Option(List(String)),
    )

    Arguments

    team_id

    The workspace ID.

    enterprise_id

    The Enterprise organization ID.

    user_id_map

    Maps each requested ID to its global ID, or back to the local ID when to_old is set.

    invalid_user_ids

    Requested IDs that are invalid or do not belong to the workspace.

Values

pub fn exchange(
  users users: List(String),
) -> slackline.Call(Exchange, ExchangeResponse)

migration.exchange: For Enterprise organization workspaces, map local user IDs to global user IDs

migration.Exchange identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/migration/exchange.

Bot token scopes: tokens.basic. User token scopes: tokens.basic.

Rate limit tier: t2.

Documented errors: not_enterprise_team, too_many_users.

pub fn exchange_response_decoder() -> decode.Decoder(
  ExchangeResponse,
)

Decodes the response from migration.exchange.

✨ Search Document