bw-essentials-core 0.1.7__py3-none-any.whl → 0.1.8__py3-none-any.whl

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.7.dist-info → bw_essentials_core-0.1.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bw-essentials-core
-Version: 0.1.7
+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.7.dist-info → bw_essentials_core-0.1.8.dist-info}/RECORD

@@ -21,9 +21,9 @@ bw_essentials/services/portfolio_catalogue.py,sha256=y1sJENAsr8sSy_oeHqdZUGWfcV1
 bw_essentials/services/portfolio_content.py,sha256=rdFTTsUUIt-AgFfA1SAItqg2njakVOm4dUKU0FHZQ2E,2148
 bw_essentials/services/trade_placement.py,sha256=PrzeU2XXC9HF1IQ1dMDM_ZHxmC491sOl-JbA6GWPwII,20772
 bw_essentials/services/user_app.py,sha256=_Y2NgDq6kEoco7ZRJ3-MMYJ-K2HGStJoFoeGOH_HotQ,11107
-bw_essentials/services/user_portfolio.py,sha256=_5M6yPfQt4MXedINBawEoPkb_o7IGzxPeHkvZkoQm8k,16191
+bw_essentials/services/user_portfolio.py,sha256=G3PrMOryqEXSERodP4hwbrxV2JHiXUVwxdFri_E1v3k,22179
 bw_essentials/services/user_portfolio_reporting.py,sha256=pwqfW95LTiGOGufcTphljFxPlOd-G4Q263UtoQURPxM,6772
-bw_essentials_core-0.1.7.dist-info/METADATA,sha256=QKkFUyEBpJkb6rbJ8jPV6iA1v6R0MORD9830OPz6k9c,7501
-bw_essentials_core-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-bw_essentials_core-0.1.7.dist-info/top_level.txt,sha256=gDc5T_y5snwKGXDQUusEus-FEt0RFwG644Yn_58wQOQ,14
-bw_essentials_core-0.1.7.dist-info/RECORD,,
+bw_essentials_core-0.1.8.dist-info/METADATA,sha256=JXr7Vy3r4xBSPjePhUnjZbwOwt9l4CJk6khibu04PG8,7501
+bw_essentials_core-0.1.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+bw_essentials_core-0.1.8.dist-info/top_level.txt,sha256=gDc5T_y5snwKGXDQUusEus-FEt0RFwG644Yn_58wQOQ,14
+bw_essentials_core-0.1.8.dist-info/RECORD,,