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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 20.4.0
+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/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

python_terminusgps-20.5.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

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.5.0/docs/source/conf.py

@@ -0,0 +1,40 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "python-terminusgps"
+copyright = "2025, Terminus GPS, LLC"
+author = "Terminus GPS, LLC"
+release = "20.5.0"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "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 = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]

python_terminusgps-20.5.0/docs/source/index.rst

@@ -0,0 +1,16 @@
+.. 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.
+
+python-terminusgps documentation
+================================
+
+.. 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.5.0/docs/source/wialon/index.rst

@@ -0,0 +1,15 @@
+Wialon API
+==========
+
+:py:mod:`terminusgps` offers the :py:mod:`wialon` package; a Python library that makes it simple to operate within the Wialon API.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    constants.rst
+    errors.rst
+    flags.rst
+    items.rst
+    session.rst
+    utils.rst