saltext.gandi 0.1.0__py2.py3-none-any.whl

saltext/gandi/__init__.py

@@ -0,0 +1,28 @@
+# pylint: disable=missing-module-docstring
+import pathlib
+
+PACKAGE_ROOT = pathlib.Path(__file__).resolve().parent
+try:
+    from .version import __version__
+except ImportError:  # pragma: no cover
+    __version__ = "0.0.0.not-installed"
+    try:
+        from importlib.metadata import version, PackageNotFoundError
+
+        try:
+            __version__ = version(__name__)
+        except PackageNotFoundError:
+            # package is not installed
+            pass
+    except ImportError:
+        try:
+            from pkg_resources import get_distribution, DistributionNotFound
+
+            try:
+                __version__ = get_distribution(__name__).version
+            except DistributionNotFound:
+                # package is not installed
+                pass
+        except ImportError:
+            # pkg resources isn't even available?!
+            pass

saltext/gandi/modules/gandi_billing.py

@@ -0,0 +1,92 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+"""
+Read `Gandi billing <https://api.gandi.net/docs/billing/>`_ information.
+
+Three read-only endpoints: the account's balance and price grid, the same for
+a specific organization, and the product catalogue. There are no writes and so
+no states.
+
+Connection profiles are shared with the rest of this extension; see the
+:py:mod:`gandi execution module <saltext.gandi.modules.gandi_mod>` for how to
+configure one.
+"""
+
+import logging
+
+from saltext.gandi.utils import billing
+from saltext.gandi.utils import profile as profile_util
+
+log = logging.getLogger(__name__)
+
+__virtualname__ = "gandi_billing"
+
+
+def __virtual__():
+    return __virtualname__
+
+
+def _get_config(profile=None):
+    return profile_util.from_minion(__salt__["config.get"], profile)
+
+
+def get_info(sharing_id=None, profile=None):
+    """
+    Return billing information for an account or an organization.
+
+    sharing_id
+        Organization to report on. Without one, the credential owner's own
+        account is reported. List the available values with
+        ``gandi.list_organizations``.
+
+    profile
+        Profile to use (optional)
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt '*' gandi_billing.get_info
+        salt '*' gandi_billing.get_info sharing_id=5a53edc7-b514-416a-98c2-2d477a288eb9
+    """
+    return billing.get_info(_get_config(profile), sharing_id=sharing_id)
+
+
+def get_prices(product_type, name, processes, per_page=None, profile=None, **params):
+    """
+    Return catalogue prices for a product family.
+
+    product_type
+        One of ``cloud``, ``domain``, ``domain_option``, ``issued-cert``,
+        ``mailboxv2``, ``openstack``, ``phone_advisory``, ``simple-hosting``,
+        ``tmch``.
+
+    name
+        Product name, or list of them, e.g. ``com`` for the ``.com`` TLD.
+
+    processes
+        Process, or list of them: ``create``, ``renew``, ``transfer``,
+        ``restore``.
+
+    per_page
+        Page size.
+
+    params
+        Any of ``country``, ``currency``, ``grid``, ``sharing_id``,
+        ``prices_at``.
+
+    profile
+        Profile to use (optional)
+
+    CLI Example:
+
+    .. code-block:: bash
+
+        salt '*' gandi_billing.get_prices domain com create
+        salt '*' gandi_billing.get_prices domain '["com", "net"]' '["create", "renew"]' currency=CAD
+    """
+    return billing.get_prices(
+        _get_config(profile), product_type, name, processes, per_page=per_page, **params
+    )