MambuPy.api.interfaces

Interfaces for Mambu Objects.

Classes

MambuAttachable()	An entity which can attach documents
MambuCommentable()	An entity which allows comments endpoints
MambuHolder()
MambuOwnable()	An entity which allows to be 'owned' by another.
MambuOwner()
MambuSearchable()	An entity which allows searching endpoint
MambuWritable()	An entity which allows basic write operations

class MambuPy.api.interfaces.MambuAttachable

Bases: ABC

An entity which can attach documents

__abstractmethods__ = frozenset({'attach_document'})

__dict__ = mappingproxy({'__module__': 'MambuPy.api.interfaces', '__doc__': 'An entity which can attach documents', 'attach_document': <function MambuAttachable.attach_document>, '__dict__': <attribute '__dict__' of 'MambuAttachable' objects>, '__weakref__': <attribute '__weakref__' of 'MambuAttachable' objects>, '__abstractmethods__': frozenset({'attach_document'}), '_abc_impl': <_abc_data object>, '__annotations__': {}})

__module__ = 'MambuPy.api.interfaces'

__weakref__

list of weak references to the object (if defined)

_abc_impl = <_abc_data object>

abstract attach_document(filename, title='', notes='')

uploads an attachment to this entity

Parameters:

• filename (str) – path and filename of file to upload as attachment

• title (str) – name to assign to the attached file in Mambu

• notes (str) – notes to associate to the attached file in Mambu

Returns:

Mambu’s response with metadata of the attached document

class MambuPy.api.interfaces.MambuCommentable

Bases: ABC

An entity which allows comments endpoints

__abstractmethods__ = frozenset({})

__dict__ = mappingproxy({'__module__': 'MambuPy.api.interfaces', '__doc__': 'An entity which allows comments endpoints', 'get_comments': <function MambuCommentable.get_comments>, 'comment': <function MambuCommentable.comment>, '__dict__': <attribute '__dict__' of 'MambuCommentable' objects>, '__weakref__': <attribute '__weakref__' of 'MambuCommentable' objects>, '__abstractmethods__': frozenset(), '_abc_impl': <_abc_data object>, '__annotations__': {}})

__module__ = 'MambuPy.api.interfaces'

__weakref__

list of weak references to the object (if defined)

_abc_impl = <_abc_data object>

comment(comment)

get_comments()

Gets comments for this entity

_comments list is cleaned and set with retrieved comments

Parameters:

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

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

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

Returns:

Mambu’s response with retrieved comments

class MambuPy.api.interfaces.MambuHolder

Bases: ABC

__abstractmethods__ = frozenset({})

__dict__ = mappingproxy({'__module__': 'MambuPy.api.interfaces', '__doc__': '', '__dict__': <attribute '__dict__' of 'MambuHolder' objects>, '__weakref__': <attribute '__weakref__' of 'MambuHolder' objects>, '__abstractmethods__': frozenset(), '_abc_impl': <_abc_data object>, '__annotations__': {}})

__module__ = 'MambuPy.api.interfaces'

__weakref__

list of weak references to the object (if defined)

_abc_impl = <_abc_data object>

class MambuPy.api.interfaces.MambuOwnable

Bases: ABC

An entity which allows to be ‘owned’ by another.

An owned entity has an ‘accountHolderKey’ and ‘accountHolderType’ fields.

Because of that, you may call get_accountHolder on the owned entity to instantiate the MambuEntity who owns it.

__abstractmethods__ = frozenset({})

__dict__ = mappingproxy({'__module__': 'MambuPy.api.interfaces', '__doc__': "An entity which allows to be 'owned' by another.\n\n    An owned entity has an 'accountHolderKey' and 'accountHolderType'\n    fields.\n\n    Because of that, you may call get_accountHolder on the owned\n    entity to instantiate the MambuEntity who owns it.\n    ", '_assignEntObjs': <function MambuOwnable._assignEntObjs>, '__dict__': <attribute '__dict__' of 'MambuOwnable' objects>, '__weakref__': <attribute '__weakref__' of 'MambuOwnable' objects>, '__abstractmethods__': frozenset(), '_abc_impl': <_abc_data object>, '__annotations__': {}})

