MambuPy 2.3.3__tar.gz → 2.5.0__tar.gz

{mambupy-2.3.3 → mambupy-2.5.0}/MambuPy/__init__.py

@@ -37,7 +37,7 @@ import sys
 from importlib.abc import MetaPathFinder
 from importlib.util import spec_from_file_location
 
-__version__ = "2.3.3"
+__version__ = "2.5.0"
 """The version of this module."""
 
 

{mambupy-2.3.3/mambupy → mambupy-2.5.0/MambuPy}/api/__init__.py

@@ -20,6 +20,7 @@ Objects using `Mambu REST API <https://api.mambu.com/?python>`_
     MambuPy.api.mambuuser
     MambuPy.api.mambutask
     MambuPy.api.mambucustomfield
+    MambuPy.api.mambuholiday
 
 Entities use the Mixin pattern to acquire functionality.
 """

{mambupy-2.3.3 → mambupy-2.5.0}/MambuPy/api/connector/mambuconnector.py

@@ -138,6 +138,28 @@ class MambuConnectorReader(ABC):
         """
         raise NotImplementedError
 
+    @abstractmethod
+    def mambu_organization_get_holidays(self):
+        """Retrieves the holidays of the organization.
+
+        Both the general holidays and the non-working days of the week.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_get_non_working_days(self):
+        """Retrieves the non-working days of the week of the organization."""
+        raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_get_holiday(self, holidayid):
+        """Retrieves a single general holiday of the organization.
+
+        Args:
+          holidayid (str): the id or encoded key of the holiday
+        """
+        raise NotImplementedError
+
 
 class MambuConnectorWriter(ABC):
     """Interface for Writers.
@@ -286,6 +308,37 @@ class MambuConnectorWriter(ABC):
         """
         raise NotImplementedError
 
+    @abstractmethod
+    def mambu_loanaccount_updateSchedule(self, loanid, installments):
+        """Updates the installments schedule of a loan account
+
+        Mambu replaces the whole schedule with the given installments, so the
+        complete list must be sent, not just the modified ones.
+
+        Args:
+          loanid (str): the id or encoded key of the loan account
+          installments (list of dict): the installments of the schedule,
+                       complying with Mambu's schema
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def mambu_loanaccount_changeDueDatesSettings(
+        self, loanid, fixedDaysOfMonth, notes=None, valueDate=None
+    ):
+        """Changes the due dates settings of a loan account
+
+        Args:
+          loanid (str): the id or encoded key of the loan account
+          fixedDaysOfMonth (list of int): the new fixed days of month to be used
+                           on the loan account
+          notes (str): notes to associate to the change due dates settings
+                operation in Mambu
+          valueDate (str or :py:obj:`datetime`): the date when to change the due
+                    dates settings
+        """
+        raise NotImplementedError
+
     @abstractmethod
     def mambu_loantransaction_adjust(self, transactionid, notes):
         """Adjust a loan transaction
@@ -295,3 +348,51 @@ class MambuConnectorWriter(ABC):
           notes (str): notes to associate to the transaction adjustment in Mambu
         """
         raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_update_holidays(self, holidays):
