orionapi 2.28.0__tar.gz → 2.30.0__tar.gz

{orionapi-2.28.0 → orionapi-2.30.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionapi
-Version: 2.28.0
+Version: 2.30.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.28.0 → orionapi-2.30.0}/orionapi/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.28.0"
+__version__ = "2.30.0"
 
 import logging
 import re
@@ -332,6 +332,25 @@ class BaseAPI:
 
         return data
 
+    def _request_kwargs(self, timeout=None):
+        """Timeout + SSL kwargs for unauthenticated (pre-token) requests.
+
+        ``login()`` cannot go through :meth:`api_request` — there is no token yet,
+        so header construction would raise — but it still needs the same timeout
+        and SSL defaults applied here.
+
+        Args:
+            timeout: Per-call timeout in seconds. When None, falls back to the
+                client's ``self.timeout``.
+
+        Returns:
+            dict: ``timeout`` and ``verify`` kwargs for ``requests``.
+        """
+        return {
+            "timeout": self.timeout if timeout is None else timeout,
+            "verify": self.ca_bundle if self.ca_bundle else self.verify_ssl,
+        }
+
     def api_request(self, url, req_func=None, timeout=None, **kwargs):
         """Make an authenticated API request with error handling.
 
@@ -440,18 +459,24 @@ class OrionAPI(BaseAPI):
             self.login(usr, pwd)
             # Credentials are not stored to prevent memory exposure
 
-    def login(self, usr=None, pwd=None):
+    def login(self, usr=None, pwd=None, timeout=None):
         """Authenticate with the Orion API.
 
         Args:
             usr: Username for authentication
             pwd: Password for authentication
+            timeout: Request timeout in seconds. When None (default), falls back
+                to the client's ``self.timeout`` (constructor default 30).
 
         Raises:
             AuthenticationError: If credentials are invalid
         """
         with self._token_lock:
-            res = requests.get(f"{self.base_url}/security/token", auth=(usr, pwd))
+            res = requests.get(
+                f"{self.base_url}/security/token",
+                auth=(usr, pwd),
+                **self._request_kwargs(timeout),
+            )
             if not res.ok:
                 raise AuthenticationError(f"Login failed: {res.status_code} {res.reason}")
             try:
@@ -2275,13 +2300,15 @@ class EclipseBase(BaseAPI):
         elif orion_token is not None:
             self.login(orion_token=orion_token)
 
-    def login(self, usr=None, pwd=None, orion_token=None):
+    def login(self, usr=None, pwd=None, orion_token=None, timeout=None):
         """Authenticate with the Eclipse API.
 
         Args:
             usr: Username for authentication
             pwd: Password for authentication
             orion_token: Orion session token (alternative to usr/pwd)
+            timeout: Request timeout in seconds. When None (default), falls back
+                to the client's ``self.timeout`` (constructor default 30).
 
         Raises:
             AuthenticationError: If credentials are invalid or missing
@@ -2291,7 +2318,11 @@ class EclipseBase(BaseAPI):
 
         with self._token_lock:
             if usr is not None:
-                res = requests.get(f"{self.base_url}/admin/token", auth=(usr, pwd))
+                res = requests.get(
+                    f"{self.base_url}/admin/token",
+                    auth=(usr, pwd),
+                    **self._request_kwargs(timeout),
+                )
                 if not res.ok:
                     raise AuthenticationError(f"Login failed: {res.status_code} {res.reason}")
                 try:
@@ -2303,6 +2334,7 @@ class EclipseBase(BaseAPI):
                 res = requests.get(
                     f"{self.base_url}/admin/token",
                     headers={"Authorization": "Session " + orion_token},
+                    **self._request_kwargs(timeout),
                 )
                 if not res.ok:
                     raise AuthenticationError(
@@ -2778,6 +2810,11 @@ class EclipseV1(EclipseBase):
         """Get portfolio details by ID.
 
         Returns dict with 'general', 'teams', 'issues', 'summary' sections.
+        The 'general' section carries ``teamIds`` / ``primaryTeamId``. The
+        'teams' section's per-record field spelling is unspecified upstream
+        (``id`` vs ``teamId``, ``name`` vs ``teamName``) — accept both, or use
+        :meth:`get_portfolio_teams` for a normalized ``{id, name, is_primary}``
+        view.
         """
         res = self.api_request(f"{self.base_url}/portfolio/portfolios/{portfolio_id}")
         return res.json()
@@ -6631,6 +6668,108 @@ class EclipseV1(EclipseBase):
             json=payload,
         ).json()
 
