feat(api): update via SDK Studio (#67)

Author: stainless-app[bot]

.github/workflows/create-releases.yml

@@ -1,9 +1,13 @@
-# workflow for re-running publishing to PyPI in case it fails for some reason
-# you can run this workflow by navigating to https://www.github.com/hyperspell/python-sdk/actions/workflows/publish-pypi.yml
+# This workflow is triggered when a GitHub release is created.
+# It can also be run manually to re-publish to PyPI in case it failed for some reason.
+# You can run this workflow by navigating to https://www.github.com/hyperspell/python-sdk/actions/workflows/publish-pypi.yml
 name: Publish PyPI
 on:
   workflow_dispatch:
 
+  release:
+    types: [published]
+
 jobs:
   publish:
     name: publish

.github/workflows/publish-pypi.yml

@@ -18,5 +18,4 @@ jobs:
         run: |
           bash ./bin/check-release-environment
         env:
-          STAINLESS_API_KEY: ${{ secrets.STAINLESS_API_KEY }}
           PYPI_TOKEN: ${{ secrets.HYPERSPELL_PYPI_TOKEN || secrets.PYPI_TOKEN }}

.github/workflows/release-doctor.yml

@@ -1,3 +1,9 @@
+# Shared Types
+
+```python
+from hyperspell.types import Apikey, App, Collection
+```
+
 # Documents
 
 Types:

api.md

@@ -2,10 +2,6 @@
 
 errors=()
 
-if [ -z "${STAINLESS_API_KEY}" ]; then
-  errors+=("The STAINLESS_API_KEY secret has not been set. Please contact Stainless for an API key & set it in your organization secrets on GitHub.")
-fi
-
 if [ -z "${PYPI_TOKEN}" ]; then
   errors+=("The HYPERSPELL_PYPI_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets.")
 fi

bin/check-release-environment

@@ -4,6 +4,7 @@
 
 from .token import Token as Token
 from .scores import Scores as Scores
+from .shared import App as App, Apikey as Apikey, Collection as Collection
 from .document import Document as Document
 from .collection import Collection as Collection
 from .document_status import DocumentStatus as DocumentStatus

src/hyperspell/types/__init__.py

@@ -0,0 +1,5 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .app import App as App
+from .apikey import Apikey as Apikey
+from .collection import Collection as Collection

src/hyperspell/types/shared/__init__.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._compat import PYDANTIC_V2
+from ..._models import BaseModel
+
+__all__ = ["Apikey"]
+
+
+class Apikey(BaseModel):
+    app_id: int
+
+    scopes: List[Literal["all", "ingest", "query"]]
+
+    secret: str
+
+    id: Optional[int] = None
+
+    app: Optional["App"] = None
+    """Apps Base Schema."""
+
+    created_at: Optional[datetime] = None
+
+    label: Optional[str] = None
+
+    revoked_at: Optional[datetime] = None
+
+
+from .app import App
+
+if PYDANTIC_V2:
+    Apikey.model_rebuild()
+else:
+    Apikey.update_forward_refs()  # type: ignore

src/hyperspell/types/shared/apikey.py

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from datetime import datetime
+
+from ..._compat import PYDANTIC_V2
+from ..._models import BaseModel
+
+__all__ = ["App"]
+
+
+class App(BaseModel):
+    name: str
+
+    slug: str
+
+    user_id: str
+
+    id: Optional[int] = None
+
+    api_keys: Optional[List["Apikey"]] = None
+
+    collections: Optional[List["Collection"]] = None
+
+    created_at: Optional[datetime] = None
+
+    integrations: Optional[List[object]] = None
+
+    jwt_secret: Optional[str] = None
+
+    optional_integrations: Optional[List[object]] = None
+
+    public_key: Optional[str] = None
+
+    settings: Optional[object] = None
+
+
+from .apikey import Apikey
+from .collection import Collection
+
+if PYDANTIC_V2:
+    App.model_rebuild()
+else:
+    App.update_forward_refs()  # type: ignore

src/hyperspell/types/shared/app.py

@@ -0,0 +1,137 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..scores import Scores
+from ..._compat import PYDANTIC_V2
+from ..._models import BaseModel
+
+__all__ = ["Collection", "Document", "DocumentEvent", "DocumentSection"]
+
+
+class DocumentEvent(BaseModel):
+    message: str
+
+    type: Literal["error", "warning", "info"]
+
+    time: Optional[datetime] = None
+
+
+class DocumentSection(BaseModel):
+    document_id: int
+
+    text: str
+    """Summary of the section"""
+
+    id: Optional[int] = None
+
+    content: Optional[str] = None
+
+    elements: Optional[List[object]] = None
+
+    embedding_e5_large: Optional[List[float]] = None
+
+    embedding_ts: Optional[str] = None
+
+    metadata: Optional[Dict[str, object]] = None
+
+    scores: Optional[Scores] = None
+
+
+class Document(BaseModel):
+    collection_id: int
+
+    data: Union[List[object], object]
+    """Structured representation of the document"""
+
+    summary: str
+    """Summary of the document"""
+
+    id: Optional[int] = None
+
+    collection: Optional[str] = None
+
+    created_at: Optional[datetime] = None
+
+    events: Optional[List[DocumentEvent]] = None
+
+    ingested_at: Optional[datetime] = None
+
+    metadata: Optional[Dict[str, object]] = None
+
+    resource_id: Optional[str] = None
+    """Along with service, uniquely identifies the source document"""
+
+    sections: Optional[List[DocumentSection]] = None
+
+    sections_count: Optional[int] = None
+
+    source: Optional[Literal["generic", "slack", "s3", "gmail", "notion", "google_docs", "hubspot"]] = None
+
+    status: Optional[Literal["pending", "processing", "completed", "failed"]] = None
+
+    title: Optional[str] = None
+
+    type: Optional[
+        Literal[
+            "generic",
+            "markdown",
+            "chat",
+            "email",
+            "transcript",
+            "legal",
+            "website",
+            "image",
+            "pdf",
+            "audio",
+            "spreadsheet",
+            "archive",
+            "book",
+            "video",
+            "code",
+            "calendar",
+            "json",
+            "presentation",
+            "unsupported",
+            "person",
+            "company",
+            "crm_contact",
+        ]
+    ] = None
+
+
+class Collection(BaseModel):
+    app_id: int
+
+    name: str
+
+    id: Optional[int] = None
+
+    app: Optional["App"] = None
+    """Apps Base Schema."""
+
+    created_at: Optional[datetime] = None
+
+    documents: Optional[List[Document]] = None
+
+    documents_count: Optional[int] = None
+
+    owner: Optional[str] = None
+
+
+from .app import App
+
+if PYDANTIC_V2:
+    Collection.model_rebuild()
+    Document.model_rebuild()
+    DocumentEvent.model_rebuild()
+    DocumentSection.model_rebuild()
+else:
+    Collection.update_forward_refs()  # type: ignore
+    Document.update_forward_refs()  # type: ignore
+    DocumentEvent.update_forward_refs()  # type: ignore
+    DocumentSection.update_forward_refs()  # type: ignore