python-terminusgps 1.11.0__tar.gz → 1.12.0__tar.gz

{python_terminusgps-1.11.0 → python_terminusgps-1.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.11.0
+Version: 1.12.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-1.11.0 → python_terminusgps-1.12.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "1.11.0"
+version = "1.12.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-1.11.0 → python_terminusgps-1.12.0}/terminusgps/wialon/items/resource.py

@@ -22,24 +22,59 @@ class WialonResource(WialonBase):
 
     @property
     def is_account(self) -> bool:
+        """
+        Whether or not the resource is an account.
+
+        :type: :py:obj:`bool`
+
+        """
         response = self.session.wialon_api.core_search_item(
             **{"id": self.id, "flags": flags.DATAFLAG_RESOURCE_BILLING_PROPERTIES}
         )
         return response.get("item", {}).get("bact") == self.id
 
     def is_migrated(self, unit: WialonBase) -> bool:
+        """
+        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`
+
+        """
+        assert self.is_account, "The resource is not an acccount"
         response = self.session.wialon_api.account_list_change_accounts(
             **{"units": [unit.id]}
         )
-        results = [unit.id == int(item.get("id")) for item in response]
+        results = [self.id == int(item.get("id")) for item in response]
         return any(results)
 
+    def set_dealer_rights(self, enabled: bool = False) -> None:
+        """
+        Sets dealer rights on the account.
+
+        :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`
+
+        """
+        assert self.is_account, "The resource is not an account"
+        self.session.wialon_api.account_update_dealer_rights(
+            **{"itemId": self.id, "enable": str(enabled).lower()}
+        )
+
     def migrate_unit(self, unit: WialonBase) -> 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`
 
@@ -55,6 +90,8 @@ class WialonResource(WialonBase):
 
         :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`
 
@@ -70,11 +107,13 @@ class WialonResource(WialonBase):
 
         :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`
 
         """
-        assert self.is_account, "The resource is already an account"
+        assert not self.is_account, "The resource is already an account"
         self.session.wialon_api.account_create_account(
             **{"itemId": self.id, "plan": billing_plan}
         )
@@ -83,6 +122,8 @@ class WialonResource(WialonBase):
         """
         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`
 
@@ -94,6 +135,8 @@ class WialonResource(WialonBase):
         """
         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`
 
@@ -107,6 +150,8 @@ class WialonResource(WialonBase):
         """
         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`
 
@@ -122,6 +167,8 @@ class WialonResource(WialonBase):
 
         :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`
 
@@ -137,6 +184,8 @@ class WialonResource(WialonBase):
 
         :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`
 
@@ -166,6 +215,8 @@ class WialonResource(WialonBase):
         :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`
 

{python_terminusgps-1.11.0 → python_terminusgps-1.12.0}/uv.lock

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