bw-essentials-core 0.1.17__py3-none-any.whl → 0.1.33__py3-none-any.whl

bw_essentials/services/user_portfolio.py

@@ -45,7 +45,16 @@ class UserPortfolio(ApiClient):
             "basket_details": "userportfolio/basket",
             "broker_users_holdings": "holding/{}/users",
             "user_portfolio_thresholds": "alerts/portfolio/thresholds",
-            "holding_thresholds": "alerts/holding/thresholds"
+            "holding_thresholds": "alerts/holding/thresholds",
+            "user_portfolio_summary": "userportfolio/user-portfolio/summary",
+            "create_user_portfolio": "userportfolio/portfolio",
+            "get_user_portfolio": "userportfolio/portfolio",
+            "finn_user_order_place": "userorder/place-order/",
+            "finn_user_order_update": "userorder/order",
+            "finn_user_order_status": "userorder/order/status",
+            "finn_user_order_list": "userorder/orders",
+            "finn_user_order_portfolio": "userorder/portfolio",
+            "finn_user_order_reconcile": "userorder/reconcile/",
         }
 
     def create_holding_transaction(self, payload):
@@ -568,3 +577,391 @@ class UserPortfolio(ApiClient):
         logger.info(f"{data =}")
         return data.get("data")
 
+    def get_user_portfolio_summary(self, user_id: str, broker: str, product_type: str):
+        """
+        Retrieves the summary of a user's portfolio for a given broker and product type.
+
+        Args:
+            user_id (str): ID of the user.
+            broker (str): Broker of the user.
+            product_type (str): Product type (e.g., 'mtf').
+
+        Returns:
+            dict: Portfolio summary data.
+        """
+        logger.info(f"In - user_portfolio_summary {user_id = }, {broker = }, {product_type = }")
+        params = {
+            "user_id": user_id,
+            "broker": broker,
+            "product_type": product_type
+        }
+        data = self._get(url=self.base_url, endpoint=self.urls.get("user_portfolio_summary"), params=params)
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def create_user_portfolio(self, payload):
+        """
+        Create a User Portfolio.
+
+        This method sends a POST request to create a new user portfolio
+        using the provided payload. The payload must contain:
+
+        - user_id (str): Unique user identifier.
+        - name (str): Name of the user.
+        - portfolio_id (str): Portfolio identifier.
+        - status (str): Portfolio status (e.g., "active").
+        - subscription_id (str): Subscription reference.
+        - product_type (str): Product type (e.g., "fno").
+        - broker (str): Broker associated with the user.
+        - strategy (str): Strategy identifier (one_time/rebalance. Default: rebalance)
+
+        Parameters
+        ----------
+        payload : dict
+            JSON-serialisable dictionary for creating the user portfolio.
+
+        Returns
+        -------
+        dict
+            The newly created user portfolio (value of the 'data' field).
+        """
+        logger.info(f"In - create_user_portfolio {payload =}")
+
+        data = self._post(
+            url=self.base_url,
+            endpoint=self.urls.get("create_user_portfolio"),
+            json=payload
+        )
+
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def get_user_portfolio(
+        self,
+        user_id=None,
+        portfolio_id=None,
+        broker=None,
+        status=None,
+        investment_status=None,
+        subscription_id=None,
+        product_type=None,
+        strategy=None,
+    ):
+        """
+        Fetch User Portfolio with optional filters.
+
+        All parameters are optional and sent as query params.
+        Any field left as None will be ignored.
+
+        Parameters
+        ----------
+        user_id : str, optional
+        portfolio_id : str, optional
+        broker : str, optional
+        status : str, optional
+        investment_status : str, optional
+        subscription_id : str, optional
+        product_type : str, optional
+        strategy : str, optional
+
+        Returns
+        -------
+        dict or list
+            Value of `data` in API response.
+        """
+        params = {
+            "user_id": user_id,
+            "portfolio_id": portfolio_id,
+            "broker": broker,
+            "status": status,
+            "investment_status": investment_status,
+            "subscription_id": subscription_id,
+            "product_type": product_type,
+            "strategy": strategy,
+        }
+        params = {k: v for k, v in params.items() if v is not None}
+
+        logger.info(f"In - get_user_portfolio {params =}")
+
+        data = self._get(
+            url=self.base_url,
+            endpoint=self.urls.get("get_user_portfolio"),
+            params=params,
+        )
+
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def place_user_order(self, payload: dict):
+        """
+        Place a user order.
+
+        This method maps to:
+        POST /user-portfolio/userorder/place-order/
+
+        Parameters
+        ----------
+        payload : dict
+            Order placement payload containing:
+            - user_id
+            - broker_user_id
+            - broker
+            - product_type
+            - symbol
+            - broker_symbol
+            - category
+            - strategy
+            - option_type
+            - side
+            - order_type
+            - variety
+            - quantity
+            - price
+            - recommendation_id
+            - user_inputs
+
+        Returns
+        -------
+        dict
+            Placed order response data.
+        """
+        logger.info(f"In - place_user_order {payload =}")
+
+        data = self._post(
+            url=self.base_url,
+            endpoint=self.urls.get("finn_user_order_place"),
+            json=payload
+        )
+
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def update_user_order(self, order_tag: str, payload: dict):
+        """
+        Update a user order.
+
+        Maps to:
+        PUT /user-portfolio/userorder/order/{id}/update/
+
+        Parameters
+        ----------
+        order_tag : str
+            Internal Order Tag (path param).
+        payload : dict
+            Order update payload containing:
+            - order_id
+            - status
+            - filled_quantity
+            - pending_quantity
+            - cancelled_quantity
+            - average_price
+            - amount
+
+        Returns
+        -------
+        dict
+            Updated order data.
+        """
+        logger.info(
+            f"In - update_user_order {order_tag =}, {payload =}"
+        )
+
+        endpoint = f"{self.urls.get('finn_user_order_update')}/{order_tag}/update/"
+
+        data = self._put(
+            url=self.base_url,
+            endpoint=endpoint,
+            json=payload
+        )
+
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def get_user_order_status(self, order_id):
+        """
+        Fetch the current status of one or more user orders.
+
+        Backend always returns a list.
+        Client normalises response shape:
+
+        - int  -> dict
+        - list -> list
+
+        Maps to:
+        GET /user-portfolio/userorder/order/status?order_id=1,2,3
+        """
+        is_single = not isinstance(order_id, (list, tuple, set))
+
+        if is_single:
+            order_id_param = str(order_id)
+        else:
+            order_id_param = ",".join(str(i) for i in order_id)
+
+        logger.info(f"In - get_user_order_status {order_id_param =}")
+
+        response = self._get(
+            url=self.base_url,
+            endpoint=self.urls.get("finn_user_order_status"),
+            params={"order_id": order_id_param},
+        )
+        data = response.get("data") or []
+        logger.info(f"{data =}")
+        if is_single:
+            return data[0] if data else None
+        return data
+
+    def get_user_orders(
+            self,
+            product_type: str,
+            user_id: str,
+            from_date: str = None,
+            to_date: str = None,
+            status: str = None,
+            symbol: str = None,
+    ):
+        """
+        Fetch user orders with filters.
+
+        Maps to:
+        GET /user-portfolio/userorder/orders/
+
+        Mandatory query params:
+        - product_type
+        - user_id
+
+        Optional query params:
+        - from_date (YYYY-MM-DD)
+        - to_date (YYYY-MM-DD)
+        - status
+        - symbol
+
+        Parameters
+        ----------
+        product_type : str
+        user_id : str
+        from_date : str, optional
+        to_date : str, optional
+        status : str, optional
+        symbol : str, optional
+
+        Returns
+        -------
+        list[dict]
+            List of user orders.
+        """
+        params = {
+            "product_type": product_type,
+            "user_id": user_id,
+            "from_date": from_date,
+            "to_date": to_date,
+            "status": status,
+            "symbol": symbol,
+        }
+        params = {k: v for k, v in params.items() if v is not None}
+        logger.info(f"In - get_user_orders {params =}")
+        data = self._get(
+            url=self.base_url,
+            endpoint=self.urls.get("finn_user_order_list"),
+            params=params,
+        )
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def get_user_portfolios(
+            self,
+            user_id: str,
+            broker_user_id: str,
+            broker: str,
+            product_type: str,
+            status: str = None,
+            limit: int = None,
+            offset: int = None,
+    ):
+        """
+        Fetch user order portfolios with filters.
+
+        Maps to:
+        GET /user-portfolio/userorder/portfolio/
+
+        Mandatory query params:
+        - user_id
+        - product_type
+        - broker_user_id
+        - broker
+
+        Optional query params:
+        - status
+        - limit
+        - offset
+
+        Parameters
+        ----------
+        user_id : str
+        product_type : str
+        broker_user_id : str
+        broker : str
+        status : str, optional
+        limit : int, optional
+        offset : int, optional
+
+        Returns
+        -------
+        dict
+            List of user order portfolios.
+        """
+        params = {
+            "user_id": user_id,
+            "product_type": product_type,
+            "broker_user_id": broker_user_id,
+            "broker": broker,
+            "status": status,
+            "limit": limit,
+            "offset": offset,
+        }
+        params = {k: v for k, v in params.items() if v is not None}
+        logger.info(f"In - get_user_portfolios {params =}")
+        data = self._get(
+            url=self.base_url,
+            endpoint=self.urls.get("finn_user_order_portfolio"),
+            params=params,
+        )
+        logger.info(f"{data =}")
+        return data.get("data")
+
+    def reconcile_user_order(self, payload: dict):
+        """
+        Reconcile a user order.
+
+        Maps to:
+        POST /user-portfolio/userorder/reconcile/
+
+        Parameters
+        ----------
+        payload : dict
+            Reconciliation payload containing:
+            - user_id
+            - broker_user_id
+            - broker
+            - product_type
+            - symbol
+            - broker_symbol
+            - category
+            - strategy
+            - option_type
+            - order_type
+            - variety
+            - quantity
+
+        Returns
+        -------
+        dict
+            Reconciled order data.
+        """
+        logger.info(f"In - reconcile_user_order {payload =}")
+        data = self._post(
+            url=self.base_url,
+            endpoint=self.urls.get("finn_user_order_reconcile"),
+            json=payload,
+        )
+        logger.info(f"{data =}")
+        return data.get("data")

