slackline/api/apps

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

Apps: activity logs, external auth, datastores, manifests, Socket Mode and installation management.

Types

Identifies apps.activities.list in the slackline.Call that activities_list returns.

pub type ActivitiesList

A successful response from apps.activities.list.

pub type ActivitiesListResponse {
  ActivitiesListResponse(
    activities: option.Option(List(common.AppActivity)),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

Credentials for an app created from a manifest.

pub type AppCredentials {
  AppCredentials(
    client_id: option.Option(String),
    client_secret: option.Option(String),
    verification_token: option.Option(String),
    signing_secret: option.Option(String),
  )
}

Constructors

Identifies apps.auth.external.delete in the slackline.Call that auth_external_delete returns.

pub type AuthExternalDelete

Identifies apps.auth.external.get in the slackline.Call that auth_external_get returns.

pub type AuthExternalGet

A successful response from apps.auth.external.get.

pub type AuthExternalGetResponse {
  AuthExternalGetResponse(external_token: String)
}

Constructors

  • AuthExternalGetResponse(external_token: String)

    Arguments

    external_token

    The external access token.

Identifies apps.connections.open in the slackline.Call that connections_open returns.

pub type ConnectionsOpen

A successful response from apps.connections.open.

pub type ConnectionsOpenResponse {
  ConnectionsOpenResponse(url: String)
}

Constructors

  • ConnectionsOpenResponse(url: String)

    Arguments

    url

    WebSocket URL to connect to for Socket Mode.

Identifies apps.datastore.bulkDelete in the slackline.Call that datastore_bulk_delete returns.

pub type DatastoreBulkDelete

A successful response from apps.datastore.bulkDelete.

pub type DatastoreBulkDeleteResponse {
  DatastoreBulkDeleteResponse(
    failed_items: option.Option(List(value.Value)),
  )
}

Constructors

  • DatastoreBulkDeleteResponse(
      failed_items: option.Option(List(value.Value)),
    )

    Arguments

    failed_items

    Items that could not be deleted.

Identifies apps.datastore.bulkGet in the slackline.Call that datastore_bulk_get returns.

pub type DatastoreBulkGet

A successful response from apps.datastore.bulkGet.

pub type DatastoreBulkGetResponse {
  DatastoreBulkGetResponse(
    datastore: option.Option(String),
    items: option.Option(List(dict.Dict(String, value.Value))),
    failed_items: option.Option(List(value.Value)),
  )
}

Constructors

Identifies apps.datastore.bulkPut in the slackline.Call that datastore_bulk_put returns.

pub type DatastoreBulkPut

A successful response from apps.datastore.bulkPut.

pub type DatastoreBulkPutResponse {
  DatastoreBulkPutResponse(
    datastore: option.Option(String),
    failed_items: option.Option(List(value.Value)),
  )
}

Constructors

Identifies apps.datastore.count in the slackline.Call that datastore_count returns.

pub type DatastoreCount

A successful response from apps.datastore.count.

pub type DatastoreCountResponse {
  DatastoreCountResponse(
    datastore: option.Option(String),
    count: option.Option(Int),
  )
}

Constructors

  • DatastoreCountResponse(
      datastore: option.Option(String),
      count: option.Option(Int),
    )

    Arguments

    count

    Number of items matching the expression.

Identifies apps.datastore.delete in the slackline.Call that datastore_delete returns.

pub type DatastoreDelete

Identifies apps.datastore.get in the slackline.Call that datastore_get returns.

pub type DatastoreGet

A successful response from apps.datastore.get.

pub type DatastoreGetResponse {
  DatastoreGetResponse(
    datastore: option.Option(String),
    item: option.Option(dict.Dict(String, value.Value)),
  )
}

Constructors

Identifies apps.datastore.put in the slackline.Call that datastore_put returns.

pub type DatastorePut

A successful response from apps.datastore.put.

pub type DatastorePutResponse {
  DatastorePutResponse(
    datastore: option.Option(String),
    item: option.Option(dict.Dict(String, value.Value)),
  )
}

Constructors

Identifies apps.datastore.query in the slackline.Call that datastore_query returns.

pub type DatastoreQuery

A successful response from apps.datastore.query.

pub type DatastoreQueryResponse {
  DatastoreQueryResponse(
    datastore: option.Option(String),
    items: option.Option(List(dict.Dict(String, value.Value))),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

Identifies apps.datastore.update in the slackline.Call that datastore_update returns.

pub type DatastoreUpdate

A successful response from apps.datastore.update.

pub type DatastoreUpdateResponse {
  DatastoreUpdateResponse(
    datastore: option.Option(String),
    item: option.Option(dict.Dict(String, value.Value)),
  )
}

Constructors

An installation of the app an event is visible to.

pub type EventAuthorization {
  EventAuthorization(
    enterprise_id: option.Option(String),
    team_id: option.Option(String),
    user_id: option.Option(String),
    is_bot: option.Option(value.Value),
  )
}

Constructors

Identifies apps.event.authorizations.list in the slackline.Call that event_authorizations_list returns.

pub type EventAuthorizationsList

A successful response from apps.event.authorizations.list.

pub type EventAuthorizationsListResponse {
  EventAuthorizationsListResponse(
    authorizations: option.Option(List(EventAuthorization)),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

Identifies apps.icon.set in the slackline.Call that icon_set returns.

pub type IconSet

Identifies apps.managed.permissions.set in the slackline.Call that managed_permissions_set returns.

pub type ManagedPermissionsSet

Identifies apps.manifest.create in the slackline.Call that manifest_create returns.

pub type ManifestCreate

A successful response from apps.manifest.create.

pub type ManifestCreateResponse {
  ManifestCreateResponse(
    app_id: String,
    credentials: option.Option(AppCredentials),
    oauth_authorize_url: option.Option(String),
  )
}

Constructors

  • ManifestCreateResponse(
      app_id: String,
      credentials: option.Option(AppCredentials),
      oauth_authorize_url: option.Option(String),
    )

    Arguments

    credentials

    Credentials of the new app.

    oauth_authorize_url

    URL to install the app.

Identifies apps.manifest.delete in the slackline.Call that manifest_delete returns.

pub type ManifestDelete

A problem found in a manifest.

pub type ManifestError {
  ManifestError(
    message: option.Option(String),
    pointer: option.Option(String),
  )
}

Constructors

  • ManifestError(
      message: option.Option(String),
      pointer: option.Option(String),
    )

    Arguments

    message

    Description of the problem.

    pointer

    JSON pointer to the problem’s location in the manifest.

Identifies apps.manifest.export in the slackline.Call that manifest_export returns.

pub type ManifestExport

A successful response from apps.manifest.export.

pub type ManifestExportResponse {
  ManifestExportResponse(manifest: value.Value)
}

Constructors

  • ManifestExportResponse(manifest: value.Value)

    Arguments

    manifest

    The app’s configuration as a manifest.

Identifies apps.manifest.update in the slackline.Call that manifest_update returns.

pub type ManifestUpdate

A successful response from apps.manifest.update.

pub type ManifestUpdateResponse {
  ManifestUpdateResponse(
    app_id: String,
    permissions_updated: option.Option(Bool),
  )
}

Constructors

  • ManifestUpdateResponse(
      app_id: String,
      permissions_updated: option.Option(Bool),
    )

    Arguments

    permissions_updated

    Whether the update changed the app’s permissions (requiring reinstallation).

Identifies apps.manifest.validate in the slackline.Call that manifest_validate returns.

pub type ManifestValidate

A successful response from apps.manifest.validate.

pub type ManifestValidateResponse {
  ManifestValidateResponse(
    errors: option.Option(List(ManifestError)),
  )
}

Constructors

  • ManifestValidateResponse(
      errors: option.Option(List(ManifestError)),
    )

    Arguments

    errors

    Problems found in the manifest. Empty when the manifest is valid.

Identifies apps.uninstall in the slackline.Call that uninstall returns.

pub type Uninstall

Whether a user is connected to the app.

pub type UserConnectionStatus {
  Connected
  Disconnected
}

Constructors

  • Connected

    connected

  • Disconnected

    disconnected

Identifies apps.user.connection.update in the slackline.Call that user_connection_update returns.

pub type UserConnectionUpdate

Values

pub fn activities_list(
  app_id app_id: String,
) -> slackline.Call(ActivitiesList, ActivitiesListResponse)

apps.activities.list: Get logs for a specified app

apps.ActivitiesList identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/activities_list.

User token scopes: hosting:read.

Rate limit tier: t3.

Documented errors: feature_disabled_for_lite_sandbox, free_team_not_allowed, invalid_app, invalid_app_id, invalid_args, invalid_cursor, restricted_plan_level.

pub fn activities_list_response_decoder() -> decode.Decoder(
  ActivitiesListResponse,
)

Decodes the response from apps.activities.list.

pub fn app_credentials_decoder() -> decode.Decoder(AppCredentials)

Decodes AppCredentials from json.

pub fn app_credentials_to_json(it: AppCredentials) -> json.Json

Encodes AppCredentials as json.

pub fn auth_external_delete() -> slackline.Call(
  AuthExternalDelete,
  Nil,
)

apps.auth.external.delete: Delete external auth tokens only on the Slack side

apps.AuthExternalDelete identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/auth_external_delete.

Rate limit tier: t4.

Documented errors: app_not_found, invalid_args, method_not_supported, no_tokens_found, providers_not_found, token_not_found, unable_to_delete.

pub fn auth_external_get(
  external_token_id external_token_id: String,
) -> slackline.Call(AuthExternalGet, AuthExternalGetResponse)

apps.auth.external.get: Get the access token for the provided token ID

apps.AuthExternalGet identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/auth_external_get.

Rate limit tier: t3.

Documented errors: access_token_exchange_failed, method_not_supported, no_refresh_token, token_not_found.

pub fn auth_external_get_response_decoder() -> decode.Decoder(
  AuthExternalGetResponse,
)

Decodes the response from apps.auth.external.get.

pub fn connections_open() -> slackline.Call(
  ConnectionsOpen,
  ConnectionsOpenResponse,
)

apps.connections.open: Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over.

apps.ConnectionsOpen identifies this method in slackline.Call.

Rate limit tier: t3.

Documented errors: forbidden_team, insecure_request, missing_args.

pub fn connections_open_response_decoder() -> decode.Decoder(
  ConnectionsOpenResponse,
)

Decodes the response from apps.connections.open.

pub fn datastore_bulk_delete(
  datastore datastore: String,
  ids ids: List(String),
) -> slackline.Call(
  DatastoreBulkDelete,
  DatastoreBulkDeleteResponse,
)

apps.datastore.bulkDelete: Delete items from a datastore in bulk

apps.DatastoreBulkDelete identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/datastore_bulk_delete.

Bot token scopes: datastore:write.

Rate limit tier: t3.

Documented errors: app_not_hosted, datastore_error, datastore_migration_in_progress, free_team_not_allowed, invalid_app_id, invalid_datastore, partial_failure, restricted_plan_level, team_quota_exceeded, unknown_method.

pub fn datastore_bulk_delete_response_decoder() -> decode.Decoder(
  DatastoreBulkDeleteResponse,
)

Decodes the response from apps.datastore.bulkDelete.

pub fn datastore_bulk_get(
  datastore datastore: String,
  ids ids: List(String),
) -> slackline.Call(DatastoreBulkGet, DatastoreBulkGetResponse)

apps.datastore.bulkGet: Get items from a datastore in bulk

apps.DatastoreBulkGet identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/datastore_bulk_get.

Bot token scopes: datastore:read.

Rate limit tier: t3.

Documented errors: app_not_hosted, datastore_error, datastore_migration_in_progress, free_team_not_allowed, invalid_app_id, invalid_datastore, partial_failure, restricted_plan_level, team_quota_exceeded, unknown_method.

pub fn datastore_bulk_get_response_decoder() -> decode.Decoder(
  DatastoreBulkGetResponse,
)

Decodes the response from apps.datastore.bulkGet.

pub fn datastore_bulk_put(
  datastore datastore: String,
  items items: List(dict.Dict(String, value.Value)),
) -> slackline.Call(DatastoreBulkPut, DatastoreBulkPutResponse)

apps.datastore.bulkPut: Creates or replaces existing items in bulk

apps.DatastoreBulkPut identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/datastore_bulk_put.

Bot token scopes: datastore:write.

Rate limit tier: t3.

Documented errors: app_not_hosted, datastore_error, datastore_migration_in_progress, free_team_not_allowed, invalid_app_id, invalid_datastore, partial_failure, restricted_plan_level, team_quota_exceeded, unknown_method.

pub fn datastore_bulk_put_response_decoder() -> decode.Decoder(
  DatastoreBulkPutResponse,
)

Decodes the response from apps.datastore.bulkPut.

pub fn datastore_count(
  datastore datastore: String,
) -> slackline.Call(DatastoreCount, DatastoreCountResponse)

apps.datastore.count: Count the number of items in a datastore that match a query

apps.DatastoreCount identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/datastore_count.

Bot token scopes: datastore:read.

Rate limit tier: t3.

Documented errors: app_not_hosted, datastore_error, datastore_migration_in_progress, free_team_not_allowed, invalid_app_id, invalid_datastore, restricted_plan_level, team_quota_exceeded.

pub fn datastore_count_response_decoder() -> decode.Decoder(
  DatastoreCountResponse,
)

Decodes the response from apps.datastore.count.

pub fn datastore_delete(
  datastore datastore: String,
  id id: String,
) -> slackline.Call(DatastoreDelete, Nil)

apps.datastore.delete: Delete an item from a datastore

apps.DatastoreDelete identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/datastore_delete.

Bot token scopes: datastore:write.

Rate limit tier: t4.

Documented errors: app_not_hosted, datastore_error, datastore_migration_in_progress, free_team_not_allowed, invalid_app_id, invalid_datastore, restricted_plan_level.

pub fn datastore_get(
  datastore datastore: String,
  id id: String,
) -> slackline.Call(DatastoreGet, DatastoreGetResponse)

apps.datastore.get: Get an item from a datastore

apps.DatastoreGet identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/datastore_get.

Bot token scopes: datastore:read.

Rate limit tier: t4.

Documented errors: app_not_hosted, datastore_error, datastore_migration_in_progress, free_team_not_allowed, invalid_app_id, invalid_datastore, restricted_plan_level, team_quota_exceeded.

pub fn datastore_get_response_decoder() -> decode.Decoder(
  DatastoreGetResponse,
)

Decodes the response from apps.datastore.get.

pub fn datastore_put(
  datastore datastore: String,
  item item: dict.Dict(String, value.Value),
) -> slackline.Call(DatastorePut, DatastorePutResponse)

apps.datastore.put: Creates a new item, or replaces an old item with a new item.

apps.DatastorePut identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/datastore_put.

Bot token scopes: datastore:write.

Rate limit tier: t4.

Documented errors: app_not_hosted, datastore_error, datastore_migration_in_progress, free_team_not_allowed, invalid_app_id, invalid_datastore, restricted_plan_level, team_quota_exceeded.

pub fn datastore_put_response_decoder() -> decode.Decoder(
  DatastorePutResponse,
)

Decodes the response from apps.datastore.put.

pub fn datastore_query(
  datastore datastore: String,
) -> slackline.Call(DatastoreQuery, DatastoreQueryResponse)

apps.datastore.query: Query a datastore for items

apps.DatastoreQuery identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/datastore_query.

Bot token scopes: datastore:read.

Rate limit tier: t4.

Documented errors: app_not_hosted, datastore_error, datastore_migration_in_progress, free_team_not_allowed, invalid_app_id, invalid_datastore, restricted_plan_level, team_quota_exceeded.

pub fn datastore_query_response_decoder() -> decode.Decoder(
  DatastoreQueryResponse,
)

Decodes the response from apps.datastore.query.

pub fn datastore_update(
  datastore datastore: String,
  item item: dict.Dict(String, value.Value),
) -> slackline.Call(DatastoreUpdate, DatastoreUpdateResponse)

apps.datastore.update: Edits an existing item’s attributes, or adds a new item if it does not already exist.

apps.DatastoreUpdate identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/datastore_update.

Bot token scopes: datastore:write.

Rate limit tier: t4.

Documented errors: app_not_hosted, datastore_error, datastore_migration_in_progress, free_team_not_allowed, invalid_app_id, invalid_datastore, restricted_plan_level, team_quota_exceeded.

pub fn datastore_update_response_decoder() -> decode.Decoder(
  DatastoreUpdateResponse,
)

Decodes the response from apps.datastore.update.

pub fn event_authorization_decoder() -> decode.Decoder(
  EventAuthorization,
)

Decodes EventAuthorization from json.

pub fn event_authorization_to_json(
  it: EventAuthorization,
) -> json.Json

Encodes EventAuthorization as json.

pub fn event_authorizations_list(
  event_context event_context: String,
) -> slackline.Call(
  EventAuthorizationsList,
  EventAuthorizationsListResponse,
)

apps.event.authorizations.list: Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.

apps.EventAuthorizationsList identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/event_authorizations_list.

Rate limit tier: t5.

Documented errors: auth_mismatch, invalid_cursor, invalid_event_context.

pub fn event_authorizations_list_response_decoder() -> decode.Decoder(
  EventAuthorizationsListResponse,
)

Decodes the response from apps.event.authorizations.list.

pub fn icon_set(
  app_id app_id: String,
) -> slackline.Call(IconSet, Nil)

apps.icon.set: Sets the app icon

apps.IconSet identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/icon_set.

User token scopes: app_configurations:write.

Rate limit tier: t1.

Documented errors: app_edit_disabled, app_not_owned_by_manager_app, error_bad_format, icon_not_accessible, invalid_app, invalid_app_id, invalid_icon_size, invalid_parameters, missing_arguments, unable_to_open_file.

pub fn managed_permissions_set(
  app_id app_id: String,
  permissions permissions: String,
) -> slackline.Call(ManagedPermissionsSet, Nil)

apps.managed.permissions.set: Set who can interact with a managed app

apps.ManagedPermissionsSet identifies this method in slackline.Call.

Rate limit tier: t2.

Documented errors: app_not_found, app_not_managed, app_not_owned_by_manager_app, app_owner_not_found, enterprise_only_feature, feature_not_enabled, manager_app_not_eligible.

pub fn manifest_create(
  manifest manifest: value.Value,
) -> slackline.Call(ManifestCreate, ManifestCreateResponse)

apps.manifest.create: Create an app from an app manifest.

apps.ManifestCreate identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/manifest_create.

Rate limit tier: t1.

Documented errors: dynamic_client_registration_failed, dynamic_client_registration_invalid_redirect_uri, dynamic_client_registration_invalid_response, dynamic_client_registration_missing_oauth_endpoints, dynamic_client_registration_not_supported, dynamic_client_registration_rejected, failed_adding_collaborator, failed_creating_app, failed_datastore_operation, failed_generating_app_token, feature_not_enabled, invalid_app, invalid_manager_app, invalid_manifest, invalid_team_id, managed_app_limit_reached, not_in_team, oauth_metadata_not_found, socket_mode_not_enabled, unknown_method.

pub fn manifest_create_response_decoder() -> decode.Decoder(
  ManifestCreateResponse,
)

Decodes the response from apps.manifest.create.

pub fn manifest_delete(
  app_id app_id: String,
) -> slackline.Call(ManifestDelete, Nil)

apps.manifest.delete: Permanently deletes an app created through app manifests

apps.ManifestDelete identifies this method in slackline.Call.

Rate limit tier: t1.

Documented errors: app_not_eligible, app_not_found, app_not_owned_by_manager_app, invalid_app_id, published_app_only.

pub fn manifest_error_decoder() -> decode.Decoder(ManifestError)

Decodes ManifestError from json.

pub fn manifest_error_to_json(it: ManifestError) -> json.Json

Encodes ManifestError as json.

pub fn manifest_export(
  app_id app_id: String,
) -> slackline.Call(ManifestExport, ManifestExportResponse)

apps.manifest.export: Export an app manifest from an existing app

apps.ManifestExport identifies this method in slackline.Call.

Rate limit tier: t3.

Documented errors: app_not_eligible, app_not_found, app_not_owned_by_manager_app, failed_export, invalid_app_id, unknown_method.

pub fn manifest_export_response_decoder() -> decode.Decoder(
  ManifestExportResponse,
)

Decodes the response from apps.manifest.export.

pub fn manifest_update(
  manifest manifest: value.Value,
  app_id app_id: String,
) -> slackline.Call(ManifestUpdate, ManifestUpdateResponse)

apps.manifest.update: Update an app from an app manifest

apps.ManifestUpdate identifies this method in slackline.Call.

Rate limit tier: t1.

Documented errors: app_edit_disabled, app_not_eligible, app_not_found, app_not_owned_by_manager_app, dynamic_client_registration_failed, dynamic_client_registration_invalid_redirect_uri, dynamic_client_registration_invalid_response, dynamic_client_registration_missing_oauth_endpoints, dynamic_client_registration_not_supported, dynamic_client_registration_rejected, failed_adding_collaborator, failed_creating_app, failed_datastore_operation, invalid_app, invalid_app_id, invalid_manifest, oauth_metadata_not_found, unknown_method.

pub fn manifest_update_response_decoder() -> decode.Decoder(
  ManifestUpdateResponse,
)

Decodes the response from apps.manifest.update.

pub fn manifest_validate(
  manifest manifest: value.Value,
) -> slackline.Call(ManifestValidate, ManifestValidateResponse)

apps.manifest.validate: Validate an app manifest

apps.ManifestValidate identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/apps/manifest_validate.

Rate limit tier: t3.

Documented errors: app_edit_disabled, app_not_eligible, app_not_owned_by_manager_app, failed_adding_collaborator, failed_creating_app, invalid_app, invalid_app_id, invalid_manifest, unknown_method.

pub fn manifest_validate_response_decoder() -> decode.Decoder(
  ManifestValidateResponse,
)

Decodes the response from apps.manifest.validate.

pub fn uninstall(
  client_id client_id: String,
  client_secret client_secret: String,
) -> slackline.Call(Uninstall, Nil)

apps.uninstall: Uninstalls your app from a workspace.

apps.Uninstall identifies this method in slackline.Call.

Rate limit tier: t1.

Documented errors: bad_client_secret, client_id_token_mismatch, invalid_client_id.

pub fn user_connection_status_decoder() -> decode.Decoder(
  UserConnectionStatus,
)

Decodes UserConnectionStatus from a json string.

pub fn user_connection_status_from_string(
  string: String,
) -> Result(UserConnectionStatus, Nil)

Parses UserConnectionStatus from its json string.

pub fn user_connection_status_to_json(
  it: UserConnectionStatus,
) -> json.Json

Encodes UserConnectionStatus as a json string.

pub fn user_connection_status_to_string(
  it: UserConnectionStatus,
) -> String

The json string of UserConnectionStatus.

pub fn user_connection_update(
  user_id user_id: String,
  status status: UserConnectionStatus,
) -> slackline.Call(UserConnectionUpdate, Nil)

apps.user.connection.update: Updates the connection status between a user and an app.

apps.UserConnectionUpdate identifies this method in slackline.Call.

User token scopes: users:write.

Rate limit tier: t2.

Documented errors: app_not_found, app_not_subscribed, user_not_found.

✨ Search Document