interhumanai 1.2.2__tar.gz → 1.2.3__tar.gz

{interhumanai-1.2.2 → interhumanai-1.2.3}/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to `interhumanai` are documented here. The package follows
 the TypeScript SDK (`@interhumanai/sdk`): both packages always carry the same
 version and release together.
 
+## 1.2.3
+
+- Revised the reference documentation for authentication. Documentation only;
+  no behavior change.
+
 ## 1.2.2
 
 - Corrected the reference docs for ``SessionConfigOptions.model``: it lists the models the

{interhumanai-1.2.2 → interhumanai-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: interhumanai
-Version: 1.2.2
+Version: 1.2.3
 Summary: First-party Python SDK for the Interhuman API: upload and stream social-signal analysis.
 Project-URL: Homepage, https://docs.interhuman.ai
 Project-URL: Repository, https://github.com/interhumanai/interhuman-api

{interhumanai-1.2.2 → interhumanai-1.2.3}/src/interhumanai/_version.py

@@ -1,3 +1,3 @@
 """Package version (single source of truth, read by hatchling at build time)."""
 
-__version__ = "1.2.2"
+__version__ = "1.2.3"

{interhumanai-1.2.2 → interhumanai-1.2.3}/src/interhumanai/auth.py

@@ -20,7 +20,7 @@ DEFAULT_REFRESH_SKEW_SECONDS = 30.0
 
 
 class TokenResponse(BaseModel):
-    """Response of ``POST /v1/auth``."""
+    """Response of a token request."""
 
     access_token: str
     token_type: str
@@ -48,7 +48,7 @@ def _scope_values(scopes: Sequence[Scope | str]) -> list[str]:
 
 
 class AuthClient:
-    """Client for the token endpoints (``/v1/auth`` and ``/v1/client_tokens``).
+    """Client for the client-token endpoints (``/v1/client_tokens``).
 
     Args:
         environment: Named environment to call. Defaults to ``production``.
@@ -89,7 +89,7 @@ class AuthClient:
         key_secret: str,
         scopes: Sequence[Scope | str],
     ) -> TokenResponse:
-        """Exchange API key credentials for a short-lived bearer access token.
+        """Authenticate with API key credentials for a short-lived session.
 
         Args:
             key_id: The API key id.
@@ -163,10 +163,10 @@ class AuthClient:
 
 
 class TokenProvider(Protocol):
-    """Anything that can produce a bearer access token on demand."""
+    """Anything that can produce a bearer credential on demand."""
 
     async def get_token(self) -> str:
-        """Return a currently valid bearer access token."""
+        """Return a currently valid bearer credential."""
         ...
 
 
@@ -177,7 +177,7 @@ class StaticTokenProvider:
         """Store the token to hand out.
 
         Args:
-            token: The bearer access token to return from :meth:`get_token`.
+            token: The client token or API key to return from :meth:`get_token`.
         """
         self._token = token
 
@@ -224,7 +224,7 @@ class TokenManager:
         self._lock = asyncio.Lock()
 
     async def get_token(self) -> str:
-        """Return a valid access token, minting or refreshing when needed."""
+        """Return a valid bearer credential, renewing it when needed."""
         async with self._lock:
             if self._token is not None and self._clock() < self._refresh_at:
                 return self._token

{interhumanai-1.2.2 → interhumanai-1.2.3}/src/interhumanai/client.py

@@ -35,7 +35,7 @@ class InterhumanClient:
     Args:
         key_id: API key id (paired with ``key_secret``).
         key_secret: API key secret.
-        access_token: Pre-issued bearer token (JWT or client token).
+        access_token: A client token, or your API key, used as-is.
         scopes: Scopes requested when exchanging credentials. Defaults to
             upload + stream. Ignored when ``access_token`` is used.
         environment: Named environment to call. Defaults to ``production``.