From e6f93150a016e48fd9e4fd96e87f986cb0be4500 Mon Sep 17 00:00:00 2001 From: clerie Date: Mon, 17 Jan 2022 12:29:14 +0100 Subject: [PATCH] Update API documentation --- README.md | 6 +++--- docs/api/mitel_ommclient2.messages.rst | 16 ++++++++++++++++ docs/api/mitel_ommclient2.rst | 8 -------- docs/api/modules.rst | 4 ++-- 4 files changed, 21 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 9d4b262..aa64791 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/api/mitel_ommclient2.messages.rst b/docs/api/mitel_ommclient2.messages.rst index 2d29b75..a762320 100644 --- a/docs/api/mitel_ommclient2.messages.rst +++ b/docs/api/mitel_ommclient2.messages.rst @@ -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 -------------------------------------- diff --git a/docs/api/mitel_ommclient2.rst b/docs/api/mitel_ommclient2.rst index 1833985..743f0c1 100644 --- a/docs/api/mitel_ommclient2.rst +++ b/docs/api/mitel_ommclient2.rst @@ -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 --------------- diff --git a/docs/api/modules.rst b/docs/api/modules.rst index 97c3221..53ff653 100644 --- a/docs/api/modules.rst +++ b/docs/api/modules.rst @@ -1,7 +1,7 @@ .. _api: -mitel_ommclient2 -================ +API Documentation +================= .. toctree:: :maxdepth: 4