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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 20.4.1
+Version: 20.5.0
 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.0/docs/source/authorizenet/auth.rst

@@ -0,0 +1,33 @@
+Authorizenet API Authentication
+===============================
+
+To authorize with the Authorizenet API, use these utility functions to provide data to each API call.
+
+.. currentmodule:: terminusgps.authorizenet.auth
+
+.. py:function:: get_merchant_auth() -> merchantAuthenticationType
+
+    Generates and returns a :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType` object.
+
+    This object is generated using :confval:`MERCHANT_AUTH_LOGIN_ID` and :confval:`MERCHANT_AUTH_TRANSACTION_KEY`.
+
+    :returns: A merchant authentication object.
+    :rtype: :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType`
+
+.. py:function:: get_environment() -> str
+
+    Gets the current application environment for Authorizenet API calls.    
+
+    This string is generated using :confval:`DEBUG`.
+
+    :returns: The current Authorizenet API environment.
+    :rtype: :py:obj:`str`
+
+.. py:function:: get_validation_mode() -> str
+
+    Gets the current application validation mode for Authorizenet API calls.    
+
+    This string is generated using :confval:`DEBUG`.
+
+    :returns: The current Authorizenet API validation mode.
+    :rtype: :py:obj:`str`

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

@@ -0,0 +1,11 @@
+Authorizenet API
+================
+
+:py:mod:`terminusgps` offers the :py:mod:`authorizenet` package; a Python library that makes it simple to operate within the Authorizenet API.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    auth.rst
+    profiles.rst

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

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

python_terminusgps-20.5.0/docs/source/aws/index.rst

@@ -0,0 +1,10 @@
+AWS API
+=======
+
+:py:mod:`terminusgps` offers the :py:mod:`aws` package; a Python library that makes it simple to operate within the AWS API.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    secrets.rst

python_terminusgps-20.5.0/docs/source/aws/secrets.rst

@@ -0,0 +1,17 @@
+Secrets
+=======
+
+.. currentmodule:: terminusgps.aws.secrets
+
+.. py:function:: get_secret(name, [region="us-east-1"]) -> dict[str, str]
+   
+    Logs into the default AWS CLI session and returns a secret value by name.
+
+    :param name: An AWS `secretsmanager`_ secret name.
+    :type name: :py:obj:`str`
+    :param region: An AWS region name. Default is ``"us-east-1"``.
+    :type region: :py:obj:`str`
+    :returns: The secret as a dictionary.
+    :rtype: :py:obj:`dict`
+
+    .. _secretsmanager: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/secretsmanager.html

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

@@ -9,7 +9,7 @@
 project = "python-terminusgps"
 copyright = "2025, Terminus GPS, LLC"
 author = "Terminus GPS, LLC"
-release = "20.4.0"
+release = "20.5.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -21,6 +21,14 @@ extensions = [
     "sphinx.ext.viewcode",
 ]
 
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "django": (
+        "http://docs.djangoproject.com/en/stable/",
+        "http://docs.djangoproject.com/en/stable/_objects/",
+    ),
+}
+
 templates_path = ["_templates"]
 exclude_patterns = []
 

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

@@ -6,13 +6,11 @@
 python-terminusgps documentation
 ================================
 
-Add your content using ``reStructuredText`` syntax. See the
-`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
-documentation for details.
-
-
 .. toctree::
     :maxdepth: 2
     :caption: Contents:
 
+    authorizenet/index.rst
+    aws/index.rst
+    twilio/index.rst
     wialon/index.rst

python_terminusgps-20.5.0/docs/source/twilio/caller.rst

@@ -0,0 +1,47 @@
+Caller object
+=============
+
+
+.. currentmodule:: terminusgps.twilio.caller
+
+.. py:class:: TwilioCaller
+
+    An asyncronous phone messager/caller.
+
+    .. py:method:: create_notification(to_number, message, [method="sms"]) -> asyncio.Task
+
+        Creates a task that must be awaited in an asyncronous event loop in order to be executed.
+
+        :meta async:
+        :param to_number: A phone number, starting with a '+' and country code.
+        :type to_number: :py:obj:`str`
+        :param message: A message to send to `to_number`.
+        :type message: :py:obj:`str`
+        :param method: Notification method to use. Default is ``"sms"``.
+        :type method: :py:obj:`str`
+        :returns: An awaitable notification task.
+        :rtype: :py:obj:`asyncio.Task`
+
+    .. py:method:: create_call(to_number, message) -> None
+
+        Creates a phone call task.
+
+        :meta async:
+        :param to_number: A phone number, starting with a '+' and country code.
+        :type to_number: :py:obj:`str`
+        :param message: A message to send to `to_number`.
+        :type message: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+    .. py:method:: create_sms(to_number, message) -> None
+
+        Creates an sms message task.
+
+        :meta async:
+        :param to_number: A phone number, starting with a '+' and country code.
+        :type to_number: :py:obj:`str`
+        :param message: A message to send to `to_number`.
+        :type message: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`

python_terminusgps-20.5.0/docs/source/twilio/index.rst