+        """Updates the holidays of the organization
+
+        Mambu replaces the whole configuration with the one given, so the
+        complete set of holidays and non-working days must be sent, not just
+        the modified ones.
+
+        Args:
+          holidays (dict): holidays of the organization, complying with
+                   Mambu's schema
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_update_non_working_days(self, nonWorkingDays):
+        """Updates the non-working days of the week of the organization
+
+        Mambu replaces the whole set with the days given.
+
+        Args:
+          nonWorkingDays (list of str): days of the week on which the
+                         organization does not operate
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_create_holidays(self, holidays):
+        """Creates general holidays for the organization
+
+        Mambu adds them to the ones already configured, all in a single
+        request.
+
+        Args:
+          holidays (list of dict): the holidays to create, complying with
+                   Mambu's schema
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def mambu_organization_delete_holiday(self, holidayid):
+        """Deletes a general holiday of the organization
+
+        Args:
+          holidayid (str): the id of the holiday to be deleted
+        """
+        raise NotImplementedError

{mambupy-2.3.3/mambupy → mambupy-2.5.0/MambuPy}/api/connector/rest.py

@@ -9,22 +9,19 @@ Currently supports REST.
 
 import base64
 import copy
-import datetime
-import enum
 import json
 import mimetypes
 import orjson
 import os
 import re
 import uuid
-from decimal import Decimal
 
 import requests
 from requests_toolbelt.multipart.encoder import MultipartEncoder
-from requests.adapters import HTTPAdapter
-from requests.packages.urllib3.util.retry import Retry
 
 from .mambuconnector import MambuConnector, MambuConnectorReader, MambuConnectorWriter
+from .rest_helpers import _MambuJSONEncoder, _configure_retry_strategy
+from .rest_holidays import MambuConnectorRESTHolidays
 from MambuPy.mambuutil import (
     ALLOWED_UPLOAD_MIMETYPES,
     DETAILSLEVEL,
@@ -47,55 +44,6 @@ from MambuPy.mambuutil import (
 logger = setup_logging(__name__)
 
 
-class _MambuJSONEncoder(json.JSONEncoder):
-    """JSON encoder that handles Python types not natively serializable by json.dumps."""
-
-    def default(self, obj):
-        if isinstance(obj, (datetime.datetime, datetime.date)):
-            return obj.isoformat()
-        if isinstance(obj, enum.Enum):
-            return obj.value
-        if isinstance(obj, Decimal):
-            return float(obj)
-        return super().default(obj)
-
-
-def _configure_retry_strategy(session, retries=5):
-    """Configure retry strategy for a session.
-
-    El HTTPAdapter se construye con pool_maxsize=50 para que los flujos
-    que despachan multiples requests concurrentes contra Mambu (p.ej.
-    fan-out de aprobaciones, cargar_datos paralelo) no queden encolados
-    sobre el default de urllib3 de 10 conexiones por host.
-
-    Args:
-        session (requests.Session): The session to configure
-        retries (int, optional): Number of retries. Defaults to 5.
-    """
-    retry_strategy = Retry(
-        total=retries,
-        status_forcelist=[429, 500, 502, 503, 504],
-        backoff_factor=1,
-        allowed_methods=[
-            "HEAD",
-            "GET",
-            "OPTIONS",
-            "POST",
-            "PUT",
-            "DELETE",
-            "TRACE",
-            "PATCH",
-        ],
-    )
-    adapter = HTTPAdapter(
-        max_retries=retry_strategy,
-        pool_connections=50,
-        pool_maxsize=50,
-    )
-    session.mount("https://", adapter)
-    session.mount("http://", adapter)
-
-
 class SessionSingleton:
     """Singleton class to manage HTTP sessions for MambuPy.
 
@@ -138,8 +86,17 @@ class SessionSingleton:
         return self.__session
 
 
-class MambuConnectorREST(MambuConnector, MambuConnectorReader, MambuConnectorWriter):
-    """A connector for Mambu REST API"""
+class MambuConnectorREST(
+    MambuConnectorRESTHolidays,
+    MambuConnector,
+    MambuConnectorReader,
+    MambuConnectorWriter,
+):
+    """A connector for Mambu REST API
+
+    Endpoint mixins come first: their implementations must win over the
+    abstract methods the interfaces declare for them.
+    """
 
     _RETRIES = 5
     _tenant = ""
@@ -293,6 +250,14 @@ url %s, params %s, data %s, headers %s",
 
         return resp.content
 
+    _request = __request
+    """protected alias of the private request method
+
+       Name mangling resolves ``__request`` against the class where it is
+       written, so it is out of reach for an endpoint mixin living in another
+       module. Those mixins call this alias instead.
+    """
+
     def __list_request_args(self, params):
         if not params:
             params = {}
@@ -775,6 +740,50 @@ url %s, params %s, data %s, headers %s",
         data = {"notes": notes}
         return self.__request("POST", url, data=data)
 