bw_essentials/services/user_portfolio_reporting.py

@@ -66,7 +66,8 @@ class UserReporting(ApiClient):
             "instructions": "reporting/instructions/",
             "portfolio_performance": "reporting/user/%s/userportfolio/%s/performance/",
             "portfolio_performance_breakdown": "reporting/user/%s/userportfolio/%s/performance/breakdown/",
-            'portfolio_stock_performance': "reporting/user/%s/userportfolio/%s/stock/performance/"
+            'portfolio_stock_performance': "reporting/user/%s/userportfolio/%s/stock/performance/",
+            "portfolio_performance_summary": "reporting/user/%s/performance/summary"
         }
 
     def _get_integer_quantity(self, qty, side):
@@ -168,3 +169,21 @@ class UserReporting(ApiClient):
                          endpoint=endpoint)
         logger.info(f"{data=}")
         return data.get("data")
+
+    def get_portfolio_performance_summary(self, user_id: str, product: str = 'equity'):
+        """
+        Retrieves a summary of the user's portfolio performance.
+
+        Args:
+            user_id (str): ID of the user.
+            product (str): Product type (default: 'equity', e.g., 'mtf').
+
+        Returns:
+            dict: Portfolio performance summary data.
+        """
+        logger.info(f"In - get_portfolio_performance_summary {user_id = }, {product =}")
+        endpoint = self.urls.get("portfolio_performance_summary") % user_id
+        params = {"product": product}
+        data = self._get(url=self.base_url, endpoint=endpoint, params=params)
+        logger.info(f"{data =}")
+        return data.get("data")