@@ -0,0 +1,10 @@
+Twilio API
+==========
+
+:py:mod:`terminusgps` offers the :py:mod:`twilio` package; a Python library that makes it simple to operate within the Twilio API.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    caller.rst

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

@@ -0,0 +1,19 @@
+Constants
+=========
+
+.. currentmodule:: terminusgps.wialon.constants
+
+.. py:data:: ACCESSMASK_RESOURCE_BASIC
+
+    :type: :py:obj:`int`
+    :value: ``17604054880353``
+
+.. py:data:: ACCESSMASK_UNIT_BASIC
+
+    :type: :py:obj:`int`
+    :value: ``3540009843``
+
+.. py:data:: ACCESSMASK_UNIT_MIGRATION
+
+    :type: :py:obj:`int`
+    :value: ``9437197``

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

@@ -0,0 +1,8 @@
+Errors
+======
+
+.. currentmodule:: wialon.api
+
+.. py:exception:: WialonError
+
+    Raised when something goes wrong calling the Wialon API.

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

@@ -0,0 +1,188 @@
+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>`_
+
+.. py:data:: ACCESSFLAG_VIEW_ITEM_BASIC
+.. py:data:: ACCESSFLAG_VIEW_ITEM_DETAILED
+.. py:data:: ACCESSFLAG_MANAGE_ITEM_ACCESS
+.. py:data:: ACCESSFLAG_DELETE_ITEM
+.. py:data:: ACCESSFLAG_RENAME_ITEM
+.. py:data:: ACCESSFLAG_VIEW_CUSTOM_FIELDS
+.. py:data:: ACCESSFLAG_MANAGE_CUSTOM_FIELDS
+.. py:data:: ACCESSFLAG_MANAGE_UNMENTIONED_FIELDS
+.. py:data:: ACCESSFLAG_MANAGE_ICON
+.. py:data:: ACCESSFLAG_QUERY_REPORTS
+.. py:data:: ACCESSFLAG_MANAGE_ACL
+.. py:data:: ACCESSFLAG_MANAGE_ITEM_LOG
+.. py:data:: ACCESSFLAG_VIEW_ADMIN_FIELDS
+.. py:data:: ACCESSFLAG_MANAGE_ADMIN_FIELDS
+.. py:data:: ACCESSFLAG_VIEW_ATTACHED_FILES
+.. py:data:: 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>`_
+
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_CONNECTIVITY
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_SENSORS
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_COUNTERS
+.. py:data:: ACCESSFLAG_UNIT_DELETE_MESSAGES
+.. py:data:: ACCESSFLAG_UNIT_EXECUTE_COMMANDS
+.. py:data:: ACCESSFLAG_UNIT_REGISTER_EVENTS
+.. py:data:: ACCESSFLAG_UNIT_VIEW_CONNECTIVITY
+.. py:data:: ACCESSFLAG_UNIT_VIEW_SERVICE_INTERVALS
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_SERVICE_INTERVALS
+.. py:data:: ACCESSFLAG_UNIT_IMPORT_MESSAGES
+.. py:data:: ACCESSFLAG_UNIT_EXPORT_MESSAGES
+.. py:data:: ACCESSFLAG_UNIT_VIEW_COMMANDS
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_COMMANDS
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_TRIP_DETECTOR
+.. py:data:: ACCESSFLAG_UNIT_MANAGE_ASSIGNMENTS
+
+----
+User
+----
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#users>`_
+
+.. py:data:: ACCESSFLAG_USER_MANAGE_ACCESS_RIGHTS
+.. py:data:: ACCESSFLAG_USER_ACT_AS_OTHER
+.. py:data:: ACCESSFLAG_USER_MANAGE_FLAGS
+.. py:data:: ACCESSFLAG_USER_VIEW_PUSH_MESSAGES
+.. py:data:: ACCESSFLAG_USER_MANAGE_PUSH_MESSAGES
+
+------------
+Retranslator
+------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#retranslators>`_
+
+.. py:data:: ACCESSFLAG_RETRANSLATOR_MANAGE_PROPERTIES
+.. py:data:: ACCESSFLAG_RETRANSLATOR_MANAGE_UNITS
+
+------------------
+Resources/Accounts 
+------------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#resources_accounts>`_
+
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_NOTIFICATIONS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_NOTIFICATIONS
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_POIS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_POIS
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_GEOFENCES
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_GEOFENCES
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_JOBS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_JOBS
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_REPORT_TEMPLATES
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_REPORT_TEMPLATES
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_DRIVERS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_DRIVERS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_ACCOUNT
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_ORDERS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_ORDERS
+.. py:data:: ACCESSFLAG_RESOURCE_VIEW_TRAILERS
+.. py:data:: ACCESSFLAG_RESOURCE_MANAGE_TRAILERS
+
+------
+Routes
+------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#routes>`_
+
+.. py:data:: ACCESSFLAG_ROUTE_MANAGE_ROUTE
+
+-----
+Other
+-----
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/core/check_items_billing#other>`_
+
+.. py:data:: ACCESSFLAG_FULL_ACCESS
+
+==========
+Data Flags
+==========
+
+------------
+Retranslator
+------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/retranslator>`_
+
+.. py:data:: DATAFLAG_RETRANSLATOR_BASE
+.. py:data:: DATAFLAG_RETRANSLATOR_CUSTOM_PROPERTIES
+.. py:data:: DATAFLAG_RETRANSLATOR_BILLING_PROPERTIES
+.. py:data:: DATAFLAG_RETRANSLATOR_GUID
+.. py:data:: DATAFLAG_RETRANSLATOR_ADMIN_FIELDS
+.. py:data:: DATAFLAG_RETRANSLATOR_CONFIGURATION
+.. py:data:: DATAFLAG_RETRANSLATOR_UNITS
+.. py:data:: DATAFLAG_RETRANSLATOR_ALL
+
+
+-----------------
+Resource/Accounts
+-----------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/resource>`_
+
+.. py:data:: DATAFLAG_RESOURCE_BASE
+.. py:data:: DATAFLAG_RESOURCE_CUSTOM_PROPERTIES
+.. py:data:: DATAFLAG_RESOURCE_BILLING_PROPERTIES
+.. py:data:: DATAFLAG_RESOURCE_CUSTOM_FIELDS
+.. py:data:: DATAFLAG_RESOURCE_MESSAGES
+.. py:data:: DATAFLAG_RESOURCE_GUID
+.. py:data:: DATAFLAG_RESOURCE_ADMIN_FIELDS
+.. py:data:: DATAFLAG_RESOURCE_DRIVERS
+.. py:data:: DATAFLAG_RESOURCE_JOBS
+.. py:data:: DATAFLAG_RESOURCE_NOTIFICATIONS
+.. py:data:: DATAFLAG_RESOURCE_POIS
+.. py:data:: DATAFLAG_RESOURCE_GEOFENCES
+.. py:data:: DATAFLAG_RESOURCE_REPORT_TEMPLATES
+.. py:data:: DATAFLAG_RESOURCE_DRIVER_ATTACHABLE_UNITS
+.. py:data:: DATAFLAG_RESOURCE_DRIVER_GROUPS
+.. py:data:: DATAFLAG_RESOURCE_TRAILERS
+.. py:data:: DATAFLAG_RESOURCE_TRAILER_GROUPS
+.. py:data:: DATAFLAG_RESOURCE_TRAILER_ATTACHABLE_UNITS
+.. py:data:: DATAFLAG_RESOURCE_ORDERS
+.. py:data:: DATAFLAG_RESOURCE_GEOFENCE_GROUPS
+.. py:data:: DATAFLAG_RESOURCE_TAGS
+.. py:data:: DATAFLAG_RESOURCE_TAG_ATTACHABLE_UNITS
+.. py:data:: DATAFLAG_RESOURCE_TAG_GROUPS
+.. py:data:: DATAFLAG_RESOURCE_ALL
+
+-----
+Route
+-----
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/route>`_
+
+.. py:data:: DATAFLAG_ROUTE_BASE
+.. py:data:: DATAFLAG_ROUTE_CUSTOM_PROPERTIES
+.. py:data:: DATAFLAG_ROUTE_BILLING_PROPERTIES
+.. py:data:: DATAFLAG_ROUTE_GUID
+.. py:data:: DATAFLAG_ROUTE_ADMIN_FIELDS
+.. py:data:: DATAFLAG_ROUTE_CONFIGURATION
+.. py:data:: DATAFLAG_ROUTE_CHECKPOINTS
+.. py:data:: DATAFLAG_ROUTE_SCHEDULES
+.. py:data:: DATAFLAG_ROUTE_ROUNDS
+.. py:data:: DATAFLAG_ROUTE_ALL
+
+---------------
+Unit/Unit Group
+---------------
+
+`Wialon API Reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/format/unit>`_

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

@@ -1,8 +1,3 @@
-.. python-terminusgps documentation master file, created by
-   sphinx-quickstart on Wed Feb 19 10:39:57 2025.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Wialon API
 ==========
 
@@ -13,6 +8,8 @@ Wialon API
     :caption: Contents:
 
     constants.rst
+    errors.rst
     flags.rst
-    glossary.rst
+    items.rst
+    session.rst
     utils.rst

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

@@ -0,0 +1,537 @@
+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

@@ -0,0 +1,155 @@
+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})

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

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "20.4.1"
+version = "20.5.0"
 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.4.1 → python_terminusgps-20.5.0}/uv.lock

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

python_terminusgps-20.4.1/docs/source/wialon/constants.rst

@@ -1,6 +0,0 @@
-Constants
-=========
-
-.. autosummary::
-
-   terminusgps.wialon.constants

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

@@ -1,6 +0,0 @@
-Flags
-=====
-
-.. autosummary::
-
-   terminusgps.wialon.flags

python_terminusgps-20.4.1/docs/source/wialon/glossary.rst

@@ -1,2 +0,0 @@
-Glossary
-========