orionapi 2.32.1__tar.gz → 2.34.0__tar.gz

{orionapi-2.32.1 → orionapi-2.34.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionapi
-Version: 2.32.1
+Version: 2.34.0
 Summary: A python interface for the Orion Advisors platform web API
 Author: spencerogden-dsam
 Author-email: 67068943+spencerogden-dsam@users.noreply.github.com

{orionapi-2.32.1 → orionapi-2.34.0}/orionapi/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.32.1"
+__version__ = "2.34.0"
 
 import logging
 import re
@@ -1492,7 +1492,8 @@ class OrionAPI(BaseAPI):
             bill_type: Type of bill. One of: Unknown, Renewal, NewMoney,
                 NewAccount, FinancialPlanningFee, Performance, AdvanceCreditDebit
             nickname: Optional nickname for this billing instance
-            keys: Optional list of integer IDs for the selected run_for scope
+            keys: Optional list of integer IDs for the selected run_for scope.
+                Sent as [] when omitted (required by Orion for AllHouseholds).
             as_of_date: Optional as-of date (YYYY-MM-DD format)
             end_date_override: Optional end date override (YYYY-MM-DD format)
             include_cash_flow: Whether to include cash flow (default False)
@@ -1529,8 +1530,9 @@ class OrionAPI(BaseAPI):
         }
         if nickname is not None:
             payload["nickName"] = nickname
-        if keys is not None:
-            payload["keys"] = keys
+        # Always send keys: with it omitted, runFor="AllHouseholds" gets a
+        # 404 "Object does not exist" (live-verified 2026-09); [] works.
+        payload["keys"] = keys if keys is not None else []
         if as_of_date is not None:
             payload["asOfDate"] = as_of_date
         if end_date_override is not None:
@@ -1840,9 +1842,40 @@ class OrionAPI(BaseAPI):
         )
         return _json_or_none(res)
 
+    def create_bill_data_files(self, instance_id):
+        """Create the Data Files for a billing instance and advance its status.
+
+        What "Create" on the Data Files step of Orion's billing screen calls.
+        Unlike generate_audit_files(), this completes the Data Files step: a
+        forecast in "Data Files Needed" moves to "Complete". It also writes a
+        fourth file, "reconciliation data.XLSX", alongside the billing audit
+        CSV and the billing data / payable summary XLSX files.
+
+        The call returns before the files exist (they appeared within ~10s,
+        2026-09); list them with get_audit_files(instance_id=...).
+
+        Args:
+            instance_id: Billing instance ID
+
+        Returns:
+            None: Orion answers 200 with an empty body
+        """
+        if not isinstance(instance_id, int) or instance_id < 1:
+            raise ValueError("instance_id must be a positive integer")
+
+        res = self.api_request(
+            f"{self.base_url}/Billing/Instances/{instance_id}/Action/BillDataFiles",
+            requests.post,
+        )
+        return _json_or_none(res)
+
     def generate_audit_files(self, instance_ids, start_date=None, end_date=None, entity_list=None):
         """Generate the billing audit files for billing instance(s).
 
+        This does NOT complete the Data Files step: the instance stays in
+        "Data Files Needed". To do what the billing screen's "Create" does,
+        use create_bill_data_files().
+
         Works on forecast instances. For one instance Orion produced three
         files within ~10s: "billing audit.CSV", "billing data.XLSX" and
         "payable summary data.XLSX". The call returns before they exist; poll
@@ -3004,6 +3037,45 @@ class EclipseBase(BaseAPI):
             owner._orion_connect_firm_id = firm_ids[0]
         return owner._orion_connect_firm_id
 
+    def get_analytics_status(self):
+        """Check if analytics are currently running.
+
+        Returns:
+            dict: Status with 'isAnalysisRunning' and 'doRunAnalytics' flags
+                  (0 = not running/no pending, 1 = running/pending)
+        """
+        res = self.api_request(f"{self.base_url}/dataimport/analysis/status")
+        return res.json()
+
+    def wait_for_analytics(self, poll_interval=1, timeout=300):
+        """Wait for analytics to complete.
+
+        Polls the analytics status until isAnalysisRunning is 0.
+
+        Args:
+            poll_interval: Seconds between status checks (default 1)
+            timeout: Max seconds to wait (default 300)
+
+        Returns:
+            True when analytics complete
+
+        Raises:
+            TimeoutError: If analytics don't complete within timeout
+        """
+        start = time.time()
+        while True:
+            status = self.get_analytics_status()
+            if not status.get("isAnalysisRunning"):
+                return True
+            if time.time() - start > timeout:
+                raise TimeoutError(f"Analytics did not complete within {timeout} seconds")
+            time.sleep(poll_interval)
+
+    def _maybe_wait_for_analytics(self, sync):
+        """Helper to conditionally wait for analytics."""
+        if sync:
+            self.wait_for_analytics()
+
 
 class EclipseV1(EclipseBase):
     """Eclipse client targeting the v1 API surface (``/v1/...``) only.
@@ -3417,45 +3489,6 @@ class EclipseV1(EclipseBase):
         res = self.api_request(f"{self.base_url}/postimport/run_need_analysis")
         return res.json()
 
