slackline - v1.0.0

slackline/api/admin/functions

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

Admin functions: list functions and manage who can use them.

Types

AdminFunction

</>

A function from admin.functions.list.

pub type AdminFunction {
  AdminFunction(
    id: String,
    callback_id: option.Option(String),
    title: option.Option(String),
    description: option.Option(String),
    type_: option.Option(String),
    input_parameters: option.Option(List(AdminFunctionParameter)),
    output_parameters: option.Option(List(AdminFunctionParameter)),
    app_id: option.Option(String),
    date_created: option.Option(Int),
    date_updated: option.Option(Int),
    date_deleted: option.Option(Int),
  )
}

Constructors

AdminFunctionParameter

</>

An input or output parameter of a function.

pub type AdminFunctionParameter {
  AdminFunctionParameter(
    type_: option.Option(String),
    name: String,
    description: option.Option(String),
    title: option.Option(String),
    is_required: option.Option(Bool),
  )
}

Constructors

FunctionVisibility

</>

Who can see and run a function.

pub type FunctionVisibility {
  VisibleToEveryone
  VisibleToAppCollaborators
  VisibleToNamedEntities
  VisibleToNoOne
}

Constructors 

  • VisibleToEveryone

    everyone

  • VisibleToAppCollaborators

    app_collaborators

  • VisibleToNamedEntities

    named_entities

  • VisibleToNoOne

    no_one

ListMethod

</>

Identifies admin.functions.list in the slackline.Call that list returns.

pub type ListMethod

ListResponse

</>

A successful response from admin.functions.list.

pub type ListResponse {
  ListResponse(
    functions: option.Option(List(AdminFunction)),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

PermissionsLookup

</>

Identifies admin.functions.permissions.lookup in the slackline.Call that permissions_lookup returns.

pub type PermissionsLookup

PermissionsLookupResponse

</>

A successful response from admin.functions.permissions.lookup.

pub type PermissionsLookupResponse {
  PermissionsLookupResponse(
    permissions: option.Option(dict.Dict(String, value.Value)),
    errors: option.Option(dict.Dict(String, value.Value)),
  )
}

Constructors

PermissionsSet

</>

Identifies admin.functions.permissions.set in the slackline.Call that permissions_set returns.

pub type PermissionsSet

Values

admin_function_decoder

</> 
pub fn admin_function_decoder() -> decode.Decoder(AdminFunction)

Decodes AdminFunction from json.

admin_function_parameter_decoder

</> 
pub fn admin_function_parameter_decoder() -> decode.Decoder(
  AdminFunctionParameter,
)

Decodes AdminFunctionParameter from json.

admin_function_parameter_to_json

</> 
pub fn admin_function_parameter_to_json(
  it: AdminFunctionParameter,
) -> json.Json

Encodes AdminFunctionParameter as json.

admin_function_to_json

</> 
pub fn admin_function_to_json(it: AdminFunction) -> json.Json

Encodes AdminFunction as json.

function_visibility_decoder

</> 
pub fn function_visibility_decoder() -> decode.Decoder(
  FunctionVisibility,
)

Decodes FunctionVisibility from a json string.

function_visibility_from_string

</> 
pub fn function_visibility_from_string(
  string: String,
) -> Result(FunctionVisibility, Nil)

Parses FunctionVisibility from its json string.

function_visibility_to_json

</> 
pub fn function_visibility_to_json(
  it: FunctionVisibility,
) -> json.Json

Encodes FunctionVisibility as a json string.

function_visibility_to_string

</> 
pub fn function_visibility_to_string(
  it: FunctionVisibility,
) -> String

The json string of FunctionVisibility.

list

</> 
pub fn list(
  app_ids app_ids: List(String),
) -> slackline.Call(ListMethod, ListResponse)

admin.functions.list: Look up functions by a set of apps.

functions.ListMethod identifies this method in slackline.Call.

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

User token scopes: admin.workflows:read.

Rate limit tier: t2.

Documented errors: invalid_cursor, not_allowed, restricted_action.

list_response_decoder

</> 
pub fn list_response_decoder() -> decode.Decoder(ListResponse)

Decodes the response from admin.functions.list.

permissions_lookup

</> 
pub fn permissions_lookup(
  function_ids function_ids: List(String),
) -> slackline.Call(PermissionsLookup, PermissionsLookupResponse)

admin.functions.permissions.lookup: Lookup the visibility of multiple Slack functions and include the users if it is limited to particular named entities.

functions.PermissionsLookup identifies this method in slackline.Call.

User token scopes: admin.workflows:read.

Rate limit tier: t3.

Documented errors: restricted_action.

permissions_lookup_response_decoder

</> 
pub fn permissions_lookup_response_decoder() -> decode.Decoder(
  PermissionsLookupResponse,
)

Decodes the response from admin.functions.permissions.lookup.

permissions_set

</> 
pub fn permissions_set(
  function_id function_id: String,
) -> slackline.Call(PermissionsSet, Nil)

admin.functions.permissions.set: Set the visibility of a Slack function and define the users or workspaces if it is set to named_entities.

functions.PermissionsSet identifies this method in slackline.Call.

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

User token scopes: admin.workflows:read.

Rate limit tier: t3.

Documented errors: function_not_found, invalid_permission, invalid_permission_type, invalid_setting, invalid_visibility, restricted_action, unknown_method.

✨ Search Document