invite_requests

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

Admin API methods for reviewing requests to invite people to a workspace.

Types

Approve

Identifies admin.inviteRequests.approve in the slackline.Call that approve returns.

pub type Approve

ApprovedInvite

</>

The invite sent after an invite request was approved.

pub type ApprovedInvite {
  ApprovedInvite(
    id: String,
    inviter_id: option.Option(String),
    email: option.Option(String),
    date_created: option.Option(Int),
    date_resent: option.Option(Int),
    is_bouncing: option.Option(Bool),
    invite_preferences: option.Option(InvitePreferences),
  )
}

Constructors

ApprovedInvite(
  id: String,
  inviter_id: option.Option(String),
  email: option.Option(String),
  date_created: option.Option(Int),
  date_resent: option.Option(Int),
  is_bouncing: option.Option(Bool),
  invite_preferences: option.Option(InvitePreferences),
)

Arguments

id: The invite ID.
inviter_id: ID of the user credited as the inviter.
date_created: When the invite was sent, in Unix seconds.
date_resent: When the invite was last resent, in Unix seconds.
is_bouncing: Whether email to the invited address is bouncing.

ApprovedInviteRequest

</>

An approved invite request.

pub type ApprovedInviteRequest {
  ApprovedInviteRequest(
    invite_request: option.Option(event.InviteRequest),
    approved_by: option.Option(InviteRequestActor),
    invite: option.Option(ApprovedInvite),
  )
}

Constructors

ApprovedInviteRequest(
  invite_request: option.Option(event.InviteRequest),
  approved_by: option.Option(InviteRequestActor),
  invite: option.Option(ApprovedInvite),
)

ApprovedList

</>

Identifies admin.inviteRequests.approved.list in the slackline.Call that approved_list returns.

pub type ApprovedList

ApprovedListResponse

</>

A successful response from admin.inviteRequests.approved.list.