__module__ = 'MambuPy.api.interfaces'

__weakref__

list of weak references to the object (if defined)

_abc_impl = <_abc_data object>

_assignEntObjs(entities, detailsLevel, get_entities, debug)

class MambuPy.api.interfaces.MambuOwner

Bases: ABC

__abstractmethods__ = frozenset({})

__dict__ = mappingproxy({'__module__': 'MambuPy.api.interfaces', '__doc__': '', '__dict__': <attribute '__dict__' of 'MambuOwner' objects>, '__weakref__': <attribute '__weakref__' of 'MambuOwner' objects>, '__abstractmethods__': frozenset(), '_abc_impl': <_abc_data object>, '__annotations__': {}})

__module__ = 'MambuPy.api.interfaces'

__weakref__

list of weak references to the object (if defined)

_abc_impl = <_abc_data object>

class MambuPy.api.interfaces.MambuSearchable

Bases: ABC

An entity which allows searching endpoint

__abstractmethods__ = frozenset({'search'})

__dict__ = mappingproxy({'__module__': 'MambuPy.api.interfaces', '__doc__': 'An entity which allows searching endpoint', 'search': <classmethod object>, '__dict__': <attribute '__dict__' of 'MambuSearchable' objects>, '__weakref__': <attribute '__weakref__' of 'MambuSearchable' objects>, '__abstractmethods__': frozenset({'search'}), '_abc_impl': <_abc_data object>, '__annotations__': {}})

__module__ = 'MambuPy.api.interfaces'

__weakref__

list of weak references to the object (if defined)

_abc_impl = <_abc_data object>

abstract classmethod search(filterCriteria=None, sortingCriteria=None, offset=None, limit=None, paginationDetails='OFF', detailsLevel='BASIC')

search, several entities, filtering criteria allowed

Parameters:

• filterCriteria (list of dicts) – fields according to LoanAccountFilterCriteria schema

• sortingCriteria (dict) – fields according to LoanAccountSortingCriteria

• 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

Returns:

list of instances of an entity with data from Mambu

class MambuPy.api.interfaces.MambuWritable

Bases: ABC

An entity which allows basic write operations

__abstractmethods__ = frozenset({'create', 'patch', 'update'})

__dict__ = mappingproxy({'__module__': 'MambuPy.api.interfaces', '__doc__': 'An entity which allows basic write operations', 'update': <function MambuWritable.update>, 'create': <function MambuWritable.create>, 'patch': <function MambuWritable.patch>, '__dict__': <attribute '__dict__' of 'MambuWritable' objects>, '__weakref__': <attribute '__weakref__' of 'MambuWritable' objects>, '__abstractmethods__': frozenset({'update', 'patch', 'create'}), '_abc_impl': <_abc_data object>, '__annotations__': {}})

__module__ = 'MambuPy.api.interfaces'

__weakref__

list of weak references to the object (if defined)

_abc_impl = <_abc_data object>

abstract create()

creates a mambu entity

Uses the current values of the _attrs to send to Mambu. Pre-requires that CustomFields are updated previously. Post-requires that CustomFields are extracted again.

abstract patch(fields=None, autodetect_remove=False)

patches a mambu entity

Allows patching of parts of the entity up to Mambu.

fields is a list of the values in the _attrs that will be sent to Mambu

autodetect automatically searches for deleted fields and patches a remove in Mambu.

Pre-requires that CustomFields are updated previously. Post-requires that CustomFields are extracted again.

Parameters:

• fields (list of str) – list of ids of fields to explicitly patch

• autodetect_remove (bool) – False: if deleted fields, don’t remove them True: if delete field, remove them

Autodetect operation, for any field (every field if fields param is None):

• ADD: in attrs, but not in resp

• REPLACE: in attrs, and in resp

• REMOVE: not in attrs, but in resp

• MOVE: not yet implemented (how to autodetect? request needs ‘from’ element)

Raises:

MambuPyError – if field not in attrrs, and not in resp

abstract update()

updates a mambu entity

Uses the current values of the _attrs to send to Mambu. Pre-requires that CustomFields are updated previously. Post-requires that CustomFields are extracted again.