clerie/mitel_ommclient2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update API documentation

Browse Source
This commit is contained in:
clerie 2022-01-17 12:29:14 +01:00
parent 8d2e94f5f3
commit e6f93150a0
4 changed files with 21 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,6 +1,6 @@
# Mitel OMMClient2 # 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 ## Quicksart
@ -16,10 +16,10 @@ c = mitel_ommclient2.OMMClient2("omm.local", "admin", "admin")
c.ping() c.ping()
# Create custom messages # 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 # 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. Consult class documentation for more in depth examples and options.

16
docs/api/mitel_ommclient2.messages.rst
View File

@ -4,6 +4,22 @@ mitel\_ommclient2.messages package
Submodules 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 mitel\_ommclient2.messages.open module
-------------------------------------- --------------------------------------

8
docs/api/mitel_ommclient2.rst
View File

@ -36,14 +36,6 @@ mitel\_ommclient2.exceptions module
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
mitel\_ommclient2.session module
--------------------------------
.. automodule:: mitel_ommclient2.session
:members:
:undoc-members:
:show-inheritance:
Module contents Module contents
--------------- ---------------

4
docs/api/modules.rst
View File

@ -1,7 +1,7 @@
.. _api: .. _api:
mitel_ommclient2 API Documentation
================ =================
.. toctree:: .. toctree::
:maxdepth: 4 :maxdepth: 4