+    # --- Admin: Teams (v1 reads) ---
+    # The v1 team routes are the reliable team read on tenants where teams were
+    # not created with an externalId — EclipseV2.get_teams returns [] there
+    # (see its docstring). teamIds/primaryTeamId are required on the portfolio
+    # record, so these are the reads that unblock create_portfolio.
+
+    def get_teams(self, is_active=None):
+        """Get all teams (``GET /admin/teams``).
+
+        Args:
+            is_active: When set, passed as ``isActive`` (e.g. ``True`` returns
+                active teams only). When None (default), the parameter is
+                omitted and all teams are returned.
+
+        Returns:
+            list: Team dicts. At minimum ``{id, name}``; the full record also
+            carries ``portfolioAccess``, ``modelAccess``, ``status``,
+            ``numberOfUsers``, ``numberOfModels``, ``numberOfPortfolios``,
+            ``numberOfAdvisors``, ``isDeleted``, ``createdOn/By``,
+            ``editedOn/By``.
+        """
+        params = {}
+        if is_active is not None:
+            params["isActive"] = str(bool(is_active)).lower()
+        res = self.api_request(f"{self.base_url}/admin/teams", params=params)
+        return res.json()
+
+    def get_team(self, team_id):
+        """Get details for a single team (``GET /admin/teams/{id}``).
+
+        Args:
+            team_id: Eclipse team ID
+
+        Returns:
+            dict: Team detail record
+        """
+        res = self.api_request(f"{self.base_url}/admin/teams/{team_id}")
+        return res.json()
+
+    def get_team_portfolios(self, team_id):
+        """Get portfolios associated with a team (``GET /admin/teams/{id}/portfolios``).
+
+        Args:
+            team_id: Eclipse team ID
+
+        Returns:
+            list: Portfolio dicts (``{id, name, isDeleted, createdOn/By, editedOn/By}``)
+        """
+        res = self.api_request(f"{self.base_url}/admin/teams/{team_id}/portfolios")
+        return res.json()
+
+    def get_team_primary_portfolios(self, team_id):
+        """Get portfolios where the team is set as primary
+        (``GET /admin/teams/{id}/primaryPortfolios``).
+
+        Args:
+            team_id: Eclipse team ID
+
+        Returns:
+            list: Portfolio dicts (``{id, name, createdOn/By, editedOn/By}``)
+        """
+        res = self.api_request(f"{self.base_url}/admin/teams/{team_id}/primaryPortfolios")
+        return res.json()
+
+    def get_portfolio_teams(self, portfolio_id):
+        """Get the teams stamped on a portfolio, normalized.
+
+        Reads the ``teams`` section of ``GET /portfolio/portfolios/{id}``
+        (see :meth:`get_portfolio`) and normalizes each record to
+        ``{id, name, is_primary}``. Unlike the ``/admin/teams`` routes, this
+        works for a credential that is on no team at all, so it is the team
+        read of last resort for service accounts.
+
+        The upstream field spelling is unspecified (``id`` vs ``teamId``,
+        ``name`` vs ``teamName``), so both are accepted. ``is_primary`` is
+        derived from ``general.primaryTeamId`` when present, falling back to
+        the record's own ``isPrimaryTeam`` flag.
+
+        Args:
+            portfolio_id: Portfolio ID
+
+        Returns:
+            list: ``{id, name, is_primary}`` dicts, one per team on the portfolio
+        """
+        portfolio = self.get_portfolio(portfolio_id)
+        primary_team_id = portfolio.get("general", {}).get("primaryTeamId")
+        normalized = []
+        for team in portfolio.get("teams") or []:
+            team_id = team.get("id", team.get("teamId"))
+            if primary_team_id is not None:
+                is_primary = team_id == primary_team_id
+            else:
+                is_primary = bool(team.get("isPrimaryTeam"))
+            normalized.append(
+                {
+                    "id": team_id,
+                    "name": team.get("name", team.get("teamName")),
+                    "is_primary": is_primary,
+                }
+            )
+        return normalized
+
     # --- Admin token (v1) ---
 
     def get_firm_token(self, payload):
@@ -10075,13 +10214,19 @@ class EclipseV2(EclipseBase):
     # --- Team / ServiceTeams / User ---
 
     def get_teams(self, external_id=None):
-        """Get teams.
+        """Get teams (v2 ``Team/Team/GetTeams``).
+
+        Warning:
+            Returns ``[]`` (HTTP 200) on tenants where teams were not created
+            with an ``externalId`` — live-verified 2026-08-17. Prefer the v1
+            route (:meth:`EclipseV1.get_teams`, ``GET /admin/teams``), which
+            the :class:`Eclipse` unifier resolves to.
 
         Args:
             external_id: Optional external ID filter (maps to ``externalId``)
 
         Returns:
-            list: Team dicts
+            list: Team dicts (``{teamId, teamName, isPrimaryTeam, ...}``)
         """
         params = {}
         if external_id is not None:
@@ -11681,6 +11826,21 @@ class Eclipse(EclipseBase):
             internal_account_id=internal_account_id,
         )
 
+    # --- v1-preferred overrides (documented best-of-both choices) ----------------
+
+    def get_teams(self, is_active=None):
+        """Teams via the v1 route (best: v2 ``GetTeams`` is empty on some tenants).
+
+        Delegates to :meth:`EclipseV1.get_teams` (``GET /admin/teams``),
+        returning ``{id, name, ...}`` records. **Behavior change in 2.30.0:**
+        this name previously resolved to :meth:`EclipseV2.get_teams`, which
+        returns ``[]`` (with differently spelled ``{teamId, teamName,
+        isPrimaryTeam}`` records) on tenants where teams were not created with
+        an ``externalId``. Use ``self.v2.get_teams(external_id=...)`` for the
+        v2 surface explicitly.
+        """
+        return self.v1.get_teams(is_active=is_active)
+
 
 class EclipseAPI(Eclipse):
     """Deprecated alias of :class:`Eclipse` (best-of-both client).

{orionapi-2.28.0 → orionapi-2.30.0}/pyproject.toml

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