wxc_sdk.teams package

Teams API

class wxc_sdk.teams.Team(*, id: str | None = None, name: str | None = None, creatorId: str | None = None, description: str | None = None, created: datetime | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

A unique identifier for the team.

name: str | None

A user-friendly name for the team.

creator_id: str | None

id of the creator

description: str | None

The teams description.

created: datetime | None

The date and time the team was created.

class wxc_sdk.teams.TeamsApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

Teams are groups of people with a set of rooms that are visible to all members of that team. This API is used to manage the teams themselves. Teams are created and deleted with this API. You can also update a team to change its name, for example. To manage people in a team see the Team Memberships API. To manage team rooms see the Rooms API.

list(**params: Any) → Generator[Team, None, None][source]

Lists teams to which the authenticated user belongs.

create(name: str, description: str = None) → Team[source]

Creates a team. The authenticated user is automatically added as a member of the team. See the Team Memberships API to learn how to add more people to the team.

Parameters:

  • name (str) – A user-friendly name for the team.

  • description (str) – The teams description.

details(team_id: str) → Team[source]

Shows details for a team, by ID. Specify the team ID in the teamId parameter in the URI.

Parameters:

team_id (str) – The unique identifier for the team.

update(team_id: str, name: str, description: str = None) → Team[source]

Updates details for a team, by ID. Specify the team ID in the teamId parameter in the URI.

Parameters:

  • team_id (str) – The unique identifier for the team.

  • name (str) – A user-friendly name for the team.

  • description (str) – The teams description.

delete(team_id: str) → None[source]

Deletes a team, by ID. Specify the team ID in the teamId parameter in the URI.

Parameters:

team_id (str) – The unique identifier for the team.

base = 'teams'