pub type ApprovedListResponse {
  ApprovedListResponse(
    approved_requests: option.Option(List(ApprovedInviteRequest)),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

ApprovedListResponse(
  approved_requests: option.Option(List(ApprovedInviteRequest)),
  response_metadata: option.Option(slackline.ResponseMetadata),
)

Arguments

approved_requests: Approved invite requests.

DeniedInviteRequest

</>

A denied invite request.

pub type DeniedInviteRequest {
  DeniedInviteRequest(
    invite_request: option.Option(event.InviteRequest),
    denied_by: option.Option(InviteRequestActor),
  )
}

Constructors

DeniedInviteRequest(
  invite_request: option.Option(event.InviteRequest),
  denied_by: option.Option(InviteRequestActor),
)

DeniedList

</>

Identifies admin.inviteRequests.denied.list in the slackline.Call that denied_list returns.

pub type DeniedList

DeniedListResponse

</>

A successful response from admin.inviteRequests.denied.list.

pub type DeniedListResponse {
  DeniedListResponse(
    denied_requests: option.Option(List(DeniedInviteRequest)),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

DeniedListResponse(
  denied_requests: option.Option(List(DeniedInviteRequest)),
  response_metadata: option.Option(slackline.ResponseMetadata),
)

Arguments

denied_requests: Denied invite requests.

Deny

</>

Identifies admin.inviteRequests.deny in the slackline.Call that deny returns.

pub type Deny

InvitePreferences

</>

Preferences of an invite sent after a request was approved.

pub type InvitePreferences {
  InvitePreferences(
    is_restricted: option.Option(Bool),
    is_ultra_restricted: option.Option(Bool),
    date_expire: option.Option(Int),
    channel_ids: option.Option(List(String)),
    is_domain_matched: option.Option(Bool),
    real_name: option.Option(String),
  )
}

Constructors

InvitePreferences(
  is_restricted: option.Option(Bool),
  is_ultra_restricted: option.Option(Bool),
  date_expire: option.Option(Int),
  channel_ids: option.Option(List(String)),
  is_domain_matched: option.Option(Bool),
  real_name: option.Option(String),
)

Arguments

date_expire: When a guest account expires, in Unix seconds.
channel_ids: Channels the invited person joins.

InviteRequestActor

</>

Who approved or denied an invite request.

pub type InviteRequestActor {
  InviteRequestActor(
    actor_id: option.Option(String),
    actor_type: option.Option(InviteRequestActorType),
  )
}

Constructors

InviteRequestActor(
  actor_id: option.Option(String),
  actor_type: option.Option(InviteRequestActorType),
)

Arguments

actor_id: ID of the user or app that acted.
actor_type: Whether a user or an app acted.

InviteRequestActorType

</>

The kind of actor that approved or denied an invite request.

pub type InviteRequestActorType {
  User
  App
  UnknownInviteRequestActorType(String)
}

Constructors

```
User
```
user
```
App
```
app
```
UnknownInviteRequestActorType(String)
```
A value that this version of slackline does not know.

ListMethod

</>

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

pub type ListMethod

ListResponse

</>

A successful response from admin.inviteRequests.list.

pub type ListResponse {
  ListResponse(
    invite_requests: option.Option(List(event.InviteRequest)),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

ListResponse(
  invite_requests: option.Option(List(event.InviteRequest)),
  response_metadata: option.Option(slackline.ResponseMetadata),
)

Arguments

invite_requests: Pending invite requests.

Values

approve

</>

pub fn approve(
  invite_request_id invite_request_id: String,
) -> slackline.Call(Approve, Nil)

admin.inviteRequests.approve: Approve a workspace invite request.

invite_requests.Approve identifies this method in slackline.Call.

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

User token scopes: admin.invites:write.

Rate limit tier: t2.

Documented errors: already_processed, failed_to_send_invite, feature_not_enabled, invalid_request, not_an_admin, team_not_found.

approved_invite_decoder

</>

pub fn approved_invite_decoder() -> decode.Decoder(ApprovedInvite)

Decodes ApprovedInvite from json.

approved_invite_request_decoder

</>

pub fn approved_invite_request_decoder() -> decode.Decoder(
  ApprovedInviteRequest,
)

Decodes ApprovedInviteRequest from json.

approved_invite_request_to_json

</>

pub fn approved_invite_request_to_json(
  it: ApprovedInviteRequest,
) -> json.Json

Encodes ApprovedInviteRequest as json.

approved_invite_to_json

</>

pub fn approved_invite_to_json(it: ApprovedInvite) -> json.Json

Encodes ApprovedInvite as json.

approved_list

</>

pub fn approved_list() -> slackline.Call(
  ApprovedList,
  ApprovedListResponse,
)

admin.inviteRequests.approved.list: List all approved workspace invite requests.

invite_requests.ApprovedList identifies this method in slackline.Call.

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

User token scopes: admin.invites:read.

Rate limit tier: t2.

Documented errors: feature_not_enabled, not_an_admin, team_not_found.

approved_list_response_decoder

</>

pub fn approved_list_response_decoder() -> decode.Decoder(
  ApprovedListResponse,
)

Decodes the response from admin.inviteRequests.approved.list.

denied_invite_request_decoder

</>

pub fn denied_invite_request_decoder() -> decode.Decoder(
  DeniedInviteRequest,
)

Decodes DeniedInviteRequest from json.

denied_invite_request_to_json

</>

pub fn denied_invite_request_to_json(
  it: DeniedInviteRequest,
) -> json.Json

Encodes DeniedInviteRequest as json.

denied_list

</>

pub fn denied_list() -> slackline.Call(
  DeniedList,
  DeniedListResponse,
)

admin.inviteRequests.denied.list: List all denied workspace invite requests.

invite_requests.DeniedList identifies this method in slackline.Call.

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

User token scopes: admin.invites:read.

Rate limit tier: t2.

Documented errors: feature_not_enabled, not_an_admin, team_not_found.

denied_list_response_decoder

</>

pub fn denied_list_response_decoder() -> decode.Decoder(
  DeniedListResponse,
)

Decodes the response from admin.inviteRequests.denied.list.

deny

</>

pub fn deny(
  invite_request_id invite_request_id: String,
) -> slackline.Call(Deny, Nil)

admin.inviteRequests.deny: Deny a workspace invite request.

invite_requests.Deny identifies this method in slackline.Call.

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

User token scopes: admin.invites:write.

Rate limit tier: t2.

Documented errors: already_processed, feature_not_enabled, invalid_request, not_an_admin, team_not_found.

invite_preferences_decoder

</>

pub fn invite_preferences_decoder() -> decode.Decoder(
  InvitePreferences,
)

Decodes InvitePreferences from json.

invite_preferences_to_json

</>

pub fn invite_preferences_to_json(
  it: InvitePreferences,
) -> json.Json

Encodes InvitePreferences as json.

invite_request_actor_decoder

</>

pub fn invite_request_actor_decoder() -> decode.Decoder(
  InviteRequestActor,
)

Decodes InviteRequestActor from json.

invite_request_actor_to_json

</>

pub fn invite_request_actor_to_json(
  it: InviteRequestActor,
) -> json.Json

Encodes InviteRequestActor as json.

invite_request_actor_type_decoder

</>

pub fn invite_request_actor_type_decoder() -> decode.Decoder(
  InviteRequestActorType,
)

Decodes InviteRequestActorType from a json string.

invite_request_actor_type_from_string

</>

pub fn invite_request_actor_type_from_string(
  string: String,
) -> InviteRequestActorType

Parses InviteRequestActorType from its json string.

invite_request_actor_type_to_json

</>

pub fn invite_request_actor_type_to_json(
  it: InviteRequestActorType,
) -> json.Json

Encodes InviteRequestActorType as a json string.

invite_request_actor_type_to_string

</>

pub fn invite_request_actor_type_to_string(
  it: InviteRequestActorType,
) -> String

The json string of InviteRequestActorType.

list

</>

pub fn list() -> slackline.Call(ListMethod, ListResponse)

admin.inviteRequests.list: List all pending workspace invite requests.

invite_requests.ListMethod identifies this method in slackline.Call.

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

User token scopes: admin.invites:read.

Rate limit tier: t2.

Documented errors: feature_not_enabled, not_an_admin, team_not_found.

list_response_decoder

</>

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

Decodes the response from admin.inviteRequests.list.