{bw_essentials_core-0.1.17.dist-info → bw_essentials_core-0.1.33.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bw-essentials-core
-Version: 0.1.17
+Version: 0.1.33
 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.33.dist-info/RECORD

@@ -0,0 +1,32 @@
+bw_essentials/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bw_essentials/constants/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bw_essentials/constants/services.py,sha256=ozLnxtqS79w9yPH7baTWaJzwGmIgg_mxp1vO8Aqh-dc,930
+bw_essentials/data_loch/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bw_essentials/data_loch/data_loch.py,sha256=iJO0oPhZyQjoUZOaeBP1nsbuc5iR9ZNWoAXj2pGEpT8,11716
+bw_essentials/email_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bw_essentials/email_client/email_client.py,sha256=zKAhF7TUYWWfo5PuIfUzD8W2XSmmStgpSvwXc9P4LV8,9461
+bw_essentials/notifications/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bw_essentials/notifications/teams_notification_schemas.py,sha256=FvZ8FyIwku4-0uweDn9gpaIJW_AIsNoqV1hB6lQ4OPI,6398
+bw_essentials/notifications/teams_notifications.py,sha256=1tkS3tTJQZ5ByMwK2WXpFgQn7-TobYYOncOj81NBySY,7308
+bw_essentials/s3_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bw_essentials/s3_utils/s3_utils.py,sha256=wzjVrTX22_8PMX86svKFYGMZwgjBHbOaeEsxO-lR7BY,12922
+bw_essentials/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bw_essentials/services/api_client.py,sha256=hGgM1rwiI7Yvq0tj0XfqZUV_hSXEm4S5Vw0lyNvSVDY,9553
+bw_essentials/services/broker.py,sha256=pcVmkmLn8hZhjUJseW07245xYcHYtGU6segvS9wsmt4,9567
+bw_essentials/services/compliance.py,sha256=tt46lYPhE15D-4XtQLPQW0rbsMXx5Zld55u2oEzkNVM,2453
+bw_essentials/services/job_scheduler.py,sha256=1fQDWBvNa3bMCm3YzlJehoS-HONUSu4_oquuBv6t0Lg,1966
+bw_essentials/services/market_pricer.py,sha256=5yMsg3lKbZXgbAeGa6NMEyjayP1CZGZ0g_lvHlnTyn4,13581
+bw_essentials/services/master_data.py,sha256=wdkqhYhXH9DtqOgiCh_CMyEiZaU-HfQtGKsJdMelY94,14132
+bw_essentials/services/model_portfolio_reporting.py,sha256=VLSvfRZOdn-nI3MtgfcqP0ZE3aTqBU0NcncLffPVtD8,4407
+bw_essentials/services/notification.py,sha256=nnvtEqUphhCSTavsV75XvLp1ZNVV-kLU_cFc8zLNIec,5396
+bw_essentials/services/payment.py,sha256=l2F7U1t8wKN7wWWgzKxC4iiLqwHImKgm7NxK1YWDEfw,3487
+bw_essentials/services/portfolio_catalogue.py,sha256=FwiXPj-kunauXQkT3EDrhCiHHDVANuVrU6cfJxgkJR0,9999
+bw_essentials/services/portfolio_content.py,sha256=VX5ASf9Kg-w4-ZktiDEoM5YlFqn_mShtqJhL-7v7X8s,3039
+bw_essentials/services/trade_placement.py,sha256=V-CmRQV94ewdfeUzlNIsKrdUDzHFh9GRUAW4Bei_V6Y,29885
+bw_essentials/services/user_app.py,sha256=1z73G91TygW_MgHjkUVA2WIdN4CQjx_oSZWW6NqFit8,11774
+bw_essentials/services/user_portfolio.py,sha256=YqZz-vjBCTuUfXE5nUb0uOp9FXtVDHbfaJOMMcaCgJg,33317
+bw_essentials/services/user_portfolio_reporting.py,sha256=soh68r6ezBoILXrwTDxY-Us9_TyJYXxYHChCQcsxKP8,7585
+bw_essentials_core-0.1.33.dist-info/METADATA,sha256=-yJmupdUfZSmfXOHJ4rOJt0MD2ZIKLls8gq5VaacliA,7502
+bw_essentials_core-0.1.33.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+bw_essentials_core-0.1.33.dist-info/top_level.txt,sha256=gDc5T_y5snwKGXDQUusEus-FEt0RFwG644Yn_58wQOQ,14
+bw_essentials_core-0.1.33.dist-info/RECORD,,

bw_essentials_core-0.1.17.dist-info/RECORD

@@ -1,31 +0,0 @@
-bw_essentials/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bw_essentials/constants/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bw_essentials/constants/services.py,sha256=HxeM05zJP1oCqwLRLb9wLxAOCmbdu-jWgtlmnPE4KFU,900
-bw_essentials/data_loch/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bw_essentials/data_loch/data_loch.py,sha256=iJO0oPhZyQjoUZOaeBP1nsbuc5iR9ZNWoAXj2pGEpT8,11716
-bw_essentials/email_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bw_essentials/email_client/email_client.py,sha256=_LzDWUJUkNTSn3C5v0-jjW-Ls537xt493lkcD4noQXY,9116
-bw_essentials/notifications/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bw_essentials/notifications/teams_notification_schemas.py,sha256=FvZ8FyIwku4-0uweDn9gpaIJW_AIsNoqV1hB6lQ4OPI,6398
-bw_essentials/notifications/teams_notifications.py,sha256=1tkS3tTJQZ5ByMwK2WXpFgQn7-TobYYOncOj81NBySY,7308
-bw_essentials/s3_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bw_essentials/s3_utils/s3_utils.py,sha256=wzjVrTX22_8PMX86svKFYGMZwgjBHbOaeEsxO-lR7BY,12922
-bw_essentials/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bw_essentials/services/api_client.py,sha256=5XFbdw5gfxXz7mQlLWNC8efDrvZgAztM-Oo0Dp1jDF8,8215
-bw_essentials/services/broker.py,sha256=W4y31K7dF4LHfQSvnAwVWfGoYKkdz-W2TXqTLhkUxn8,9348
-bw_essentials/services/job_scheduler.py,sha256=1fQDWBvNa3bMCm3YzlJehoS-HONUSu4_oquuBv6t0Lg,1966
-bw_essentials/services/market_pricer.py,sha256=Qc9lxzAjhefAvjyEKsBPDu60bF6_61cnSpZNfjGMyDg,11755
-bw_essentials/services/master_data.py,sha256=2o_r2gdhIKBeTFgn5IIY-becgCEpYBymO4BKmixdV1g,11987
-bw_essentials/services/model_portfolio_reporting.py,sha256=iOtm4gyfU8P7C0R1gp6gUJI4ZRxJD5K2GLOalI_gToM,3249
-bw_essentials/services/notification.py,sha256=q4jIZzIWIHvn-XaIIbkEjjhkYUV8ZGQWUXaY4NNRFgI,5078
-bw_essentials/services/payment.py,sha256=Em8Lvg7aX1Ga4CJDpJimyE_ByZhJZKM6W6rw2cUUIvw,1479
-bw_essentials/services/portfolio_catalogue.py,sha256=Eal2wJd2qQB_qk2B_7u0-SwsZTN9nMsSxwgoIud845Y,7201
-bw_essentials/services/portfolio_content.py,sha256=etdbPqacUJscM1DqdtqSsuH3IQX6oPJEsE3nM6d8YvI,3038
-bw_essentials/services/trade_placement.py,sha256=PrzeU2XXC9HF1IQ1dMDM_ZHxmC491sOl-JbA6GWPwII,20772
-bw_essentials/services/user_app.py,sha256=1z73G91TygW_MgHjkUVA2WIdN4CQjx_oSZWW6NqFit8,11774
-bw_essentials/services/user_portfolio.py,sha256=uUQUCG8Av8eKBIw-TlNtOPpQluO9HjAkxMzzO5jfzbo,22179
-bw_essentials/services/user_portfolio_reporting.py,sha256=pwqfW95LTiGOGufcTphljFxPlOd-G4Q263UtoQURPxM,6772
-bw_essentials_core-0.1.17.dist-info/METADATA,sha256=9reGA-4ZeYNOVS7aIbRbjv9MjXrEEhPS0x85ZcXwGgQ,7502
-bw_essentials_core-0.1.17.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-bw_essentials_core-0.1.17.dist-info/top_level.txt,sha256=gDc5T_y5snwKGXDQUusEus-FEt0RFwG644Yn_58wQOQ,14
-bw_essentials_core-0.1.17.dist-info/RECORD,,