wxc_sdk.groups package

Groups API

class wxc_sdk.groups.GroupMember(*, id: Optional[str] = None, type: Optional[str] = None, displayName: Optional[str] = None, operation: Optional[str] = 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: Optional[str]
member_type: Optional[str]
display_name: Optional[str]
operation: Optional[str]
class wxc_sdk.groups.Group(*, id: Optional[str] = None, displayName: Optional[str] = None, members: Optional[list[wxc_sdk.groups.GroupMember]] = None, orgId: Optional[str] = None, description: Optional[str] = None, created: Optional[datetime] = None, lastModified: Optional[datetime] = None, memberSize: Optional[int] = None, usage: Optional[str] = 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: Optional[str]
display_name: Optional[str]
members: Optional[list[wxc_sdk.groups.GroupMember]]
org_id: Optional[str]
description: Optional[str]
created: Optional[datetime]
last_modified: Optional[datetime]
member_size: Optional[int]
usage: Optional[str]
class wxc_sdk.groups.GroupsApi(*, session: RestSession, base: Optional[str] = None)[source]

Bases: ApiChild

list(include_members: Optional[bool] = None, attributes: Optional[str] = None, sort_by: Optional[str] = None, sort_order: Optional[str] = None, list_filter: Optional[str] = None, org_id: Optional[str] = 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: Optional[bool] = 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: Optional[Group] = None, remove_all: Optional[bool] = 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