mitel_ommclient2.messages package

class mitel_ommclient2.messages.Message(name=None, attrs={}, childs={})

Bases: object

Base message class

Parameters:

  • name – Name of the message

  • attrs – Message attributes

  • childs – Message children

BASE_FIELDS = {}
CHILDS = {}
class Childs(child_types, child_dict)

Bases: object

Contains message childs

CHILDS = {}
FIELDS = {}
class mitel_ommclient2.messages.Request(name=None, attrs={}, childs={})

Bases: Message

Request message type class

BASE_FIELDS = {'seq': <class 'int'>}
class mitel_ommclient2.messages.Response(name=None, attrs={}, childs={})

Bases: Message

Response message type class

BASE_FIELDS = {'bad': None, 'errCode': None, 'info': None, 'maxLen': None, 'seq': <class 'int'>}
raise_on_error()

Raises an exception if the response contains an error.

Usage:

>>> try:
>>>     r.raise_on_error()
>>> except mitel_ommclient2.exceptions.EAuth as e:
>>>     print("We don't care about authentication!")

See children of mitel_ommclient2.exceptions.OMResponseException for all possible exceptions.

mitel_ommclient2.messages.construct(request)

Builds the XML message DOM and returns as string

mitel_ommclient2.messages.parse(message)
mitel_ommclient2.messages.request_type(c)
mitel_ommclient2.messages.response_type(c)
class mitel_ommclient2.messages.getaccount.GetAccount(name=None, attrs={}, childs={})

Bases: Request

FIELDS = {'id': <class 'int'>, 'maxRecords': <class 'int'>}
class mitel_ommclient2.messages.getaccount.GetAccountResp(name=None, attrs={}, childs={})

Bases: Response

CHILDS = {'account': <class 'mitel_ommclient2.types.AccountType'>}
class mitel_ommclient2.messages.getppdev.GetPPDev(name=None, attrs={}, childs={})

Bases: Request

FIELDS = {'maxRecords': <class 'int'>, 'ppn': <class 'int'>}
class mitel_ommclient2.messages.getppdev.GetPPDevResp(name=None, attrs={}, childs={})

Bases: Response

CHILDS = {'pp': <class 'mitel_ommclient2.types.PPDevType'>}
class mitel_ommclient2.messages.getppuser.GetPPUser(name=None, attrs={}, childs={})

Bases: Request

FIELDS = {'maxRecords': <class 'int'>, 'uid': <class 'int'>}
class mitel_ommclient2.messages.getppuser.GetPPUserResp(name=None, attrs={}, childs={})

Bases: Response

CHILDS = {'user': <class 'mitel_ommclient2.types.PPUserType'>}
class mitel_ommclient2.messages.open.Open(name=None, attrs={}, childs={})

Bases: Request

FIELDS = {'UserDeviceSyncClient': None, 'password': None, 'username': None}
class mitel_ommclient2.messages.open.OpenResp(name=None, attrs={}, childs={})

Bases: Response

FIELDS = {'minPPSwVersion1': None, 'minPPSwVersion2': None, 'ommStbState': None, 'protocolVersion': None, 'publicKey': None}
class mitel_ommclient2.messages.ping.Ping(name=None, attrs={}, childs={})

Bases: Request

FIELDS = {'timeStamp': <class 'int'>}
class mitel_ommclient2.messages.ping.PingResp(name=None, attrs={}, childs={})

Bases: Response

FIELDS = {'timeStamp': <class 'int'>}