Update API documentation
This commit is contained in:
parent
8d2e94f5f3
commit
e6f93150a0
@ -1,6 +1,6 @@
|
||||
# Mitel OMMClient2
|
||||
|
||||
Another attempt for a client library to the Mitel OM Application XML Interface.
|
||||
Another attempt for a modern client library to the Mitel OM Application XML Interface.
|
||||
|
||||
## Quicksart
|
||||
|
||||
@ -16,10 +16,10 @@ c = mitel_ommclient2.OMMClient2("omm.local", "admin", "admin")
|
||||
c.ping()
|
||||
|
||||
# Create custom messages
|
||||
r = c.session.request(mitel_ommclient2.messages.Ping(timeStamp=2342))
|
||||
r = c.request(mitel_ommclient2.messages.Ping(timeStamp=2342))
|
||||
|
||||
# Craft your own request, if it is not implemented yet
|
||||
r = c.session.request(mitel_ommclient2.messages.DictRequest("Ping", {"timeStamp": 2342}))
|
||||
r = c.request(mitel_ommclient2.messages.DictRequest("Ping", {"timeStamp": 2342}))
|
||||
```
|
||||
|
||||
Consult class documentation for more in depth examples and options.
|
||||
|
@ -4,6 +4,22 @@ mitel\_ommclient2.messages package
|
||||
Submodules
|
||||
----------
|
||||
|
||||
mitel\_ommclient2.messages.getaccount module
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: mitel_ommclient2.messages.getaccount
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
mitel\_ommclient2.messages.getppdev module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: mitel_ommclient2.messages.getppdev
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
mitel\_ommclient2.messages.open module
|
||||
--------------------------------------
|
||||
|
||||
|
@ -36,14 +36,6 @@ mitel\_ommclient2.exceptions module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
mitel\_ommclient2.session module
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: mitel_ommclient2.session
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
|
@ -1,7 +1,7 @@
|
||||
.. _api:
|
||||
|
||||
mitel_ommclient2
|
||||
================
|
||||
API Documentation
|
||||
=================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
Loading…
Reference in New Issue
Block a user