Lettermint.Team.Members (Lettermint v2.0.0)

Copy Markdown View Source

Team members. Needs :team_token.

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

Summary

Types

result(value)

Functions

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

Streams every team member, following next_cursor. Raises the error of a failed page request.

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

Lists team members, one page at a time. query: Lettermint.Types.ListTeamMembersQuery.t/0.

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

Retrieves a team member.

update_assignment(client, user_id, body, options \\ [])

Changes a member's role and project access.

Types

result(value)

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

Functions

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

@spec iterate(
  Lettermint.Client.t(),
  Lettermint.Types.ListTeamMembersQuery.t(),
  keyword()
) ::
  Enumerable.t(Lettermint.Types.TeamMemberData.t())

Streams every team member, following next_cursor. Raises the error of a failed page request.

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

@spec list(
  Lettermint.Client.t(),
  Lettermint.Types.ListTeamMembersQuery.t(),
  keyword()
) ::
  result(Lettermint.Types.ListTeamMembersResponse.t())

Lists team members, one page at a time. query: Lettermint.Types.ListTeamMembersQuery.t/0.

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

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

Retrieves a team member.

update_assignment(client, user_id, body, options \\ [])

@spec update_assignment(
  Lettermint.Client.t(),
  String.t(),
  Lettermint.Types.UpdateTeamMemberAssignmentData.t() | map(),
  keyword()
) :: result(Lettermint.Types.TeamMemberData.t())

Changes a member's role and project access.