User¶
-
class
moco_wrapper.models.
User
(moco)¶ Class for handling users.
-
create
(firstname: str, lastname: str, email: str, password: str, unit_id: int, active: bool = None, external: bool = None, language: str = None, mobile_phone: str = None, work_phone: str = None, home_address: str = None, birthday: datetime.date = None, tags: list = None, custom_properties: dict = None, info: str = None)¶ Creates a new user.
Parameters: - firstname (str) – First name of the user
- lastname (str) – Last name of the user
- email (str) – Email address
- password (str) – Password to use when creating the user
- unit_id (int) – Id of the unit/team the user belongs to
- active (bool) – If the user should be activated or not (default
None
) - external (bool) – If the user is an employee or an external employee
(his user id will now show up in reports etc.) (default
None
) - language (str) – de, de-AT, de-CH, en, it or fr (default
None
) - mobile_phone (str) – Mobile phone number (default
None
) - work_phone (str) – Work phone number (default
None
) - home_address (str) – Physical home address (default
None
) - birthday (datetime.date, str) – Birthday date (default
None
) - tags (list) – List of additional tags (default
None
) - custom_properties (dict) – Custom fields to add to the user (default
None
) - info (str) – Additional information about the user (default
None
)
Returns: The created user object
Return type:
-
delete
(user_id: int)¶ Deletes an existing user.
Parameters: user_id (int) – Id of the user to delete Returns: Empty response on success Return type: moco_wrapper.util.response.EmptyResponse
-
static
endpoints
() → List[moco_wrapper.util.endpoint.endpoint.Endpoint]¶ Returns all endpoints associated with the model
Returns: List of Endpoint objects Return type: moco_wrapper.util.endpoint.Endpoint
-
get
(user_id: int)¶ Get a single user.
Parameters: user_id (int) – Id of the user Returns: Single user object Return type: moco_wrapper.util.response.ObjectResponse
-
getlist
(include_archived: bool = None, sort_by: str = None, sort_order: str = 'asc', page: int = 1)¶ Get a list of users.
Parameters: - include_archived (bool) – Include archived users in the list (default
None
) - sort_by (str) – Sort by key (default
None
) - sort_order (str) – asc or desc (default
"asc"
) - page (int) – Page number (default
1
)
Returns: List of users
Return type: - include_archived (bool) – Include archived users in the list (default
-
performance_report
(user_id: int, year: int = None)¶ Return a year-based performance report for the given user
Parameters: - user_id (int) – Id of the user to generate the performance report for
- year (int (default
None
)) – Year to generate the report for
Returns: Performance report
Return type: Note
If the year is
None
the report will be generated for the current year
-
update
(user_id, firstname: str = None, lastname: str = None, email: str = None, password: str = None, unit_id: int = None, active: bool = None, external: bool = None, language: str = None, mobile_phone: str = None, work_phone: str = None, home_address: str = None, birthday: datetime.date = None, tags: list = None, custom_properties: dict = None, info: str = None)¶ Updates an existing user.
Parameters: - user_id (int) – the Id of the user
- firstname (str) – First name of the user (default
None
) - lastname (str) – Last name of the user (default
None
) - email (str) – Email address (default
None
) - password (str) – Password to use when creating the user (default
None
) - unit_id (int) – Id of the unit/team the user belongs to (default
None
) - active (bool) – If the user should be activated or not (default
None
) - external (bool) – If the user is an employee or an external employee
(his user id will now show up in reports etc.) (default
None
) - language (str) – de, de-AT, de-CH, en, it or fr (default
None
) - mobile_phone (str) – Mobile phone number (default
None
) - work_phone (str) – Work phone number (default
None
) - home_address (str) – Physical home address (default
None
) - birthday (datetime.date, str) – Birthday date (default
None
) - tags (list) – List of additional tags (default
None
) - custom_properties (dict) – Custom fields to add to the user (default
None
) - info (str) – Additional information about the user (default
None
)
Returns: The updated user object
Return type:
-