MambuPy.api.mambuuser

MambuUser entity: a MambuEntity struct for Users.

Classes

MambuUser(**kwargs)

MambuUser entity

class MambuPy.api.mambuuser.MambuUser(**kwargs)

Bases: MambuEntity, MambuEntityWritable, MambuEntityAttachable, MambuEntityCommentable, MambuOwner

MambuUser entity

__abstractmethods__ = frozenset({})

__getattribute__(name)

Object-like get attribute for MambuUsers.

__init__(**kwargs)

__module__ = 'MambuPy.api.mambuuser'

__repr__()

Prints class and name of role

_abc_impl = <_abc_data object>

_entities = [('assignedBranchKey', 'mambubranch.MambuBranch', 'assignedBranch'), ('role', 'mamburole.MambuRole', 'role')]

3-tuples of elements and Mambu Entities

_filter_keys = ['branchId']

allowed filters for get_all filtering

_ownerType = 'USER'

owner type of this entity

_prefix = 'users'

prefix constant for connections to Mambu

_sortBy_fields = []

allowed fields for get_all sorting

_updateVOs()

Updates role, and the loops _vos list to update corresponding data

classmethod get_all(filters=None, offset=None, limit=None, paginationDetails='OFF', detailsLevel='BASIC', sortBy=None, branchIdType=None)

get_all, several entities, filtering allowed

Parameters:

• filters (dict) – key-value filters, dependes on each entity (keys must be one of the _filter_keys)

• offset (int) – pagination, index to start searching

• limit (int) – pagination, number of elements to retrieve

• paginationDetails (str ON/OFF) – ask for details on pagination

• detailsLevel (str BASIC/FULL) – ask for extra details or not

• sortBy (str) – field1:ASC,field2:DESC, sorting criteria for results (fields must be one of the _sortBy_fields)

• branchIdType (str ASSIGNED/MANAGE) – search assigned users or also those who can manage a branch

Returns:

list of instances of an entity with data from Mambu