-    def get_analytics_status(self):
-        """Check if analytics are currently running.
-
-        Returns:
-            dict: Status with 'isAnalysisRunning' and 'doRunAnalytics' flags
-                  (0 = not running/no pending, 1 = running/pending)
-        """
-        res = self.api_request(f"{self.base_url}/dataimport/analysis/status")
-        return res.json()
-
-    def wait_for_analytics(self, poll_interval=1, timeout=300):
-        """Wait for analytics to complete.
-
-        Polls the analytics status until isAnalysisRunning is 0.
-
-        Args:
-            poll_interval: Seconds between status checks (default 1)
-            timeout: Max seconds to wait (default 300)
-
-        Returns:
-            True when analytics complete
-
-        Raises:
-            TimeoutError: If analytics don't complete within timeout
-        """
-        start = time.time()
-        while True:
-            status = self.get_analytics_status()
-            if not status.get("isAnalysisRunning"):
-                return True
-            if time.time() - start > timeout:
-                raise TimeoutError(f"Analytics did not complete within {timeout} seconds")
-            time.sleep(poll_interval)
-
-    def _maybe_wait_for_analytics(self, sync):
-        """Helper to conditionally wait for analytics."""
-        if sync:
-            self.wait_for_analytics()
-
     def get_orders(self):
         """Deprecated alias of ``get_trades(is_pending=False)``.
 
@@ -3825,9 +3858,19 @@ class EclipseV1(EclipseBase):
         selected_method_id=None,
         spend_full_amount=None,
         filter_type=None,
+        accounts=None,
     ):
         """Generate Spend Cash trade for portfolios.
 
+        Eclipse's spend-cash generator needs the accounts spelled out: a body with
+        only ``portfolioIds`` returns 500 "please verify parameters" for every
+        portfolio (live-verified 2026-09-29 across 9 portfolios). So when
+        ``accounts`` is omitted, the accounts of each portfolio are resolved via
+        :meth:`get_portfolio_accounts` and sent as ``{"id": <internal id>,
+        "amount": 0}`` (one extra GET per portfolio). ``sleevedPortfolios`` and
+        ``emphasiedAccounts`` (sic, Eclipse's spelling) are sent as null, as in
+        Eclipse's documented examples.
+
         Args:
             portfolio_ids: List of portfolio IDs to process
             portfolio_trade_group_ids: List of portfolio trade group IDs (optional)
@@ -3841,12 +3884,23 @@ class EclipseV1(EclipseBase):
                 (see ``get_spend_cash_methods``); added to the body only when provided
             spend_full_amount: Optional bool; added to the body only when provided
             filter_type: Optional filter type; added to the body only when provided
+            accounts: Optional list of ``{"id": <Eclipse internal account id>,
+                "amount": <number>}``. Omitted: resolved from ``portfolio_ids``.
+                Account ids are Eclipse internal ids (``get_portfolio_accounts``
+                ``id``), not the Orion ``accountId``.
 
         Returns:
             dict with 'issues', 'success', and 'instanceId' fields
         """
         if portfolio_trade_group_ids is None:
             portfolio_trade_group_ids = []
+        if accounts is None:
+            accounts = [
+                {"id": acct["id"], "amount": 0}
+                for pid in portfolio_ids or []
+                for acct in (self.get_portfolio_accounts(pid) or [])
+                if isinstance(acct, dict) and acct.get("id") is not None
+            ]
 
         payload = {
             "portfolioIds": portfolio_ids,
@@ -3854,6 +3908,9 @@ class EclipseV1(EclipseBase):
             "isViewOnly": is_view_only,
             "reason": reason,
             "isExcelImport": is_excel_import,
+            "accounts": accounts,
+            "sleevedPortfolios": None,
+            "emphasiedAccounts": None,
         }
         if selected_method_id is not None:
             payload["selectedMethodId"] = selected_method_id
@@ -9726,7 +9783,7 @@ class EclipseV2(EclipseBase):
         )
         return res.json()
 
-    def billing_set_aside_cash(self, payload):
+    def billing_set_aside_cash(self, payload, sync=False):
         """Set each account's billing set-aside cash (mutating).
 
         The endpoint behind Orion's Cash Funding Export. Give it dollar
@@ -9751,6 +9808,8 @@ class EclipseV2(EclipseBase):
                 Orion account id (the ``id`` of a get_cash_funding() row), not
                 the Eclipse id. ``orionConnectFirmId`` is filled in from
                 get_orion_connect_firm_id() when an entry omits it.
+            sync: If True, wait for Eclipse analytics to finish after the
+                POST, as create_set_aside(sync=True) does (default False)
 
         Returns:
             dict | None: Parsed response, or None on the empty body the
@@ -9770,7 +9829,9 @@ class EclipseV2(EclipseBase):
         res = self.api_request(
             f"{self.base_url_v2}/SetAsideCash/BillingSetAsideCash", requests.post, json=payload
         )
-        return _json_or_none(res)
+        result = _json_or_none(res)
+        self._maybe_wait_for_analytics(sync)
+        return result
 
     def delete_account_set_aside_cash(self, payload):
         """Delete account set-aside cash (mutating).

{orionapi-2.32.1 → orionapi-2.34.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "orionapi"
-version = "2.32.1"
+version = "2.34.0"
 description = "A python interface for the Orion Advisors platform web API"
 authors = ["spencerogden-dsam <67068943+spencerogden-dsam@users.noreply.github.com>"]