feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 37
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-838f03b1c3584485eeded993459e6bbae058da9f6df16b7967980fbba98cc748.yml
-openapi_spec_hash: 4a9db9cd9eac4ae4e2694b3d835a772f
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-21a0195dcea548066fd6c227d634217b897900a6732a688e41c83344c2e92c94.yml
+openapi_spec_hash: 388f5780dc9bf205c04b6a6214e4fafc
 config_hash: 2bea1743c84d63bd61f8501a6ea63065

src/context/dev/types/batch_cancel_response.py

@@ -4,86 +4,45 @@
 from typing_extensions import Literal
 
 from .intake import Intake
-from .failure import Failure
 from .._models import BaseModel
 from .crawl_controls import CrawlControls
 from .page_error_count import PageErrorCount
 
-__all__ = ["BatchCancelResponse", "Credits", "Progress", "Results", "ResultsFile", "Timing", "KeyMetadata"]
+__all__ = ["BatchCancelResponse", "Credits", "Progress", "Timing", "KeyMetadata"]
 
 
 class Credits(BaseModel):
-    """What this batch has done to your credit balance."""
-
-    net: int
-    """`reserved` minus `refunded` — what the batch has cost so far.
-
-    Equal to `reserved` until the batch settles.
-    """
-
-    refunded: int
-    """Credits returned for pages that did not succeed.
-
-    Stays 0 until the batch reaches a final status, then settles in one movement.
-    """
+    """What this batch cost so far."""
 
     reserved: int
-    """Credits debited from your balance the moment the batch was accepted.
+    """Credits debited at submission.
 
-    This is a charge, not a forecast — the whole amount leaves the balance up front.
+    The unspent remainder is refunded once the batch settles — read
+    `credits.refunded` from GET /batch/{batch_id} then.
     """
 
 
 class Progress(BaseModel):
-    """Pages attempted so far. Use `status` to check completion."""
+    """How far the batch got before cancellation."""
 
     failed: int
-    """Pages that could not be scraped."""
+    """Pages that could not be scraped before the request landed."""
 
     pending: int
-    """Reserved pages not yet attempted.
-
-    A cancelled batch keeps reporting the URLs it never reached; a crawl whose
-    `input.reserved_is_ceiling` is true reports 0 once final, because its unspent
-    budget was never real pages.
-    """
+    """Reserved pages that will now be skipped, and refunded when the batch settles."""
 
     succeeded: int
-    """Pages scraped successfully."""
-
-
-class ResultsFile(BaseModel):
-    bytes: int
-    """Compressed file size in bytes."""
-
-    items: int
-    """Results in this file."""
-
-    url: str
-    """Temporary URL for a gzipped NDJSON file."""
-
-
-class Results(BaseModel):
-    """
-    Download links, available once the batch reaches a final status and null before then. GET /batch/{batch_id}/results serves the same records as paginated JSON.
-    """
-
-    expires_at: str
-    """When the download URLs expire."""
-
-    files: List[ResultsFile]
-    """Result files. Order is not guaranteed."""
+    """Pages scraped successfully before the request landed."""
 
 
 class Timing(BaseModel):
-    completed_at: Optional[str] = None
-    """When processing finished. Null while active."""
+    """There is no finish time yet — the batch is still winding down."""
 
     created_at: str
     """When the batch was created."""
 
     started_at: Optional[str] = None
-    """When processing started. Null while queued."""
+    """When processing started. Null if it was cancelled while still queued."""
 
 
 class KeyMetadata(BaseModel):
@@ -98,7 +57,7 @@ class KeyMetadata(BaseModel):
 
 class BatchCancelResponse(BaseModel):
     id: str
-    """Batch ID used to retrieve or cancel the job."""
+    """Batch ID."""
 
     crawl: Optional[CrawlControls] = None
     """
@@ -107,48 +66,34 @@ class BatchCancelResponse(BaseModel):
     """
 
     credits: Credits
-    """What this batch has done to your credit balance."""
-
-    failure: Optional[Failure] = None
-    """
-    A failure of the batch as a whole, distinct from the per-page failures in
-    `page_errors`.
-    """
+    """What this batch cost so far."""
 
     format: Literal["markdown", "html"]
-    """What each page is returned as.
-
-    Matches `input.data.format` on the submit request.
-    """
+    """What each page is returned as."""
 
     input: Intake
     """What submission took in, and what it charged for."""
 
     mode: Literal["scrape", "crawl"]
-    """How pages were selected. Matches `input.mode` on the submit request."""
+    """How pages were selected."""
 
     page_errors: List[PageErrorCount]
-    """Individual page failures grouped by error code, sorted by count.
-
-    Unrelated to `failure`, which is the batch itself failing.
-    """
+    """Page failures so far, grouped by error code and sorted by count."""
 
     progress: Progress
-    """Pages attempted so far. Use `status` to check completion."""
+    """How far the batch got before cancellation."""
 
-    results: Optional[Results] = None
-    """
-    Download links, available once the batch reaches a final status and null before
-    then. GET /batch/{batch_id}/results serves the same records as paginated JSON.
-    """
+    status: Literal["cancelling"]
+    """Always `cancelling`.
 
-    status: Literal["queued", "running", "cancelling", "completed", "cancelled", "failed"]
-    """Current state. `completed`, `cancelled`, and `failed` are final."""
+    Work already in flight finishes; the batch reaches `cancelled` shortly after.
+    """
 
     tags: List[str]
     """Tags stored on the batch at submission."""
 
     timing: Timing
+    """There is no finish time yet — the batch is still winding down."""
 
     key_metadata: Optional[KeyMetadata] = None
     """API key usage for this request."""