bw-essentials-core 0.1.6__tar.gz → 0.1.8__tar.gz

{bw_essentials_core-0.1.6 → bw_essentials_core-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bw-essentials-core
-Version: 0.1.6
+Version: 0.1.8
 Summary: Reusable utilities for S3, email, Data Loch, Microsoft Teams Notifications and more.
 Author: InvestorAI
 Author-email: support+tech@investorai.in

{bw_essentials_core-0.1.6 → bw_essentials_core-0.1.8}/bw_essentials/constants/services.py

@@ -20,3 +20,13 @@ class Services(Enum):
     PROMETHEUS_USER_APP = "Prometheus_User_App"
     PORTFOLIO_CATALOGUE = "Portfolio_Catalogue"
     PORTFOLIO_CONTENT = "Portfolio_Content"
+
+class PortfolioStatus(Enum):
+    """
+        Enum representing Status of Basket.
+    """
+    ACTIVE = "active"
+    INACTIVE = "inactive"
+    PAUSED = "paused"
+
+    ACTIVE_FOR_SUBSCRIBED_USER = (ACTIVE, PAUSED)

{bw_essentials_core-0.1.6 → bw_essentials_core-0.1.8}/bw_essentials/services/portfolio_catalogue.py

@@ -48,7 +48,7 @@ Example
 import logging
 from typing import Optional, Dict, Any
 
-from bw_essentials.constants.services import Services
+from bw_essentials.constants.services import Services, PortfolioStatus
 from bw_essentials.services.api_client import ApiClient
 
 logger = logging.getLogger(__name__)
@@ -78,6 +78,7 @@ class PortfolioCatalogue(ApiClient):
         self.name = Services.PORTFOLIO_CATALOGUE.value
         self.urls = {
             "rebalance": "rebalance",
+            "get_rebalance": "rebalance"
         }
 
     def create_rebalance(self, json: Dict[str, Any]) -> Optional[Dict[str, Any]]:
@@ -102,3 +103,57 @@ class PortfolioCatalogue(ApiClient):
         )
         logger.info("%s", data)
         return data
+
+    def rebalance(self, portfolio_id, status):
+        """Fetch the latest rebalance record for a portfolio.
+
+        Parameters
+        ----------
+        portfolio_id : str
+            Portfolio identifier.
+        status : str
+            Portfolio status filter.
+
+        Returns
+        -------
+        dict
+            The first record from the service response's 'data' list.
+        """
+        logger.info("In - rebalance portfolio_id=%s status=%s", portfolio_id, status)
+        data = self._get(
+            url=self.base_url,
+            endpoint=self.urls["get_rebalance"],
+            params={'portfolioId': portfolio_id, 'status': status}
+        )
+        logger.info("rebalance response: %s", data)
+        return data.get('data')[0]
+
+    def get_rebalance_due_date(self, portfolio_id, status):
+        """Return the next rebalance date for an active portfolio, else None.
+
+        Parameters
+        ----------
+        portfolio_id : str
+            Portfolio identifier.
+        status : str
+            Portfolio status.
+
+        Returns
+        -------
+        str | None
+            The next rebalance date string if available; otherwise None.
+        """
+        logger.info(
+            "In - get_rebalance_due_date portfolio_id=%s status=%s",
+            portfolio_id,
+            status,
+        )
+        if status in PortfolioStatus.ACTIVE_FOR_SUBSCRIBED_USER.value:
+            rebalance_history = self.rebalance(portfolio_id, status)
+            next_rebalance_date = (
+                rebalance_history.get('nextRebalanceDate') if rebalance_history else None
+            )
+            logger.info("nextRebalanceDate=%s", next_rebalance_date)
+            return next_rebalance_date
+        logger.info("get_rebalance_due_date not applicable for status=%s", status)
+        return None

{bw_essentials_core-0.1.6 → bw_essentials_core-0.1.8}/bw_essentials/services/user_portfolio.py

@@ -43,7 +43,9 @@ class UserPortfolio(ApiClient):
             "skip": "userportfolio/order/skip/basket",
             "create_order_instructions": "userportfolio/order/order-instruction",
             "basket_details": "userportfolio/basket",
-            "broker_users_holdings": "holding/{}/users"
+            "broker_users_holdings": "holding/{}/users",
+            "user_portfolio_thresholds": "alerts/portfolio/thresholds",
+            "holding_thresholds": "alerts/holding/thresholds"
         }
 
     def create_holding_transaction(self, payload):
@@ -404,3 +406,165 @@ class UserPortfolio(ApiClient):
         endpoint = self.urls.get('broker_users_holdings').format(broker)
         response = self._get(url=self.base_url, endpoint=endpoint)
         return response.get('data')
