Skills

TagmeClientAdvanced.create_skill(name: str, organization_id: str | None = None, is_public: bool = False, ) → Skill

Create new skill with given name.

Parameters

* name – skill name.

* organization_id – optional organization identifier. Defaults to None.

* is_public – is skill public. Defaults to False.

Returns

created skill.

TagmeClientAdvanced.disable_skill(skill_id: str, organization_id: str | None = None, ) → None

Disable skill.

Parameters

* skill_id – skill id to disable.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.enable_skill(skill_id: str, organization_id: str | None = None, ) → None

Enable skill.

Parameters

* skill_id – skill id to enable.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.get_markers_skills_list(query: str | None = None, size: int | None = None, page: int | None = None, organization_id: str | None = None, with_info: bool | None = None, ) → List[MarkerSkill]

Get list of markers’ skills and their values.

Parameters

* query – search query for skill name. Defaults to None.

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

Returns

markers with their skills and skills’ values.

TagmeClientAdvanced.get_public_skills_list(query: str | None = None, size: int | None = None, page: int | None = None, ) → List[PublicSkill]

Get list of markers’ skills and their values.

Parameters

* query – search query for skill name. Defaults to None.

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

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

Returns

markers with their skills and skills’ values.

TagmeClientAdvanced.get_skill(skill_id: str, organization_id: str | None = None, ) → Skill

Get information about skill by skill id.

Parameters

* skill_id – skill id to get information about.

* organization_id – optional organization identifier. Defaults to None.

Returns

information about skill.

TagmeClientAdvanced.get_skills_list(query: str | None = None, with_markers_count: bool | None = None, organization_id: str | None = None, size: int | None = None, page: int | None = None, ) → List[Skill]

Get all available skills.

Parameters

* query – search query for skill name.

* with_markers_count – include markers count which has this skill in response.

* organization_id – optional organization id. Defaults to None.

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

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

Returns

list of skills.

TagmeClientAdvanced.rename_skill(skill_name: str, target_name: str, organization_id: str | None = None, ) → Skill

Find skill by name and rename it. Only first found skill will be updated.

Parameters

* skill_name – skill name to search by.

* target_name – new skill name.

* organization_id – optional organization identifier. Defaults to None.

Returns

information about updated skill.

TagmeClientAdvanced.set_marker_skill(marker_id: str, skill_id: str, value: int, organization_id: str | None = None, ) → SetMarkerSkillResponse

Add skill and its value to marker.

Parameters

* marker_id – marker id to add skill to.

* skill_id – skill id to add to marker.

* value – skill value from 0 to 100.

* organization_id – organization identifier. Defaults to None.

Returns

object which contains person_id, skill_id and skill value.

TagmeClientAdvanced.set_markers_skills(table_path: Path | str, organization_id: str | None = None, ) → SetMarkersSkillsResponse

Add skills to markers from table with columns ‘person’, ‘skill’, ‘value’.

Parameters table_path – path to table with markers skill data to import.

Returns

object which contains information about successfull updates and errors.

TagmeClientAdvanced.set_markers_skills_json(json_data: List[Dict[str, Any]], organization_id: str | None = None, ) → SetMarkersSkillsResponse

Add skills to markers via list with objects inside.

Parameters json_data – list of dicts with fields ‘person’, ‘skill’, ‘value’.

Returns

object which contains information about successfull updates and errors.

TagmeClientAdvanced.update_skill(skill_id: str, name: str, window_size: int = 10, is_public: bool = False, organization_id: str | None = None, ) → Skill

Update information about skill.

Parameters

* skill_id – skill id to update.

* name – new skill name.

* window_size – new skill window size.

* is_public – is skill public. Defaults to False.

* organization_id – optional organization identifier. Defaults to None.

Returns

information about updated skill.