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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 20.5.0
+Version: 20.5.1
 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.1/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.1/docs/source/wialon/examples.rst

@@ -0,0 +1,118 @@
+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` and :py:obj:`~terminusgps.wialon.items`.
+
+.. code:: python
+
+    from terminusgps.wialon.session import WialonSession
+    from terminusgps.wialon import items
+
+2. Create an account user.
+
+.. code:: python
+
+   with WialonSession(token="my_secure_wialon_token") as session:
+
+
+-----------------
+Full code example
+-----------------
+
+.. code:: python
+
+    from django.conf import settings
+
+    from terminusgps.wialon import items, constants
+    from terminusgps.wialon.session import WialonSession
+    from terminusgps.wialon.utils import generate_wialon_password, get_hw_type_id
+
+    with WialonSession(token="my_secure_wialon_token") as session:
+        hw_type_id = get_hw_type_id("Test HW", session)
+
+        account_user = items.WialonUser(
+            id=None,
+            session=session,
+            creator_id=settings.WIALON_ADMIN_ID,
+            name="account_user",
+            password=generate_wialon_password(32),
+        )
+        account_resource = items.WialonResource(
+            id=None,
+            session=session,
+            creator_id=account_user.id, # Use the new account user to create this resource
+            name="account_resource",
+        )
+        unit = WialonUnit(
+            id=None,
+            session=session,
+            creator_id=settings.WIALON_ADMIN_ID, # Account user CANNOT create the unit
+            name="test_unit",
+            hw_type_id=hw_type_id,
+        )
+
+        account_user.grant_access(unit, access_mask=constants.ACCESSMASK_UNIT_MIGRATION)
+        account_resource.migrate_unit(unit)

{python_terminusgps-20.5.0 → python_terminusgps-20.5.1}/docs/source/wialon/flags.rst

@@ -1,6 +1,8 @@
 Flags
 =====
 
+.. automodule:: terminusgps.wialon.flags
+
 .. currentmodule:: terminusgps.wialon.flags
 
 ============

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

@@ -9,7 +9,9 @@ Wialon API
 
     constants.rst
     errors.rst
+    examples.rst
     flags.rst
     items.rst
     session.rst
+    settings.rst
     utils.rst

python_terminusgps-20.5.1/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.1/docs/source/wialon/session.rst

@@ -0,0 +1,37 @@
+Wialon API Sessions
+===================
+
+.. autoclass:: terminusgps.wialon.session.WialonSession
+   :members:
+
+.. 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})

python_terminusgps-20.5.1/docs/source/wialon/settings.rst

@@ -0,0 +1,59 @@
+Settings
+========
+
+.. confval:: DEBUG
+
+    :type: :py:obj:`bool`
+    :default: :py:obj:`True`
+
+    Debug mode enabled.
+
+.. confval:: MERCHANT_AUTH_LOGIN_ID
+
+    :type: :py:obj:`str`
+
+    An authorizenet merchant authentication login id.
+
+.. confval:: MERCHANT_AUTH_TRANSACTION_KEY
+
+    :type: :py:obj:`str`
+
+    An authorizenet merchant authentication transaction key.
+
+    This key signs all Authorizenet transactions.
+
+.. confval:: TWILIO_FROM_NUMBER
+
+    :type: :py:obj:`str`
+
+    A phone number to send Twilio notifications from.
+
+.. confval:: TWILIO_MESSAGING_SID
+
+    :type: :py:obj:`str`
+
+    A Twilio API messaging session id.
+
+.. confval:: TWILIO_SID
+
+    :type: :py:obj:`str`
+
+    A Twilio API session id.
+
+.. confval:: TWILIO_TOKEN
+
+    :type: :py:obj:`str`
+
+    A Twilio API token.
+
+.. confval:: WIALON_ADMIN_ID
+
+    :type: :py:obj:`str`
+
+    A Wialon user id to operate as during Wialon API session.
+
+.. confval:: WIALON_TOKEN
+
+    :type: :py:obj:`str`
+
+    An active Wialon API token.

{python_terminusgps-20.5.0 → python_terminusgps-20.5.1}/docs/source/wialon/utils.rst

@@ -5,16 +5,9 @@ Utilities
 Functions
 =========
 
-.. currentmodule:: terminusgps.wialon.utils
-
-.. autosummary::
-
-   get_hw_type_id
-   get_id_from_iccid
-   get_wialon_cls
-   get_vin_info
-   is_unique
-   generate_wialon_password
+.. automodule:: terminusgps.wialon.utils
+   :members:
+   :exclude-members: gen_wialon_password
 
 =====
 Usage

{python_terminusgps-20.5.0 → python_terminusgps-20.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "20.5.0"
+version = "20.5.1"
 description = "Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more."
 readme = "README.md"
 authors = [ {name = "Blake Nall", email = "blake@terminusgps.com" } ]

{python_terminusgps-20.5.0 → python_terminusgps-20.5.1}/terminusgps/wialon/session.py

@@ -342,20 +342,3 @@ class WialonSessionManager:
             if not self._session:
                 self._session = WialonSession(sid=sid, log_level=log_level)
         return self._session
-
-
-def main() -> None:
-    # Usage example
-    session = WialonSession(log_level=logging.DEBUG)  # Instantiate session
-    session.login(settings.WIALON_TOKEN)  # Login to session
-    session.wialon_api.avl_evts()  # Call Wialon API
-    session.logout()  # Logout of session
-
-    # Alternatively, use a context manager to handle logging in and out
-    with WialonSession() as session:
-        session.wialon_api.avl_evts()  # Call Wialon API, logout when scope ends
-    return
-
-
-if __name__ == "__main__":
-    main()

{python_terminusgps-20.5.0 → python_terminusgps-20.5.1}/uv.lock

@@ -504,7 +504,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "20.5.0"
+version = "20.5.1"
 source = { editable = "." }
 dependencies = [
     { name = "argparse" },

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

@@ -1,2 +0,0 @@
-Customer Profiles
-=================

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

@@ -1,537 +0,0 @@
-Items
-=====
-
-.. currentmodule:: terminusgps.wialon.items.base
-
-.. py:class:: WialonBase
-
-    Base class for Wialon API objects.
-
-    .. py:method:: create() -> int | None
-
-        Creates a Wialon object and returns its id.
-        
-        :meta abstract:
-        :returns: The new object's id.
-        :rtype: :py:obj:`int` | :py:obj:`None`
-
-    .. py:method:: rename(new_name) -> None
-
-        Renames the Wialon object to the new name.
-
-        :param new_name: A new name.
-        :type new_name: :py:obj:`str`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: add_afield(field) -> None
-
-        Adds an admin field to the Wialon object.
-
-        :param field: A tuple containing the name of the field and the value of the field.
-        :type field: :py:obj:`tuple`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: update_afield(field_id, field) -> None
-
-        Updates an admin field by id to the Wialon object.
-
-        :param field_id: The admin field id.
-        :type field_id: :py:obj:`int`
-        :param field: A tuple containing the name of the field and the value of the field.
-        :type field: :py:obj:`tuple`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-
-    .. py:method:: add_cfield(field) -> None
-
-        Adds a custom field to the Wialon object.
-
-        :param field: A tuple containing the name of the field and the value of the field.
-        :type field: :py:obj:`tuple`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: update_cfield(field_id, field) -> None
-
-        Updates a custom field by id.
-
-        :param field_id: The admin field id.
-        :type field_id: :py:obj:`int`
-        :param field: A tuple containing the name of the field and the value of the field.
-        :type field: :py:obj:`tuple`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: add_cproperty(property) -> None
-
-        Adds a custom property to the Wialon object.
-
-        :param property: A tuple containing the name of the property and the value of the property.
-        :type property: :py:obj:`tuple`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: add_profile_field(field) -> None
-
-        Adds a profile field to the Wialon object.
-
-        :param field: A tuple containing the name of the field and the value of the field.
-        :type field: :py:obj:`tuple`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: delete() -> None
-
-        Deletes the Wialon object.
-
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-
-.. currentmodule:: terminusgps.wialon.items.geofence
-
-.. py:class:: WialonGeofence
-
-.. currentmodule:: terminusgps.wialon.items.notification
-
-.. py:class:: WialonNotification
-
-.. currentmodule:: terminusgps.wialon.items.resource
-
-.. py:class:: WialonResource
-
-    .. py:method:: create(creator_id, name) -> int | None
-
-        Creates a new Wialon resource.
-
-        :param creator_id: A Wialon user id.
-        :type creator_id: :py:obj:`int` | :py:obj:`str`
-        :param name: A name for the resource.
-        :type name: :py:obj:`str`
-        :raises ValueError: If ``creator_id`` is not a digit.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: The Wialon id for the new resource, if it was created.
-        :rtype: :py:obj:`int` | :py:obj:`None`
-
-    .. py:method:: delete() -> None
-
-        Deletes all micro-objects assigned to the resource.
-
-        If the resource is an account, instead deletes all macro-objects and micro-objects assigned to the account.
-
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: is_migrated(unit) -> None
-
-        Checks if a unit is migrated into the account.
-
-        :param unit: A Wialon object.
-        :type unit: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
-        :returns: Whether or not the unit is migrated into the account.
-        :rtype: :py:obj:`bool`
-
-    .. py:method:: set_dealer_rights(enabled) -> None
-
-        Sets dealer rights on the account.
-
-        You **probably don't** need to use this method.
-
-        :param enabled: :py:obj:`True` to enable dealer rights, :py:obj:`False` to disable dealer rights. Default is :py:obj:`False`.
-        :type enabled: :py:obj:`bool`
-        :raises AssertionError: If the resource is not an account.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: migrate_unit(unit) -> None
-
-        Migrates a :py:obj:`WialonUnit` into the account.
-
-        :param unit: A Wialon object.
-        :type unit: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
-        :raises AssertionError: If the resource is not an account.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: update_plan(new_plan) -> None
-
-        Updates the account billing plan.
-
-        :param new_plan: The name of a billing plan.
-        :type new_plan: :py:obj:`str`
-        :raises AssertionError: If the resource is not an account.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: create_account(billing_plan) -> None
-
-        Transforms the resource into an account.
-    
-        :param billing_plan: The name of a billing plan.
-        :type billing_plan: :py:obj:`str`
-        :raises AssertionError: If the resource is already account.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: delete_account() -> None
-
-        Deletes the account if it exists, as well as any micro-objects and macro-objects it contains.
-
-        :raises AssertionError: If the resource is not an account.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: enable_account() -> None
-
-        Enables the Wialon account.
-
-        :raises AssertionError: If the resource is not an account.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: disable_account() -> None
-
-        Disables the Wialon account.
-
-        :raises AssertionError: If the resource is not an account.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: set_minimum_days([days=0]) -> None
-
-        Sets the minimum days counter value to ``days``.
-
-        :param days: Number of days to set the counter to. Default is ``0``.
-        :type days: :py:obj:`int`
-        :raises AssertionError: If the resource is not an account.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: add_days([days=30]) -> None
-
-        Adds days to the account.
-
-        :param days: Number of days to add to the account. Default is ``30``.
-        :type days: :py:obj:`int`
-        :raises AssertionError: If the resource is not an account.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: set_settings_flags([flags=0x20, block_balance_val=0.00, deny_balance_val=0.00]) -> None
-
-        Sets account settings flags.
-
-        :param flags: A flag integer to set on the account.
-        :type flags: :py:obj:`int`
-        :param block_balance_val: Minimum amount on the account's balance before blocking the account.
-        :type block_balance_val: :py:obj:`float`
-        :param deny_balance_val: Minimum amount on the account's balance before denying the account.
-        :type deny_balance_val: :py:obj:`float`
-        :raises AssertionError: If the resource is not an account.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:property:: is_dealer
-
-        Whether or not the resource/account has dealer rights.
-
-        :type: :py:obj:`bool`
-
-    .. py:property:: is_account
-
-        Whether or not the resource is an account.
-
-        :type: :py:obj:`bool`
-
-.. currentmodule:: terminusgps.wialon.items.retranslator
-
-.. py:class:: WialonRetranslator
-
-    .. py:method:: create(creator_id, name) -> int | None
-
-        Creates a new Wialon route.
-
-        :param creator_id: A Wialon user id.
-        :type creator_id: :py:obj:`str` | :py:obj:`int`
-        :param name: A name for the route.
-        :type name: :py:obj:`str`
-        :raises ValueError: If ``creator_id`` is not a digit.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: The Wialon id for the new route, if it was created.
-        :rtype: :py:obj:`int` | :py:obj:`None`
-
-.. currentmodule:: terminusgps.wialon.items.unit
-
-.. py:class:: WialonUnit
-
-    .. py:method:: create(creator_id, name, hw_type_id) -> int | None
-
-        Creates a new Wialon unit.
-
-        :param creator_id: A Wialon user id.
-        :type creator_id: :py:obj:`str` | :py:obj:`int`
-        :param name: A name for the unit.
-        :type name: :py:obj:`str`
-        :param hw_type_id: A Wialon hardware type ID.
-        :type hw_type_id: :py:obj:`str` | :py:obj:`int`
-        :returns: The Wialon id for the new unit.
-        :rtype: :py:obj:`int` | :py:obj:`None`
-
-    .. py:method:: execute_command(name, link_type, [timeout=5, flags=0, param=None]) -> None
-
-        Executes a command on this Wialon unit.
-
-        :param name: A Wialon command name.
-        :type name: :py:obj:`str`
-        :param link_type: A protocol to use for the Wialon command.
-        :type link_type: :py:obj:`str`
-        :param timeout: How long (in seconds) to wait before timing out command execution. Default is ``5``.
-        :type timeout: :py:obj:`int`
-        :param flags: Flags to pass to the Wialon command execution.
-        :type flags: :py:obj:`int`
-        :param param: Additional parameters to execute the command with.
-        :type param: :py:obj:`dict` | :py:obj:`None`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: set_access_password(password) -> None 
-
-        Sets a new access password for this Wialon unit.
-
-        :param password: A new access password.
-        :type name: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: activate() -> None
-
-        Activates the Wialon unit.
-
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: deactivate() -> None
-
-        Deactivates the Wialon unit.
-
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: assign_phone(phone) -> None
-
-        Assigns a phone number to the Wialon unit.
-
-        :param phone: A phone number beginning with a country code.
-        :type phone: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: get_phone_numbers() -> list[str]
-
-        Retrieves all phone numbers assigned to the unit.
-
-        This includes any attached drivers, custom/admin fields, or otherwise assigned phone numbers.
-
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: A list of phone numbers.
-        :rtype: :py:obj:`list`
-
-    .. py:property:: imei_number
-
-        Unique id for the unit.
-        
-        :type: :py:obj:`int` | :py:obj:`None`
-
-    .. py:property:: image_uri
-
-        Unit image universal resource identifier.
-        
-        :type: :py:obj:`str`
-
-    .. py:property:: active
-
-        Whether or not the unit is activated in Wialon.
-        
-        :type: :py:obj:`bool`
-
-.. currentmodule:: terminusgps.wialon.items.unit_group
-
-.. py:class:: WialonUnitGroup
-
-    .. py:method:: create(creator_id, name) -> int | None
-
-        Creates a new Wialon unit group.
-
-        :param creator_id: A Wialon user id.
-        :type creator_id: :py:obj:`str` | :py:obj:`int`
-        :param name: A name for the group.
-        :type name: :py:obj:`str`
-        :raises ValueError: If ``creator_id`` is not a digit.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: The Wialon id for the new group, if it was created.
-        :rtype: :py:obj:`int` | :py:obj:`None`
-
-    .. py:method:: set_items(new_items) -> None
-
-        Sets this group's members to a list of Wialon unit ids.
-
-        :param new_items: A list of Wialon unit ids.
-        :type new_items: :py:obj:`list`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: is_member(item) -> bool
-
-        Determines whether or not ``item`` is a member of the group.
-
-        :param item: A Wialon object.
-        :type item: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: :py:obj:`True` if ``item`` is a member of the group, else :py:obj:`False`.
-        :rtype: :py:obj:`bool`
-
-    .. py:method:: add_item(item) -> bool
-
-        Adds a Wialon item to the group.
-
-        :param item: A Wialon object.
-        :type item: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:method:: rm_item(item) -> bool
-
-        Removes a Wialon unit from the group, if it's a member of the group.
-
-        :param item: A Wialon object.
-        :type item: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
-        :raises AssertionError: If the item wasn't in the group.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py:property:: items
-
-        A list of Wialon object ids in the group.
-
-        :type: :py:obj:`list`
-
-.. currentmodule:: terminusgps.wialon.items.user
-
-.. py:class:: WialonUser
-
-    .. py::method:: create(creator_id, name, password) -> int | None
-
-        Creates a new Wialon user.
-
-        :param creator_id: A Wialon user id.
-        :type creator_id: :py:obj:`str` | :py:obj:`int`
-        :param name: A name for the user.
-        :type name: :py:obj:`str`
-        :param password: A password for the user.
-        :type password: :py:obj:`str`
-        :raises ValueError: If ``creator_id`` is not a digit.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: The Wialon id for the new user, if it was created.
-        :rtype: :py:obj:`int` | :py:obj:`None`
-
-    .. py::method:: has_access(other) -> bool
-
-        Checks if the user has access to ``other``.
-
-        :param other: A Wialon object.
-        :type phone: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: :py:obj:`True` if the user can access ``other``, else :py:obj:`False`.
-        :rtype: :py:obj:`bool`
-
-    .. py::method:: assign_phone(phone) -> None
-
-        Assigns a phone number to the user.
-
-        :param phone: A phone number, including country code.
-        :type phone: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py::method:: assign_email(email) -> None
-
-        Assigns an email address to the user.
-
-        :param phone: An email address.
-        :type phone: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py::method:: grant_access(item) -> None
-
-        Grants the user access to ``item``.
-
-        :param item: A Wialon object.
-        :type item: :py:obj:`~terminusgps.wialon.items.base.WialonBase`
-        :param access_mask: A Wialon access mask integer.
-        :type access_mask: :py:obj:`int`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py::method:: set_settings_flags(flags, flags_mask) -> None
-
-        Sets the user's settings flags.
-
-        :param flags: The new user settings flags.
-        :type flags: :py:obj:`int`
-        :param flags_mask: A user settings flag mask.
-        :type flags_mask: :py:obj:`int`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py::method:: update_password(old_password, new_password) -> None
-
-        Updates the password of the user.
-
-        :param old_password: The user's original password.
-        :type old_password: :py:obj:`str`
-        :param new_password: A new password.
-        :type new_password: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-    .. py::method:: verify_auth(destination, [method="email"]) -> None
-
-        Sends an authentication code to ``destination`` via ``method``.
-
-        ``Method`` can be ``"email"`` or ``"sms"``.
-
-        :param destination: The email or phone number to send an auth code to.
-        :type destination: :py:obj:`str`
-        :param method: Email or sms. Default is ``"email"``.
-        :type method: :py:obj:`str`
-        :raises ValueError: If the method isn't ``"email"`` or ``"sms"``.
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: An auth code.
-        :rtype: :py:obj:`str`

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

@@ -1,155 +0,0 @@
-Wialon API Sessions
-===================
-
-.. currentmodule:: terminusgps.wialon.session
-
-.. py:class:: WialonSession
-
-    Starts or continues a Wialon API session.
-
-    :param token: An optional Wialon API token. Default is :confval:`WIALON_TOKEN`.
-    :type token: :py:obj:`str` | :py:obj:`None`
-    :param sid: An optional Wialon API session id. If provided, the session is continued.
-    :type sid: :py:obj:`str` | :py:obj:`None`
-    :param scheme: HTTP request scheme to use. Default is ``"https"``.
-    :type scheme: :py:obj:`str`
-    :param host: Wialon API host url. Default is ``"hst-api.wialon.com"``.
-    :type host: :py:obj:`str`
-    :param port: Wialon API host port. Default is ``443``.
-    :type port: :py:obj:`int`
-    :param log_level: Severity level at which log messages should be handled. Default is ``20`` (logging.INFO).
-    :type log_level: :py:obj:`int`
-
-
-    .. py:property:: gis_geocode
-
-        GIS geocode URL.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:property:: gis_render
-
-        GIS renderer URL.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:property:: gis_routing
-
-        GIS routing URL.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:property:: gis_search
-
-        GIS searching URL.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:property:: gis_sid
-
-        GIS session id.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:property:: host
-
-        Client IP address.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:property:: hw_gw_ip
-
-        Hardware gateway ip.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:property:: hw_gw_dns
-
-        Hardware gateway domain name.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:property:: wsdk_version
-
-        Wialon Source Developer Kit (wsdk) version.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:property:: uid
-
-        Wialon user id the session is operating as.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:property:: username
-
-        Wialon username the session is operating as.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:property:: token
-
-        A Wialon API token set during :py:meth:`~WialonSession.__init__`.
-
-        :type: :py:obj:`str` | :py:obj:`None`
-        :value: :py:obj:`None`
-
-    .. py:method:: login(token, [flags,]) -> str
-
-        Logs into the Wialon API, sets session attributes, and returns a session id.
-
-        :param token: An activated Wialon API token.
-        :type token: :py:obj:`str`
-        :param flags: A login response flag integer. Default is ``35``.
-        :type flags: :py:obj:`int`
-        :raises WialonError: If the login fails.
-        :raises AssertionError: If the login token was not set.
-        :returns: The new session id.
-        :rtype: :py:obj:`str`
-
-    .. py:method:: logout() -> None
-
-        Logs out of the Wialon API session.
-
-        :raises WialonError: If something goes wrong during a Wialon API call.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-=====
-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})