The team of the token. Needs :team_token. Members are in
Lettermint.Team.Members, pending invitations in Lettermint.Team.Invites.
Every function takes the options timeout: (milliseconds) last.
Summary
Functions
Creates a custom role. Needs a plan with custom roles. permissions must
include the permissions they depend on, and role names are unique.
Deletes a custom role. Built-in roles cannot be deleted. query:
%{replacement_role_id: ...}, the role that receives the existing
assignments; it is required only while the role is still assigned to
members, invites or SCIM groups.
Copies a role under a new name. Without a description, the copy keeps the
description of the source role. The Owner role cannot be duplicated.
The team. query: %{include: ["features"]} and so on.
Retrieves a role.
The roles that can be assigned to members.
Updates the team.
Replaces the name, description and permissions of a custom role. Built-in roles cannot be changed.
Usage of the current and previous billing periods.
Types
@type result(value) :: {:ok, value} | {:error, Lettermint.Error.t()}
Functions
@spec create_role( Lettermint.Client.t(), Lettermint.Types.CreateTeamRoleData.t() | map(), keyword() ) :: result(Lettermint.Types.TeamRoleData.t())
Creates a custom role. Needs a plan with custom roles. permissions must
include the permissions they depend on, and role names are unique.
@spec delete_role( Lettermint.Client.t(), String.t(), Lettermint.Types.DeleteTeamRoleQuery.t(), keyword() ) :: result(Lettermint.Types.MessageResponse.t())
Deletes a custom role. Built-in roles cannot be deleted. query:
%{replacement_role_id: ...}, the role that receives the existing
assignments; it is required only while the role is still assigned to
members, invites or SCIM groups.
@spec duplicate_role( Lettermint.Client.t(), String.t(), Lettermint.Types.DuplicateTeamRoleData.t() | map(), keyword() ) :: result(Lettermint.Types.TeamRoleData.t())
Copies a role under a new name. Without a description, the copy keeps the
description of the source role. The Owner role cannot be duplicated.
@spec retrieve(Lettermint.Client.t(), Lettermint.Types.GetTeamQuery.t(), keyword()) :: result(Lettermint.Types.TeamData.t())
The team. query: %{include: ["features"]} and so on.
@spec retrieve_role(Lettermint.Client.t(), String.t(), keyword()) :: result(Lettermint.Types.TeamRoleData.t())
Retrieves a role.
@spec roles(Lettermint.Client.t(), keyword()) :: result(Lettermint.Types.TeamRoleListResponse.t())
The roles that can be assigned to members.
@spec update( Lettermint.Client.t(), Lettermint.Types.UpdateTeamData.t() | map(), keyword() ) :: result(Lettermint.Types.TeamMutationResponse.t())
Updates the team.
@spec update_role( Lettermint.Client.t(), String.t(), Lettermint.Types.UpdateTeamRoleData.t() | map(), keyword() ) :: result(Lettermint.Types.TeamRoleData.t())
Replaces the name, description and permissions of a custom role. Built-in roles cannot be changed.
@spec usage(Lettermint.Client.t(), keyword()) :: result(Lettermint.Types.TeamUsageDetailData.t())
Usage of the current and previous billing periods.