Lettermint.Team.Invites (Lettermint v2.2.0)

Pending team invitations. Needs :team_token.

Every function takes the options timeout: (milliseconds) last.

Summary

Types

result(value)

Functions

create(client, body, options \\ [])

Invites a person to the team and sends the invitation email. The team needs a free seat, and the Owner role cannot be assigned.

iterate(client, query \\ %{}, options \\ [])

Streams every pending invitation, following next_cursor. Raises the error of a failed page request.

list(client, query \\ %{}, options \\ [])

Lists pending invitations, one page at a time. query: Lettermint.Types.ListTeamInvitesQuery.t/0.

retrieve(client, invite_id, options \\ [])

Retrieves a pending invitation.

revoke(client, invite_id, options \\ [])

Revokes a pending invitation.

update(client, invite_id, body, options \\ [])

Replaces the email, role and project access of a pending invitation. A new invitation email is sent only when the address changes.

Types

result(value)

@type result(value) :: {:ok, value} | {:error, Lettermint.Error.t()}

Functions

create(client, body, options \\ [])

@spec create(
  Lettermint.Client.t(),
  Lettermint.Types.CreateTeamInviteData.t() | map(),
  keyword()
) ::
  result(Lettermint.Types.TeamInviteData.t())

Invites a person to the team and sends the invitation email. The team needs a free seat, and the Owner role cannot be assigned.

iterate(client, query \\ %{}, options \\ [])

@spec iterate(
  Lettermint.Client.t(),
  Lettermint.Types.ListTeamInvitesQuery.t(),
  keyword()
) ::
  Enumerable.t(Lettermint.Types.TeamInviteData.t())

Streams every pending invitation, following next_cursor. Raises the error of a failed page request.

list(client, query \\ %{}, options \\ [])

@spec list(
  Lettermint.Client.t(),
  Lettermint.Types.ListTeamInvitesQuery.t(),
  keyword()
) ::
  result(Lettermint.Types.ListTeamInvitesResponse.t())

Lists pending invitations, one page at a time. query: Lettermint.Types.ListTeamInvitesQuery.t/0.

retrieve(client, invite_id, options \\ [])

@spec retrieve(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.TeamInviteData.t())

Retrieves a pending invitation.

revoke(client, invite_id, options \\ [])

@spec revoke(Lettermint.Client.t(), String.t(), keyword()) ::
  result(Lettermint.Types.MessageResponse.t())

Revokes a pending invitation.

update(client, invite_id, body, options \\ [])

@spec update(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.UpdateTeamInviteData.t() | map(),
  keyword()
) :: result(Lettermint.Types.TeamInviteData.t())

Replaces the email, role and project access of a pending invitation. A new invitation email is sent only when the address changes.