Pools

TagmeClientAdvanced.add_marker(marker_email: str, pools: List[str], organization_id: str | None = None, ) → ErrorMarkersResponse

Add marker to pools.

Parameters

* marker_email – marker email.

* pools – pools to add marker to.

* organization_id – optional organization identifier. Defaults to None.

Returns

object with errors while adding marker to pools.

TagmeClientAdvanced.add_markers(emails: List[str], pools: List[str], organization_id: str | None = None, ) → ErrorMarkersResponse

Add markers to pools.

Parameters

* emails – emails of markers.

* pools – pools to add markers to.

* organization_id – optional organization identifier. Defaults to None.

Returns

object with errors while adding markers to pools.

TagmeClientAdvanced.add_pools(project_id: str, pools: Sequence[str], organization_id: str | None = None, ) → None

Add pools of users to project.

Parameters

* project_id – project id to add pools to

* pools – pools ids to add to project

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.attach_user_to_pool(pool_id: str, user_id: str, organization_id: str | None = None, ) → bool

Add user to pool.

Parameters

* pool_id – pool id to add user to.

* user_id – user id to add to pool.

* organization_id – optional organization identifier. Defaults to None.

Returns

True if user was successfully added to pool, False otherwise.

TagmeClientAdvanced.clone_pool(pool_id: str, organization_id: str | None = None, dst_organization_id: str | None = None, ) → Pool

Clone pool with members.

Parameters

* pool_id – pool id to clone.

* organization_id – optional organization identifier. Defaults to None.

* dst_organization_id – optional organization id to clone pool to. Defaults to None.

Returns

created pool.

TagmeClientAdvanced.create_pool(markers: List[str], name: str, organization_id: str | None = None, ) → Pool

Create new pool

Parameters

* markers – list of users ids to add to new pool.

* name – new pool name.

* organization_id – optional organization identifier. Defaults to None.

Returns

information about newly created pool.

TagmeClientAdvanced.delete_pool(pool_id: str, organization_id: str | None = None, ) → None

Delete pool.

Parameters

* pool_id – pool id.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.detach_markers(pool_id: str, uids: List[str], organization_id: str | None = None, ) → ErrorMarkersResponse

Remove users from pool.

Parameters

* pool_id – pool id to remove users from.

* uids – list of users ids to remove from pool.

* organization_id – optional organization identifier. Defaults to None.

Returns

object which contains information about errors while removing users from pool.

TagmeClientAdvanced.detach_user_from_pool(pool_id: str, user_id: str, organization_id: str | None = None, ) → bool

Remove user from pool.

Parameters

* pool_id – pool id to remove user from.

* user_id – user id to remove from pool.

* organization_id – optional organization identifier. Defaults to None.

Returns

True if user was successfully removed from pool, False otherwise.

TagmeClientAdvanced.get_organization_pools(organization_id: str | None = None, page: int | None = None, size: int | None = None, query: str | None = None, ) → List[Pool]

Get pool in selected organization.

Parameters

* organization_id – optional organization identifier. Defaults to None.

* page – page number for pagination. Defaults to None.

* size – page size for pagination. Defaults to None.

* query – query to search by name or uid. Defaults to None.

Returns

list of pools.

TagmeClientAdvanced.get_pool(pool_id: str, with_markers: bool | None = None, organization_id: str | None = None, ) → Pool

Get information about pool by id.

Parameters

* pool_id – pool id.

* with_markers – if True, return list of users in pool.

* organization_id – optional organization identifier. Defaults to None.

Returns

information about pool.

TagmeClientAdvanced.get_pools(project_id: str, organization_id: str | None = None, ) → List[str]

Get pools added to project.

Parameters

* project_id – project id.

* organization_id – optional organization identifier. Defaults to None.

Returns

list of pools.

TagmeClientAdvanced.move_markers(pool_id: str, target_pool: str, uids: List[str], organization_id: str | None = None, ) → ErrorMarkersResponse

Move users from one pool to another.

Parameters

* pool_id – pool id to move users from.

* target_pool – pool id to move users to.

* uids – list of users ids to move from pool to target pool.

* organization_id – optional organization identifier. Defaults to None.

Returns; object which contains information about errors while moving users from pool to target pool.

TagmeClientAdvanced.update_pool(pool_id: str, name: str, organization_id: str | None = None, ) → Pool

Update pool name.

Parameters

* pool_id – pool id.

* name – new pool name.

* organization_id – optional organization identifier. Defaults to None.

Returns

information about updated pool.