bytekit-sdk 0.8.0__tar.gz → 0.8.2__tar.gz

{bytekit_sdk-0.8.0 → bytekit_sdk-0.8.2}/CHANGELOG.md

@@ -5,6 +5,28 @@ PyPI distribution: `bytekit-sdk`. Import name: `bytekit`.
 
 ## Unreleased
 
+## 0.8.2
+
+_Release cut 2026-09-23._
+
+### Changed
+
+- **`AccountSessionResponse.onboarding_completed`** (#4780) — new `bool`: whether the account has
+  left dashboard onboarding. Additive, patch-level. Regenerated from `docs/api/openapi.yaml`.
+
+## 0.8.1
+
+_Release cut 2026-09-18._
+
+### Fixed
+
+- **`ListBulkScreenshotsResponse200ItemsItemType0.billing`** (#4582) — now typed
+  `Union[BillingNode, None, Unset]`. The gateway now returns `billing: null` on every bulk item
+  whose `status` is not `completed`, so an item keeps the same keys on every poll; the previous
+  model passed that `null` to `BillingNode.from_dict` and failed to parse the page. A completed
+  item still carries its node, and a completed item from before the node existed still omits the
+  key (`UNSET`). Regenerated from `docs/api/openapi.yaml`.
+
 ## 0.8.0
 
 _Release cut 2026-09-14._

{bytekit_sdk-0.8.0 → bytekit_sdk-0.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: bytekit-sdk
-Version: 0.8.0
+Version: 0.8.2
 Summary: Official Python SDK for the ByteKit API
 Project-URL: Homepage, https://bytekit.com
 Project-URL: Repository, https://github.com/Hunt-Labs-Inc/ByteKit

{bytekit_sdk-0.8.0 → bytekit_sdk-0.8.2}/pyproject.toml

@@ -7,7 +7,7 @@
 # `pip install bytekit-sdk` yields a working `import bytekit`. Mirrors the npm sibling
 # @hunt-labs/bytekit-sdk.
 name = "bytekit-sdk"
-version = "0.8.0"
+version = "0.8.2"
 description = "Official Python SDK for the ByteKit API"
 readme = "README.md"
 requires-python = ">=3.10"

{bytekit_sdk-0.8.0 → bytekit_sdk-0.8.2}/src/bytekit/models/account_session_response.py

@@ -44,9 +44,13 @@ class AccountSessionResponse:
                 a Clerk session or an API key. All-time — never windowed. A request that failed does not flip it, even when its
                 bandwidth was billed: the monitor terminal-preflight-failure path records bytes without credits, and only the
                 credited settlement counts here. Powers the dashboard onboarding gate — the app shows the guided onboarding flow
-                until this is true, then the dashboard. Lags by up to one usage rollup: the completion service writes the row
-                after the response is returned, so a just-completed first request may still read false for a moment. Treat that
-                as "not visible yet", never as "this account has never made a request".
+                until this or `onboarding_completed` is true, then the dashboard. Lags by up to one usage rollup: the completion
+                service writes the row after the response is returned, so a just-completed first request may still read false
+                for a moment. Treat that as "not visible yet", never as "this account has never made a request".
+            onboarding_completed (bool): True once a member of the account left onboarding through one of its exits (POST
+                /v1/account/complete-onboarding). Never reset. With `has_activity` it gates the dashboard: the app shows the
+                guided onboarding flow until either one is true, so a user whose first request failed can still reach the
+                dashboard.
             has_subscription (bool): True when the account has a Stripe subscription, keyed on the same
                 `stripe_subscription_id` column that GET /v1/billing/change-plan's `no_subscription` guard tests — so a client
                 can use it to decide whether that endpoint will answer at all. Stays TRUE while a subscription is mid-
@@ -64,6 +68,7 @@ class AccountSessionResponse:
     terms_version: str
     created_at: datetime.datetime
     has_activity: bool
+    onboarding_completed: bool
     has_subscription: bool
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
@@ -88,6 +93,8 @@ class AccountSessionResponse:
 
         has_activity = self.has_activity
 
+        onboarding_completed = self.onboarding_completed
+
         has_subscription = self.has_subscription
 
         field_dict: dict[str, Any] = {}
@@ -103,6 +110,7 @@ class AccountSessionResponse:
                 "terms_version": terms_version,
                 "created_at": created_at,
                 "has_activity": has_activity,
+                "onboarding_completed": onboarding_completed,
                 "has_subscription": has_subscription,
             }
         )
@@ -147,6 +155,8 @@ class AccountSessionResponse:
 
         has_activity = d.pop("has_activity")
 
+        onboarding_completed = d.pop("onboarding_completed")
+
         has_subscription = d.pop("has_subscription")
 
         account_session_response = cls(
@@ -159,6 +169,7 @@ class AccountSessionResponse:
             terms_version=terms_version,
             created_at=created_at,
             has_activity=has_activity,
+            onboarding_completed=onboarding_completed,
             has_subscription=has_subscription,
         )
 

{bytekit_sdk-0.8.0 → bytekit_sdk-0.8.2}/src/bytekit/models/get_fetch_bulk_response_200_status.py

@@ -2,6 +2,7 @@ from enum import Enum
 
 
 class GetFetchBulkResponse200Status(str, Enum):
+    CANCELLED = "cancelled"
     COMPLETED = "completed"
     FAILED = "failed"
     PROCESSING = "processing"

{bytekit_sdk-0.8.0 → bytekit_sdk-0.8.2}/src/bytekit/models/get_fetch_bulk_response_202_status.py

@@ -2,7 +2,6 @@ from enum import Enum
 
 
 class GetFetchBulkResponse202Status(str, Enum):
-    CANCELLED = "cancelled"
     PROCESSING = "processing"
 
     def __str__(self) -> str:

{bytekit_sdk-0.8.0 → bytekit_sdk-0.8.2}/src/bytekit/models/list_bulk_screenshots_response_200_items_item_type_0.py

@@ -44,30 +44,12 @@ class ListBulkScreenshotsResponse200ItemsItemType0:
             error_code (Union[None, str]):
             error_message (Union[None, str]): Bounded human-readable failure detail.
             credits_charged (Union[None, Unset, float]):
-            billing (Union[Unset, BillingNode]): The authoritative, self-explaining account of what this call was billed and
-                why. `multiplier` is the product of every entry in `factors`, composed in
-                list order (`endpoint` → `cache_hit` → `clean_markdown`), and
-                `billed_bytes = round(raw_bytes × multiplier)` behind exactly one rounding.
-                The factor list is the DEFINITION of the charge; the `X-Raw-Bytes` /
-                `X-Billing-Multiplier` / `X-Billable-Bytes` response headers are a rendering
-                of this same node, so where a header and this node disagree, the header is
-                the bug.
-
-                Two billable surfaces carry no node, by design rather than by omission:
-
-                * `POST /v1/search` is billed per credit, not per byte. Its charge is
-                  reported by `credits_used`; no byte multiplier applies to it and the
-                  factor vocabulary has no `search` term.
-                * Single (non-bulk) `POST /v1/fetch` returns the fetched bytes as the
-                  response body, so it has no JSON envelope in which to carry a node. Its
-                  charge is reported by the `X-Raw-Bytes` / `X-Billing-Multiplier` /
-                  `X-Billable-Bytes` header trio alone. Items under
-                  `GET /v1/fetch/bulk/{id}` DO carry the node.
-
-                Historical rows: for a resource that completed before its billing node was
-                persisted, this field is OMITTED rather than emitted as a zero node — a zero
-                node would assert that a real past charge was zero. Treat absence as "not
-                available for this row" and read the charge from `GET /v1/usage`.
+            billing (Union['BillingNode', None, Unset]): Itemised account of this item's charge — the basis, the named
+                factors
+                that composed the multiplier, and the resulting billed bytes. `null`
+                while `status` is not `completed` — the charge is not final yet, and
+                the key is present so an item keeps the same shape on every poll.
+                Omitted for rows that completed before the billing node was persisted.
             created_at (Union[Unset, datetime.datetime]):
             completed_at (Union[None, Unset, datetime.datetime]):
             image_url (Union[None, Unset, str]): `type: screenshot` only. Pre-signed download URL for the image, minted
@@ -110,7 +92,7 @@ class ListBulkScreenshotsResponse200ItemsItemType0:
     error_code: Union[None, str]
     error_message: Union[None, str]
     credits_charged: Union[None, Unset, float] = UNSET
-    billing: Union[Unset, "BillingNode"] = UNSET
+    billing: Union["BillingNode", None, Unset] = UNSET
     created_at: Union[Unset, datetime.datetime] = UNSET
     completed_at: Union[None, Unset, datetime.datetime] = UNSET
     image_url: Union[None, Unset, str] = UNSET
@@ -129,6 +111,8 @@ class ListBulkScreenshotsResponse200ItemsItemType0:
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
+        from ..models.billing_node import BillingNode
+
         type_ = self.type_.value
 
         id = self.id
@@ -149,9 +133,13 @@ class ListBulkScreenshotsResponse200ItemsItemType0:
         else:
             credits_charged = self.credits_charged
 
-        billing: Union[Unset, dict[str, Any]] = UNSET
-        if not isinstance(self.billing, Unset):
+        billing: Union[None, Unset, dict[str, Any]]
+        if isinstance(self.billing, Unset):
+            billing = UNSET
+        elif isinstance(self.billing, BillingNode):
             billing = self.billing.to_dict()
+        else:
+            billing = self.billing
 
         created_at: Union[Unset, str] = UNSET
         if not isinstance(self.created_at, Unset):
@@ -311,12 +299,22 @@ class ListBulkScreenshotsResponse200ItemsItemType0:
 
         credits_charged = _parse_credits_charged(d.pop("credits_charged", UNSET))
 
-        _billing = d.pop("billing", UNSET)
-        billing: Union[Unset, BillingNode]
-        if isinstance(_billing, Unset):
-            billing = UNSET
-        else:
-            billing = BillingNode.from_dict(_billing)
+        def _parse_billing(data: object) -> Union["BillingNode", None, Unset]:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            try:
+                if not isinstance(data, dict):
+                    raise TypeError()
+                billing_type_0 = BillingNode.from_dict(data)
+
+                return billing_type_0
+            except:  # noqa: E722
+                pass
+            return cast(Union["BillingNode", None, Unset], data)
+
+        billing = _parse_billing(d.pop("billing", UNSET))
 
         _created_at = d.pop("created_at", UNSET)
         created_at: Union[Unset, datetime.datetime]