python-terminusgps 20.5.0__tar.gz → 20.5.2__tar.gz

{python_terminusgps-20.5.0 → python_terminusgps-20.5.2}/.gitignore

@@ -1,5 +1,6 @@
 .*
 !.gitignore
+!.readthedocs.yaml
 
 # Python-generated files
 __pycache__/

python_terminusgps-20.5.2/.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: pyproject.toml

{python_terminusgps-20.5.0 → python_terminusgps-20.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 20.5.0
+Version: 20.5.2
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://app.terminusgps.com/docs/apps/python-terminusgps/index.html
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

python_terminusgps-20.5.2/docs/requirements.txt

@@ -0,0 +1,54 @@
+aiohappyeyeballs==2.4.6
+aiohttp==3.11.12
+aiohttp-retry==2.9.1
+aiosignal==1.3.2
+alabaster==1.0.0
+argparse==1.4.0
+asgiref==3.8.1
+attrs==25.1.0
+authorizenet==1.1.5
+babel==2.17.0
+beautifulsoup4==4.13.3
+boto3==1.36.23
+botocore==1.36.23
+certifi==2025.1.31
+charset-normalizer==3.4.1
+django==5.1.6
+docutils==0.21.2
+frozenlist==1.5.0
+future==1.0.0
+idna==3.10
+imagesize==1.4.1
+jinja2==3.1.5
+jmespath==1.0.1
+lxml==4.9.4
+markupsafe==3.0.2
+multidict==6.1.0
+packaging==24.2
+propcache==0.2.1
+pygments==2.19.1
+pyjwt==2.10.1
+python-dateutil==2.9.0.post0
+-e file:///home/blake/Projects/python-terminusgps
+python-wialon==1.2.4
+pyxb-x==1.2.6.3
+requests==2.32.3
+roman-numerals-py==3.0.0
+s3transfer==0.11.2
+simplejson==3.20.1
+six==1.17.0
+snowballstemmer==2.2.0
+soupsieve==2.6
+sphinx==8.2.0
+sphinxawesome-theme==5.3.2
+sphinxcontrib-applehelp==2.0.0
+sphinxcontrib-devhelp==2.0.0
+sphinxcontrib-htmlhelp==2.1.0
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==2.0.0
+sphinxcontrib-serializinghtml==2.0.0
+sqlparse==0.5.3
+twilio==9.4.5
+typing-extensions==4.12.2
+urllib3==2.3.0
+yarl==1.18.3

python_terminusgps-20.5.2/docs/source/authorizenet/profiles.rst

@@ -0,0 +1,22 @@
+Profiles
+========
+
+.. autoclass:: terminusgps.authorizenet.profiles.base.AuthorizenetProfileBase
+   :members:
+   :private-members:
+
+.. autoclass:: terminusgps.authorizenet.profiles.base.AuthorizenetSubProfileBase
+   :members:
+   :private-members:
+   
+.. autoclass:: terminusgps.authorizenet.profiles.addresses.AddressProfile
+   :members:
+   :private-members:
+
+.. autoclass:: terminusgps.authorizenet.profiles.customers.CustomerProfile
+   :members:
+   :private-members:
+
+.. autoclass:: terminusgps.authorizenet.profiles.payments.PaymentProfile
+   :members:
+   :private-members:

{python_terminusgps-20.5.0 → python_terminusgps-20.5.2}/docs/source/conf.py

@@ -9,7 +9,7 @@
 project = "python-terminusgps"
 copyright = "2025, Terminus GPS, LLC"
 author = "Terminus GPS, LLC"
-release = "20.5.0"
+release = "20.5.1"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -36,5 +36,6 @@ exclude_patterns = []
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinxawesome_theme"
+html_permalinks_icon = "<span>#</span>"
 html_static_path = ["_static"]

{python_terminusgps-20.5.0 → python_terminusgps-20.5.2}/docs/source/index.rst

@@ -6,6 +6,23 @@
 python-terminusgps documentation
 ================================
 
+============
+Installation
+============
+
+Use pip to install from `PyPI <https://pypi.org/project/python-terminusgps/>`_.
+
+.. code:: bash
+
+   pip install python-terminusgps
+
+In Python, all subpackages are nested within :py:mod:`terminusgps`:
+
+.. code:: python
+
+   from terminusgps.aws.secrets import get_secret
+   from terminusgps.wialon.session import WialonSession
+
 .. toctree::
     :maxdepth: 2
     :caption: Contents:

python_terminusgps-20.5.2/docs/source/wialon/examples.rst

@@ -0,0 +1,161 @@
+Usage Examples
+==============
+
+===============================
+Create a new unit and rename it
+===============================
+
+1. Import :py:obj:`~terminusgps.wialon.session.WialonSession` and :py:obj:`~terminusgps.wialon.items.WialonUnit`.
+
+Let's also import :py:obj:`~terminusgps.wialon.utils.generate_wialon_password` so we don't have to come up with a valid Wialon password ourselves.
+
+.. code:: python
+
+    from terminusgps.wialon.session import WialonSession
+    from terminusgps.wialon.items import WialonUnit
+    from terminusgps.wialon.utils import generate_wialon_password
+
+2. Open the session in a context manager and instantiate a unit.
+
+.. code:: python
+
+    with WialonSession(token="my_wialon_api_token") as session:
+        unit = WialonUnit(
+            id=None,
+            session=session,
+            creator_id="123",
+            name="test_user",
+            password=generate_wialon_password(32)
+        )
+        print(f"{unit.name = }") # unit.name = "test_user"
+
+3. Within the context manager, :py:obj:`~terminusgps.wialon.items.WialonUnit` methods can be executed.
+
+.. code:: python
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        ...
+
+        unit.rename("super_test_user")
+        # Session is logged out after exiting scope
+
+-----------------
+Full code example
+-----------------
+
+.. code:: python
+
+    from terminusgps.wialon.session import WialonSession
+    from terminusgps.wialon.items import WialonUnit
+    from terminusgps.wialon.utils import generate_wialon_password
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        unit = WialonUnit(
+            id=None,
+            session=session,
+            creator_id="123",
+            name="test_user",
+            password=generate_wialon_password(32)
+        )
+        unit.rename("super_test_user")
+
+
+============================================
+Create an account and migrate a unit into it
+============================================
+
+1. Import :py:obj:`~terminusgps.wialon.session.WialonSession`, :py:mod:`~terminusgps.wialon.items`, and :py:mod:`~terminusgps.wialon.constants`.
+
+.. code:: python
+
+    from terminusgps.wialon.session import WialonSession
+    from terminusgps.wialon import items, constants
+
+2. Create an account user.
+
+.. code:: python
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        account_user = items.WialonUser(
+            id=None,
+            session=session,
+            creator_id="27884511", # Admin user id
+            name="account_user",
+            password="super_secure_password1!",
+        )
+
+3. Create a resource using the account user.
+
+.. code:: python
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        ...
+        account_resource = items.WialonResource(
+            id=None,
+            session=session,
+            creator_id=account_user.id,
+            name="account_resource",
+        )
+
+4. Retrieve a :py:obj:`~terminusgps.wialon.items.unit.WialonUnit`.
+
+.. code:: python
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        ...
+        unit = items.WialonUnit(id="12345678", session=session)
+
+5. Grant the account user migration permissions.
+
+.. code:: python
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        ...
+        account_user.grant_access(unit, access_mask=constants.ACCESSMASK_UNIT_MIGRATION)
+
+6. Transform the resource into an account and enable it.
+
+.. code:: python
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        ...
+        account_resource.create_account("terminusgps_ext_hist")
+        account_resource.enable()
+
+7. Migrate the unit into the account.
+
+.. code:: python
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        ...
+        account_resource.migrate_unit(unit)
+
+
+-----------------
+Full code example
+-----------------
+
+.. code:: python
+
+    from terminusgps.wialon.session import WialonSession
+    from terminusgps.wialon import items, constants
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        account_user = items.WialonUser(
+            id=None,
+            session=session,
+            creator_id="27884511", # Admin user id
+            name="account_user",
+            password="super_secure_password1!",
+        )
+        account_resource = items.WialonResource(
+            id=None,
+            session=session,
+            creator_id=account_user.id,
+            name="account_resource",
+        )
+        unit = items.WialonUnit(id="12345678", session=session)
+        account_user.grant_access(unit, access_mask=constants.ACCESSMASK_UNIT_MIGRATION)
+        account_resource.create_account("terminusgps_ext_hist")
+        account_resource.enable()
+        account_resource.migrate_unit(unit)

python_terminusgps-20.5.2/docs/source/wialon/flags.rst

@@ -0,0 +1,274 @@
+Flags
+=====
+
+.. currentmodule:: terminusgps.wialon.flags
+
+============
+Access Flags
+============
+
+-------
+General
+-------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#general>`_
+
+.. autodata:: ACCESSFLAG_VIEW_ITEM_BASIC
+.. autodata:: ACCESSFLAG_VIEW_ITEM_DETAILED
+.. autodata:: ACCESSFLAG_MANAGE_ITEM_ACCESS
+.. autodata:: ACCESSFLAG_DELETE_ITEM
+.. autodata:: ACCESSFLAG_RENAME_ITEM
+.. autodata:: ACCESSFLAG_VIEW_CUSTOM_FIELDS
+.. autodata:: ACCESSFLAG_MANAGE_CUSTOM_FIELDS
+.. autodata:: ACCESSFLAG_MANAGE_UNMENTIONED_FIELDS
+.. autodata:: ACCESSFLAG_MANAGE_ICON
+.. autodata:: ACCESSFLAG_QUERY_REPORTS
+.. autodata:: ACCESSFLAG_MANAGE_ACL
+.. autodata:: ACCESSFLAG_MANAGE_ITEM_LOG
+.. autodata:: ACCESSFLAG_VIEW_ADMIN_FIELDS
+.. autodata:: ACCESSFLAG_MANAGE_ADMIN_FIELDS
+.. autodata:: ACCESSFLAG_VIEW_ATTACHED_FILES
+.. autodata:: ACCESSFLAG_MANAGE_ATTACHED_FILES
+
+---------------
+Unit/Unit Group
+---------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#units_and_unit_groups>`_
+
+.. autodata:: ACCESSFLAG_UNIT_MANAGE_CONNECTIVITY
+.. autodata:: ACCESSFLAG_UNIT_MANAGE_SENSORS
+.. autodata:: ACCESSFLAG_UNIT_MANAGE_COUNTERS
+.. autodata:: ACCESSFLAG_UNIT_DELETE_MESSAGES
+.. autodata:: ACCESSFLAG_UNIT_EXECUTE_COMMANDS
+.. autodata:: ACCESSFLAG_UNIT_REGISTER_EVENTS
+.. autodata:: ACCESSFLAG_UNIT_VIEW_CONNECTIVITY
+.. autodata:: ACCESSFLAG_UNIT_VIEW_SERVICE_INTERVALS
+.. autodata:: ACCESSFLAG_UNIT_MANAGE_SERVICE_INTERVALS
+.. autodata:: ACCESSFLAG_UNIT_IMPORT_MESSAGES
+.. autodata:: ACCESSFLAG_UNIT_EXPORT_MESSAGES
+.. autodata:: ACCESSFLAG_UNIT_VIEW_COMMANDS
+.. autodata:: ACCESSFLAG_UNIT_MANAGE_COMMANDS
+.. autodata:: ACCESSFLAG_UNIT_MANAGE_TRIP_DETECTOR
+.. autodata:: ACCESSFLAG_UNIT_MANAGE_ASSIGNMENTS
+
+----
+User
+----
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#users>`_
+
+.. autodata:: ACCESSFLAG_USER_MANAGE_ACCESS_RIGHTS
+.. autodata:: ACCESSFLAG_USER_ACT_AS_OTHER
+.. autodata:: ACCESSFLAG_USER_MANAGE_FLAGS
+.. autodata:: ACCESSFLAG_USER_VIEW_PUSH_MESSAGES
+.. autodata:: ACCESSFLAG_USER_MANAGE_PUSH_MESSAGES
+
+------------
+Retranslator
+------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#retranslators>`_
+
+.. autodata:: ACCESSFLAG_RETRANSLATOR_MANAGE_PROPERTIES
+.. autodata:: ACCESSFLAG_RETRANSLATOR_MANAGE_UNITS
+
+------------------
+Resources/Accounts 
+------------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#resources_accounts>`_
+
+.. autodata:: ACCESSFLAG_RESOURCE_VIEW_NOTIFICATIONS
+.. autodata:: ACCESSFLAG_RESOURCE_MANAGE_NOTIFICATIONS
+.. autodata:: ACCESSFLAG_RESOURCE_VIEW_POIS
+.. autodata:: ACCESSFLAG_RESOURCE_MANAGE_POIS
+.. autodata:: ACCESSFLAG_RESOURCE_VIEW_GEOFENCES
+.. autodata:: ACCESSFLAG_RESOURCE_MANAGE_GEOFENCES
+.. autodata:: ACCESSFLAG_RESOURCE_VIEW_JOBS
+.. autodata:: ACCESSFLAG_RESOURCE_MANAGE_JOBS
+.. autodata:: ACCESSFLAG_RESOURCE_VIEW_REPORT_TEMPLATES
+.. autodata:: ACCESSFLAG_RESOURCE_MANAGE_REPORT_TEMPLATES
+.. autodata:: ACCESSFLAG_RESOURCE_VIEW_DRIVERS
+.. autodata:: ACCESSFLAG_RESOURCE_MANAGE_DRIVERS
+.. autodata:: ACCESSFLAG_RESOURCE_MANAGE_ACCOUNT
+.. autodata:: ACCESSFLAG_RESOURCE_VIEW_ORDERS
+.. autodata:: ACCESSFLAG_RESOURCE_MANAGE_ORDERS
+.. autodata:: ACCESSFLAG_RESOURCE_VIEW_TRAILERS
+.. autodata:: ACCESSFLAG_RESOURCE_MANAGE_TRAILERS
+
+------
+Routes
+------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#routes>`_
+
+.. autodata:: ACCESSFLAG_ROUTE_MANAGE_ROUTE
+
+-----
+Other
+-----
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#other>`_
+
+.. autodata:: ACCESSFLAG_FULL_ACCESS
+
+==========
+Data Flags
+==========
+
+------------
+Retranslator
+------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/retranslator>`_
+
+.. autodata:: DATAFLAG_RETRANSLATOR_BASE
+.. autodata:: DATAFLAG_RETRANSLATOR_CUSTOM_PROPERTIES
+.. autodata:: DATAFLAG_RETRANSLATOR_BILLING_PROPERTIES
+.. autodata:: DATAFLAG_RETRANSLATOR_GUID
+.. autodata:: DATAFLAG_RETRANSLATOR_ADMIN_FIELDS
+.. autodata:: DATAFLAG_RETRANSLATOR_CONFIGURATION
+.. autodata:: DATAFLAG_RETRANSLATOR_UNITS
+.. autodata:: DATAFLAG_RETRANSLATOR_ALL
+
+
+-----------------
+Resource/Accounts
+-----------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/resource>`_
+
+.. autodata:: DATAFLAG_RESOURCE_BASE
+.. autodata:: DATAFLAG_RESOURCE_CUSTOM_PROPERTIES
+.. autodata:: DATAFLAG_RESOURCE_BILLING_PROPERTIES
+.. autodata:: DATAFLAG_RESOURCE_CUSTOM_FIELDS
+.. autodata:: DATAFLAG_RESOURCE_MESSAGES
+.. autodata:: DATAFLAG_RESOURCE_GUID
+.. autodata:: DATAFLAG_RESOURCE_ADMIN_FIELDS
+.. autodata:: DATAFLAG_RESOURCE_DRIVERS
+.. autodata:: DATAFLAG_RESOURCE_JOBS
+.. autodata:: DATAFLAG_RESOURCE_NOTIFICATIONS
+.. autodata:: DATAFLAG_RESOURCE_POIS
+.. autodata:: DATAFLAG_RESOURCE_GEOFENCES
+.. autodata:: DATAFLAG_RESOURCE_REPORT_TEMPLATES
+.. autodata:: DATAFLAG_RESOURCE_DRIVER_ATTACHABLE_UNITS
+.. autodata:: DATAFLAG_RESOURCE_DRIVER_GROUPS
+.. autodata:: DATAFLAG_RESOURCE_TRAILERS
+.. autodata:: DATAFLAG_RESOURCE_TRAILER_GROUPS
+.. autodata:: DATAFLAG_RESOURCE_TRAILER_ATTACHABLE_UNITS
+.. autodata:: DATAFLAG_RESOURCE_ORDERS
+.. autodata:: DATAFLAG_RESOURCE_GEOFENCE_GROUPS
+.. autodata:: DATAFLAG_RESOURCE_TAGS
+.. autodata:: DATAFLAG_RESOURCE_TAG_ATTACHABLE_UNITS
+.. autodata:: DATAFLAG_RESOURCE_TAG_GROUPS
+.. autodata:: DATAFLAG_RESOURCE_ALL
+
+-----
+Route
+-----
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/route>`_
+
+.. autodata:: DATAFLAG_ROUTE_BASE
+.. autodata:: DATAFLAG_ROUTE_CUSTOM_PROPERTIES
+.. autodata:: DATAFLAG_ROUTE_BILLING_PROPERTIES
+.. autodata:: DATAFLAG_ROUTE_GUID
+.. autodata:: DATAFLAG_ROUTE_ADMIN_FIELDS
+.. autodata:: DATAFLAG_ROUTE_CONFIGURATION
+.. autodata:: DATAFLAG_ROUTE_CHECKPOINTS
+.. autodata:: DATAFLAG_ROUTE_SCHEDULES
+.. autodata:: DATAFLAG_ROUTE_ROUNDS
+.. autodata:: DATAFLAG_ROUTE_ALL
+
+----
+Unit
+----
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/unit>`_
+
+.. autodata:: DATAFLAG_UNIT_BASE
+.. autodata:: DATAFLAG_UNIT_CUSTOM_PROPERTIES
+.. autodata:: DATAFLAG_UNIT_BILLING_PROPERTIES
+.. autodata:: DATAFLAG_UNIT_CUSTOM_FIELDS
+.. autodata:: DATAFLAG_UNIT_IMAGE
+.. autodata:: DATAFLAG_UNIT_MESSAGES
+.. autodata:: DATAFLAG_UNIT_GUID
+.. autodata:: DATAFLAG_UNIT_ADMIN_FIELDS
+.. autodata:: DATAFLAG_UNIT_ADVANCED_PROPERTIES
+.. autodata:: DATAFLAG_UNIT_CURRENT_MOMENT_COMMANDS
+.. autodata:: DATAFLAG_UNIT_LAST_MESSAGE
+.. autodata:: DATAFLAG_UNIT_SENSORS
+.. autodata:: DATAFLAG_UNIT_COUNTERS
+.. autodata:: DATAFLAG_UNIT_MAINTENANCE
+.. autodata:: DATAFLAG_UNIT_REPORT_CONFIGURATION
+.. autodata:: DATAFLAG_UNIT_AVAILABLE_COMMANDS
+.. autodata:: DATAFLAG_UNIT_MESSAGE_PARAMETERS
+.. autodata:: DATAFLAG_UNIT_CONNECTION_STATUS
+.. autodata:: DATAFLAG_UNIT_POSITION
+.. autodata:: DATAFLAG_UNIT_PROFILE_FIELDS
+.. autodata:: DATAFLAG_UNIT_ALL
+
+----------
+Unit Group
+----------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/group>`_
+
+.. autodata:: DATAFLAG_GROUP_BASE
+.. autodata:: DATAFLAG_GROUP_CUSTOM_PROPERTIES
+.. autodata:: DATAFLAG_GROUP_BILLING_PROPERTIES
+.. autodata:: DATAFLAG_GROUP_CUSTOM_FIELDS
+.. autodata:: DATAFLAG_GROUP_IMAGE
+.. autodata:: DATAFLAG_GROUP_GUID
+.. autodata:: DATAFLAG_GROUP_ADMIN_FIELDS
+.. autodata:: DATAFLAG_GROUP_ALL
+
+----
+User
+----
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/user>`_
+
+.. autodata:: DATAFLAG_USER_BASE
+.. autodata:: DATAFLAG_USER_CUSTOM_PROPERTIES
+.. autodata:: DATAFLAG_USER_BILLING_PROPERTIES
+.. autodata:: DATAFLAG_USER_CUSTOM_FIELDS
+.. autodata:: DATAFLAG_USER_MESSAGES
+.. autodata:: DATAFLAG_USER_GUID
+.. autodata:: DATAFLAG_USER_ADMIN_FIELDS
+.. autodata:: DATAFLAG_USER_OTHER_PROPERTIES
+.. autodata:: DATAFLAG_USER_NOTIFICATIONS
+.. autodata:: DATAFLAG_USER_ALL
+
+==============
+Settings Flags
+==============
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/user/update_user_flags>`_
+
+----
+User
+----
+
+.. autodata:: SETTINGSFLAG_USER_DISABLED
+.. autodata:: SETTINGSFLAG_USER_CANNOT_CHANGE_PASSWORD
+.. autodata:: SETTINGSFLAG_USER_CAN_CREATE_ITEMS
+.. autodata:: SETTINGSFLAG_USER_CANNOT_CHANGE_SETTINGS
+.. autodata:: SETTINGSFLAG_USER_CAN_SEND_SMS
+
+===========
+Token Flags
+===========
+
+-------
+General
+-------
+
+.. autodata:: TOKENFLAG_ONLINE_TRACKING
+.. autodata:: TOKENFLAG_VIEW_ACCESS
+.. autodata:: TOKENFLAG_MANAGE_NONSENSITIVE
+.. autodata:: TOKENFLAG_MANAGE_SENSITIVE
+.. autodata:: TOKENFLAG_MANAGE_CRITICAL
+.. autodata:: TOKENFLAG_COMMUNICATION
+.. autodata:: TOKENFLAG_MANAGE_ALL

{python_terminusgps-20.5.0 → python_terminusgps-20.5.2}/docs/source/wialon/index.rst

@@ -3,13 +3,17 @@ Wialon API
 
 :py:mod:`terminusgps` offers the :py:mod:`wialon` package; a Python library that makes it simple to operate within the Wialon API.
 
+.. attention:: :confval:`WIALON_TOKEN` and :confval:`WIALON_ADMIN_ID` must be set before using this package.
+
 .. toctree::
     :maxdepth: 2
     :caption: Contents:
 
     constants.rst
     errors.rst
+    examples.rst
     flags.rst
     items.rst
     session.rst
+    settings.rst
     utils.rst

python_terminusgps-20.5.2/docs/source/wialon/items.rst

@@ -0,0 +1,29 @@
+Items
+=====
+
+.. autoclass:: terminusgps.wialon.items.base.WialonBase
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.geofence.WialonGeofence
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.notification.WialonNotification
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.resource.WialonResource
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.retranslator.WialonRetranslator
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.route.WialonRoute
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.unit.WialonUnit
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.unit_group.WialonUnitGroup
+   :members:
+
+.. autoclass:: terminusgps.wialon.items.user.WialonUser
+   :members:

python_terminusgps-20.5.2/docs/source/wialon/session.rst

@@ -0,0 +1,38 @@
+Wialon API Sessions
+===================
+
+.. autoclass:: terminusgps.wialon.session.WialonSession
+   :members:
+   :class-doc-from: init
+
+.. autoclass:: terminusgps.wialon.session.WialonSessionManager
+   :members:
+
+
+=====
+Usage
+=====
+
+.. code:: python
+
+    from terminusgps.wialon.session import WialonSession
+
+    # Create a session and login to it
+    session = WialonSession()
+    session.login(token="my_secure_token")
+
+    # Use the logged in session to perform API actions
+    session.wialon_api.core_search_item(**{"id": "123", "flags": 1})
+
+    # Don't forget to logout of the session
+    # Sessions are destroyed after 5min of inactivity
+    session.logout()
+
+    # Alternatively, use a context manager
+    # The context manager handles logging in and out of the session.
+    with WialonSession() as session:
+        session.wialon_api.core_search_item(**{"id": "123", "flags": 1})
+
+    # If you already have a session id, no need to login again
+    session = WialonSession(sid="my_valid_session_id")
+    session.wialon_api.core_search_item(**{"id": "123", "flags": 1})