wxc_sdk.teams package

Teams API

class wxc_sdk.teams.Team(*, id: Optional[str] = None, name: Optional[str] = None, creatorId: Optional[str] = None, created: Optional[datetime] = None)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

id: Optional[str]

A unique identifier for the team.

name: Optional[str]

A user-friendly name for the team.

creator_id: Optional[str]

id of the creator

created: Optional[datetime]

The date and time the team was created.

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

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() → Generator[Team, None, None]

Lists teams to which the authenticated user belongs.

create(name: str) → Team

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.

details(team_id: str) → Team

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) → Team

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.

delete(team_id: str)

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'

session: RestSession

REST session