Employees

TagmeClientAdvanced.add_employee_to_organization(person_id: str, roles: List[str] = None, organization_id: str = None, ) → Employee

Add new employee to organization.

Parameters

* person_id – person id to add to organization.

* roles – roles to add to person (CUSTOMER, ORGANIZATION_ADMIN). If set to None or [], person will be added as marker.

* organization_id – optional organization identifier. Defaults to None.

Returns

employee information.

Return type

Employee

TagmeClientAdvanced.get_employee(user_id: str, organization_id: str | None = None, ) → Employee

Get information about organization’s employee.

Parameters

* user_id – user id.

* organization_id – optional organization identifier. Defaults to None.

Returns

employee information.

Return type

Employee

TagmeClientAdvanced.get_employee_info(employee_id: str, with_pools: bool | None = None, with_info: bool | None = None, organization_id: str | None = None, ) → Employee

Get full information about employee.

Parameters

* employee_id – employee id.

* with_pools – If set to True, load employee’s pools. Defaults to None.

* with_info – if set to true, load personal info. Defaults to None.

* organization_id – optional organization identifier. Defaults to None.

Returns

full information about employee.

TagmeClientAdvanced.get_employees(query: str | None = None, person_ids: List[str] | None = None, with_pools: bool | None = None, with_info: bool | None = None, organization_id: str | None = None, page: int | None = None, size: int | None = None, active: bool | None = None, ) → List[Employee]

Get information about employees.

Parameters

* query – search query. Defaults to None.

* person_ids – person ids. Defaults to None.

* with_pools – If set to True, load employee’s pools. Defaults to None.

* with_info – If set to True, load personal info. Defaults to None.

* organization_id – optional organization identifier. Defaults to None.

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

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

* active – If set to True, get only active employees. Defaults to None.

Returns

list of employees.

TagmeClientAdvanced.get_marker_info(marker_id: str, with_pools: bool, with_info: bool, organization_id: str | None = None, ) → Employee

Get full information about organization employee.

Parameters

* marker_id – marker id.

* with_pools – if set, return information about marker pools.

* with_info – if set, return person info about marker.

* organization_id – optional organization identifier. Defaults to None.

Returns

full information about marker.

TagmeClientAdvanced.get_user_config(user_id: str, organization_id: str | None = None, ) → Dict[str, Any]

Get employee config.

Parameters

* user_id – user id.

* organization_id – optional organization identifier. Defaults to None.

Returns

employee config.

TagmeClientAdvanced.get_user_info(user_id: str, organization_id: str | None = None, ) → Employee

Get information about employee.

Parameters

* user_id – user id.

* organization_id – optional organization identifier. Defaults to None.

Returns

information about employee.

TagmeClientAdvanced.get_user_profile(user_id: str, organization_id: str | None = None, ) → Dict[str, Any]

Get user profile.

Parameters

* user_id – user id.

* organization_id – optional organization identifier. Defaults to None.

Returns

user profile.

TagmeClientAdvanced.get_user_report(user_id: str, organization_id: str | None = None, ) → Dict[str, Any]

Get user report

Parameters

* user_id – user id.

* organization_id – optional organization identifier. Defaults to None.

Returns

user report.

TagmeClientAdvanced.set_user_config(user_id: str, config: Dict[str, Any], organization_id: str | None = None, ) → None

Set employee config.

Parameters

* user_id – user id.

* config – employee config.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.set_user_profile(user_id: str, profile: Dict[str, Any], organization_id: str | None = None, ) → None

Set user profile.

Parameters

* user_id – user id.

* profile – user profile.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.set_user_report(user_id: str, report: Dict[str, Any], organization_id: str | None = None, ) → None

Set user report.

Parameters

* user_id – user id.

* report – user report.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.set_user_roles(user_id: str, roles: List[str] | None, organization_id: str | None = None, ) → None

Set user roles.

Parameters

* user_id – user id.

* roles – list of user roles. Available roles are: ‘CUSTOMER’, ‘ORGANIZATION_ADMIN’, pass empty list to set marker role.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.update_user_config(user_id: str, config: Dict[str, Any], organization_id: str | None = None, ) → None

Update employee config.

Parameters

* user_id – user id.

* config – employee config.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.update_user_profile(user_id: str, profile: Dict[str, Any], organization_id: str | None = None, ) → None

Update user profile.

Parameters

* user_id – user id.

* profile – user profile.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.update_user_report(user_id: str, report: Dict[str, Any], organization_id: str | None = None, ) → None

Update user report.

Parameters

* user_id – user id.

* report ( Dict [ str , * *Any ]) – user report.

* organization_id – optional organization identifier. Defaults to None.