Teams

class Teams(umami: Umami)

Provides functionalities for interacting with Teams in the Umami API.

umami

The Umami instance used for making HTTP requests.

Constructors

constructor(umami: Umami)

suspend fun addUser(teamId: String, userId: String, role: String): TeamMember

Adds a user to a team.

suspend fun create(name: String): Team

Creates a new team.

suspend fun delete(teamId: String)

Deletes a team.

suspend fun find(page: Int? = null, pageSize: Int? = null): SearchResponse<Team>

Retrieves a paginated list of teams.

suspend fun get(teamId: String): Team

Retrieves a team by its ID.

suspend fun getUser(teamId: String, userId: String): TeamMember

Retrieves a user from a team.

suspend fun getUsers(teamId: String, search: String? = null, page: Int? = null, pageSize: Int? = null): SearchResponse<TeamMember>

Retrieves the users of a team.

suspend fun getWebsites(teamId: String, search: String? = null, page: Int? = null, pageSize: Int? = null): SearchResponse<Website>

Retrieves the websites of a team.

suspend fun join(accessCode: String): TeamMember

Joins a team.

suspend fun removeUser(teamId: String, userId: String)

Removes a user from a team.

suspend fun update(teamId: String, name: String? = null, accessCode: String? = null): Team

Updates a team.

Updates a user's role in a team.