+    def mambu_loanaccount_updateSchedule(self, loanid, installments):
+        """Updates the installments schedule of a loan account
+
+        Mambu replaces the whole schedule with the given installments, so the
+        complete list must be sent, not just the modified ones.
+
+        Args:
+          loanid (str): the id or encoded key of the loan account
+          installments (list of dict): the installments of the schedule,
+                       complying with Mambu's schema
+        """
+        url = "https://{}/api/{}/{}/schedule".format(self._tenant, "loans", loanid)
+
+        return self.__request("PUT", url, data=installments)
+
+    def mambu_loanaccount_changeDueDatesSettings(
+        self, loanid, fixedDaysOfMonth, notes=None, valueDate=None
+    ):
+        """Changes the due dates settings of a loan account
+
+        Only available for loan accounts whose product uses the
+        FIXED_DAYS_OF_MONTH repayment methodology. Mambu rejects the request
+        otherwise.
+
+        Args:
+          loanid (str): the id or encoded key of the loan account
+          fixedDaysOfMonth (list of int): the new fixed days of month to be used
+                           on the loan account
+          notes (str): notes to associate to the change due dates settings
+                operation in Mambu
+          valueDate (str or :py:obj:`datetime`): the date when to change the due
+                    dates settings
+        """
+        url = "https://{}/api/{}/{}:changeDueDatesSettings".format(
+            self._tenant, "loans", loanid
+        )
+        data = {"fixedDaysOfMonth": fixedDaysOfMonth}
+        if notes is not None:
+            data["notes"] = notes
+        if valueDate is not None:
+            data["valueDate"] = valueDate
+
+        return self.__request("POST", url, data=data)
+
     def mambu_change_state(self, entid, prefix, action, notes):
         """change state of mambu entity
 

mambupy-2.5.0/MambuPy/api/connector/rest_helpers.py

@@ -0,0 +1,63 @@
+"""Helpers for the REST connector.
+
+.. autosummary::
+   :nosignatures:
+   :toctree: _autosummary
+"""
+
+import datetime
+import enum
+import json
+from decimal import Decimal
+
+from requests.adapters import HTTPAdapter
+from requests.packages.urllib3.util.retry import Retry
+
+
+class _MambuJSONEncoder(json.JSONEncoder):
+    """JSON encoder that handles Python types not natively serializable by json.dumps."""
+
+    def default(self, obj):
+        if isinstance(obj, (datetime.datetime, datetime.date)):
+            return obj.isoformat()
+        if isinstance(obj, enum.Enum):
+            return obj.value
+        if isinstance(obj, Decimal):
+            return float(obj)
+        return super().default(obj)
+
+
+def _configure_retry_strategy(session, retries=5):
+    """Configure retry strategy for a session.
+
+    El HTTPAdapter se construye con pool_maxsize=50 para que los flujos
+    que despachan multiples requests concurrentes contra Mambu (p.ej.
+    fan-out de aprobaciones, cargar_datos paralelo) no queden encolados
+    sobre el default de urllib3 de 10 conexiones por host.
+
+    Args:
+        session (requests.Session): The session to configure
+        retries (int, optional): Number of retries. Defaults to 5.
+    """
+    retry_strategy = Retry(
+        total=retries,
+        status_forcelist=[429, 500, 502, 503, 504],
+        backoff_factor=1,
+        allowed_methods=[
+            "HEAD",
+            "GET",
+            "OPTIONS",
+            "POST",
+            "PUT",
+            "DELETE",
+            "TRACE",
+            "PATCH",
+        ],
+    )
+    adapter = HTTPAdapter(
+        max_retries=retry_strategy,
+        pool_connections=50,
+        pool_maxsize=50,
+    )
+    session.mount("https://", adapter)
+    session.mount("http://", adapter)

mambupy-2.5.0/MambuPy/api/connector/rest_holidays.py

@@ -0,0 +1,133 @@
+"""Holidays endpoints for the REST connector.
+
+.. autosummary::
+   :nosignatures:
+   :toctree: _autosummary
+"""
+
+
+class MambuConnectorRESTHolidays:
+    """Holidays endpoints of the organization.
+
+    A mixin, not a connector of its own: it builds the URLs and leans on the
+    request machinery of
+    :py:obj:`MambuPy.api.connector.rest.MambuConnectorREST`, the class that
+    mixes it in.
+    """
+
+    def mambu_organization_get_holidays(self):
+        """Retrieves the holidays of the organization.
+
+        Both the general holidays and the non-working days of the week.
+
+        Returns:
+          response content (str json {})
+        """
+        url = "https://{}/api/organization/holidays".format(self._tenant)
+
+        return self._request("GET", url)
+
+    def mambu_organization_update_holidays(self, holidays):
+        """Updates the holidays of the organization
+
+        Mambu replaces the whole configuration with the one given, so the
+        complete set of holidays and non-working days must be sent, not just
+        the modified ones.
+
+        Mambu processes holidays asynchronously: this fails with errorCode
+        3633, ANOTHER_TASK_IN_PROGRESS, while a previous holidays operation
+        is still running. The error is transient and is not retried here.
+
+        Args:
+          holidays (dict): holidays of the organization, complying with
+                   Mambu's schema
+
+        Returns:
+          response content (str json {})
+        """
+        url = "https://{}/api/organization/holidays".format(self._tenant)
+
+        return self._request("PUT", url, data=holidays)
+
+    def mambu_organization_get_non_working_days(self):
+        """Retrieves the non-working days of the week of the organization.
+
+        Returns:
+          response content (str json {})
+        """
+        url = "https://{}/api/organization/holidays/nonworkingdays".format(self._tenant)
+
+        return self._request("GET", url)
+
+    def mambu_organization_update_non_working_days(self, nonWorkingDays):
+        """Updates the non-working days of the week of the organization
+
+        Mambu replaces the whole set with the days given.
+
+        Mambu processes holidays asynchronously: this fails with errorCode
+        3633, ANOTHER_TASK_IN_PROGRESS, while a previous holidays operation
+        is still running. The error is transient and is not retried here.
+
+        Args:
+          nonWorkingDays (list of str): days of the week on which the
+                         organization does not operate
+
+        Returns:
+          response content (str json {})
+        """
+        url = "https://{}/api/organization/holidays/nonworkingdays".format(self._tenant)
+        data = {"nonWorkingDays": nonWorkingDays}
+
+        return self._request("PUT", url, data=data)
+
+    def mambu_organization_create_holidays(self, holidays):
+        """Creates general holidays for the organization
+
+        Mambu adds them to the ones already configured, all in a single
+        request.
+
+        Mambu processes holidays asynchronously: this fails with errorCode
+        3633, ANOTHER_TASK_IN_PROGRESS, while a previous holidays operation
+        is still running. The error is transient and is not retried here.
+
+        Args:
+          holidays (list of dict): the holidays to create, complying with
+                   Mambu's schema
+
+        Returns:
+          response content (str json [])
+        """
+        url = "https://{}/api/organization/holidays/general".format(self._tenant)
+
+        return self._request("POST", url, data=holidays)
+
+    def mambu_organization_get_holiday(self, holidayid):
+        """Retrieves a single general holiday of the organization.
+
+        Args:
+          holidayid (str): the id or encoded key of the holiday
+
+        Returns:
+          response content (str json {})
+        """
+        url = "https://{}/api/organization/holidays/general/{}".format(
+            self._tenant, holidayid
+        )
+
+        return self._request("GET", url)
+
+    def mambu_organization_delete_holiday(self, holidayid):
+        """Deletes a general holiday of the organization
+
+        Mambu processes holidays asynchronously: this fails with errorCode
+        3633, ANOTHER_TASK_IN_PROGRESS, while a previous holidays operation
+        is still running. The error is transient and is not retried here.
+
+        Args:
+          holidayid (str): the id of the holiday to be deleted
+        """
+        url = "https://{}/api/organization/holidays/general/{}".format(
+            self._tenant, holidayid
+        )
+
+        return self._request("DELETE", url)