wxc_sdk.groups package

Groups API

class wxc_sdk.groups.GroupMember(*, id: str | None = None, type: str | None = None, displayName: str | None = None, operation: str | None = None)[source]

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.

member_id: str | None
member_type: str | None
display_name: str | None
operation: str | None
class wxc_sdk.groups.Group(*, id: str | None = None, displayName: str | None = None, members: list[wxc_sdk.groups.GroupMember] | None = None, orgId: str | None = None, description: str | None = None, created: datetime | None = None, lastModified: datetime | None = None, memberSize: int | None = None, usage: str | None = None)[source]

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.

group_id: str | None
display_name: str | None
members: list[wxc_sdk.groups.GroupMember] | None
org_id: str | None
description: str | None
created: datetime | None
last_modified: datetime | None
member_size: int | None
usage: str | None
class wxc_sdk.groups.GroupsApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

list(include_members: bool | None = None, attributes: str | None = None, sort_by: str | None = None, sort_order: str | None = None, list_filter: str | None = None, org_id: str | None = None, **params) → Generator[Group, None, None][source]

List groups

Parameters:

  • include_members (bool) – Include members in list response

  • attributes (str) – comma separated list of attributes to return

  • sort_by (str) – attribute to sort by

  • sort_order (str) – sort order, ascending or descending

  • org_id (str) – organisation ID

  • list_filter (str) – filter expression. Example: displayName eq “test”

  • params –

Returns:

generator of Group objects

create(settings: Group) → Group[source]

Create a new group using the provided settings. Only display_name is mandatory

Parameters:

settings (Group) – settings for new group

Returns:

new group

Return type:

Group

details(group_id: str, include_members: bool | None = None) → Group[source]

Get group details

Parameters:

  • group_id (str) – group id

  • include_members (bool) – return members in response

Returns:

group details

Return type:

Group

members(group_id: str, **params) → Generator[GroupMember, None, None][source]

Query members of a group

Parameters:

  • group_id (str) – group id

  • params –

Returns:

generator of GroupMember instances

update(group_id: str, settings: Group | None = None, remove_all: bool | None = None) → Group[source]

update group information.

Options: change displayName, add new members, remove some or all members, replace all members

Parameters:

  • group_id –

  • settings –

  • remove_all –

Returns:

delete_group(group_id: str)[source]

Delete a group

Parameters:

group_id (str) – group id

base = 'groups'
session: RestSession

REST session