+
+    def create_user_portfolio_threshold(self, payload):
+        """Create a *User Portfolio* threshold.
+
+        Parameters
+        ----------
+        payload : dict | str
+            JSON-serialisable dictionary (or raw JSON string) containing the
+            following **required** keys.
+
+            * **portfolio_type** (str) – One of the portfolio types accepted by
+              the User-Portfolio service (e.g. ``USER_PORTFOLIO`` or ``BASKET``).
+            * **portfolio_id** (str) – Unique identifier of the portfolio
+              entity.
+            * **side** (str) – Either ``LONG`` or ``SHORT``.
+            * **threshold_type** (str) – Threshold category, e.g. ``PT`` or
+              ``SL``.
+            * **status** (str) – Initial status, typically ``ACTIVE``.
+
+            **Optional** keys:
+
+            * **target_pct** (Decimal | float) – Percent based trigger level.
+            * **target_value** (Decimal | float) – Absolute money value trigger.
+            * **source** (str) – Origin of the instruction (``user``, ``admin`` …).
+
+        Returns
+        -------
+        dict
+            A dictionary representing the newly-created threshold (same shape
+            as the backend response ``data`` field).
+        """
+        logger.info(f"In create_user_portfolio_threshold {payload =}")
+        data = self._post(url=self.base_url,
+                          endpoint=self.urls.get("user_portfolio_thresholds"),
+                          data=payload)
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def get_user_portfolio_thresholds(self, params=None):
+        """Retrieve *User Portfolio* thresholds.
+
+        Parameters
+        ----------
+        params : dict | None, optional
+            Query-string parameters used as filters; accepted keys mirror the
+            columns of ``UserPortfolioThreshold`` (e.g. ``portfolio_type``,
+            ``portfolio_id``, ``status`` …).  Passing ``None`` performs an
+            unfiltered list retrieval.
+
+        Returns
+        -------
+        list[dict]
+            List of serialised thresholds ordered by ``-effective_from``.
+        """
+        logger.info(f"In get_user_portfolio_thresholds {params =}")
+        data = self._get(url=self.base_url,
+                         endpoint=self.urls.get("user_portfolio_thresholds"),
+                         params=params)
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def update_user_portfolio_threshold(self, payload):
+        """Update an existing *User Portfolio* threshold.
+
+        The request is forwarded verbatim to ``PUT /portfolio/thresholds``.
+
+        Parameters
+        ----------
+        payload : dict | str
+            Dictionary (or JSON string) that **must** include:
+
+            * **id** (int) – Primary key of the threshold to update.
+
+            Any of the following *optional* fields may also be supplied; only
+            those present will be updated:
+
+            * **target_pct** (Decimal | float)
+            * **status** (str)
+            * **source** (str)
+
+        Returns
+        -------
+        dict
+            The updated threshold as returned by the backend (``data`` field).
+        """
+        logger.info(f"In update_user_portfolio_threshold {payload =}")
+        data = self._put(url=self.base_url,
+                         endpoint=self.urls.get("user_portfolio_thresholds"),
+                         json=payload)
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def create_holding_threshold(self, payload):
+        """Create a *Holding* threshold.
+
+        Parameters
+        ----------
+        payload : dict | str
+            Data required by ``POST /holding/thresholds``. Mandatory keys:
+
+            * **holding_type** (str)
+            * **holding_id** (str)
+            * **side** (str)
+            * **threshold** (Decimal | float)
+            * **effective_from** (datetime-iso-str)
+
+            Optional: **source** (str)
+
+        Returns
+        -------
+        dict
+            Newly created Holding-threshold representation.
+        """
+        logger.info(f"In create_holding_threshold {payload =}")
+        data = self._post(url=self.base_url,
+                          endpoint=self.urls.get("holding_thresholds"),
+                          data=payload)
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def get_holding_thresholds(self, params=None):
+        """Retrieve *Holding* thresholds with optional filters.
+
+        Parameters
+        ----------
+        params : dict | None, optional
+            Filter parameters (``holding_type``, ``holding_id`` …). ``None``
+            results in an unfiltered list.
+
+        Returns
+        -------
+        list[dict]
+            Serialised Holding-thresholds ordered by ``-effective_from``.
+        """
+        logger.info(f"In get_holding_thresholds {params =}")
+        data = self._get(url=self.base_url,
+                         endpoint=self.urls.get("holding_thresholds"),
+                         params=params)
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def update_holding_threshold(self, payload):
+        """Update an existing *Holding* threshold.
+
+        Parameters
+        ----------
+        payload : dict | str
+            Must include the primary key ``id`` and any fields to be changed
+            (e.g. ``threshold``, ``status`` or ``effective_to``).
+
+        Returns
+        -------
+        dict
+            Updated Holding-threshold object as returned by the backend.
+        """
+        logger.info(f"In update_holding_threshold {payload =}")
+        data = self._put(url=self.base_url,
+                         endpoint=self.urls.get("holding_thresholds"),
+                         json=payload)
+        logger.info(f"{data =}")
+        return data.get("data")
+

{bw_essentials_core-0.1.6 → bw_essentials_core-0.1.8}/bw_essentials_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bw-essentials-core
-Version: 0.1.6
+Version: 0.1.8
 Summary: Reusable utilities for S3, email, Data Loch, Microsoft Teams Notifications and more.
 Author: InvestorAI
 Author-email: support+tech@investorai.in

{bw_essentials_core-0.1.6 → bw_essentials_core-0.1.8}/setup.py

@@ -10,7 +10,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="bw-essentials-core",
-    version="0.1.6",
+    version="0.1.8",
     author="InvestorAI",
     author_email="support+tech@investorai.in",
     description="Reusable utilities for S3, email, Data Loch, Microsoft Teams Notifications and more.",