bytekit-sdk 0.5.2__tar.gz → 0.5.3__tar.gz

{bytekit_sdk-0.5.2 → bytekit_sdk-0.5.3}/CHANGELOG.md

@@ -5,6 +5,18 @@ PyPI distribution: `bytekit-sdk`. Import name: `bytekit`.
 
 ## Unreleased
 
+## 0.5.3
+
+_Release cut 2026-09-05._
+
+### Changed
+
+- Regenerated `ScrapeQueuedEnvelope` against the corrected `status_url` documentation (#3925).
+  `status_url` is a root-relative path, never an absolute URI: join it onto the API base URL you
+  called (`https://api.bytekit.com`, no trailing slash) to get the URL to poll. The spec had
+  declared it `format: uri` with an absolute example, which no server has ever emitted; the
+  emitted value is unchanged, so no client behaviour moves.
+
 ## 0.5.2
 
 _Release cut 2026-09-03._

{bytekit_sdk-0.5.2 → bytekit_sdk-0.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: bytekit-sdk
-Version: 0.5.2
+Version: 0.5.3
 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.5.2 → bytekit_sdk-0.5.3}/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.5.2"
+version = "0.5.3"
 description = "Official Python SDK for the ByteKit API"
 readme = "README.md"
 requires-python = ">=3.10"

{bytekit_sdk-0.5.2 → bytekit_sdk-0.5.3}/src/bytekit/models/bandwidth_balance.py

@@ -21,9 +21,11 @@ class BandwidthBalance:
         granted_topup_bytes (int): Bytes remaining in starter-grant lots, after active refund reservations. Purchased
             top-up bytes are excluded.
         rollover_bytes (int): Unspent subscription allowance carried over from earlier billing periods: bytes remaining
-            in allowance lots granted before the current period started, after active refund reservations. Carried value is
-            spent before the current period's allowance, so this falls to `0` before `limit_bytes` reaches the current
-            allowance alone.
+            in allowance lots granted before the current period started, after active refund reservations. While your plan
+            tier is unchanged, earlier lots are drawn first, so carried-over allowance is spent before the current period's;
+            after an upgrade, allowance acquired at the higher tier is drawn first. Value is spent in one order: your plan's
+            included allowance, including any rollover from earlier periods, then purchased top-ups, then the one-time
+            starter grant.
     """
 
     used_bytes: int

{bytekit_sdk-0.5.2 → bytekit_sdk-0.5.3}/src/bytekit/models/get_usage_response_200.py

@@ -51,10 +51,11 @@ class GetUsageResponse200:
         bytes_monitor (int):
         bytes_limit (int): The spendable byte budget for this period, summed over the account's value lots: the
             allowance granted for the current period, plus unspent allowance carried over from earlier periods, plus
-            purchased top-up and starter-grant bytes. Carried-over value is spent first, so this figure falls as it is
-            consumed.
+            purchased top-up and starter-grant bytes. The figure falls as those lots are consumed.
         bytes_remaining (int): Bytes still available across every active lot, after active refund reservations.
-        rollover_bytes (int): Unspent allowance carried over from earlier billing periods.
+        rollover_bytes (int): Unspent allowance carried over from earlier billing periods. Value is spent in one order:
+            your plan's included allowance, including any rollover from earlier periods, then purchased top-ups, then the
+            one-time starter grant.
         topup_bytes (int): Bytes remaining in purchased top-up and starter-grant lots. Subscription allowance is
             excluded.
         request_count (int): Total API requests in the current billing period.

{bytekit_sdk-0.5.2 → bytekit_sdk-0.5.3}/src/bytekit/models/monitor_create_response.py

@@ -50,8 +50,10 @@ class MonitorCreateResponse:
         consecutive_failures (int): Number of consecutive capture failures. Resets to 0 on success. Used to trigger
             auto-suspension.
         last_error_code (Union[None, str]): Error code from the most recent failed capture, if any.
-        suspension_reason (Union[None, str]): Reason the monitor was auto-suspended (e.g.
-            "auto_suspended_consecutive_failures"), if applicable.
+        suspension_reason (Union[None, str]): Reason the monitor was auto-suspended, if applicable.
+            `insufficient_balance` means the account ran out of spendable balance; `auto_suspended_consecutive_failures`
+            means the monitor failed too many times in a row. Either way the monitor stops capturing until it is reactivated
+            by sending `status: "active"` to `PATCH /v1/monitors/{id}`.
         metadata (Union['MonitorResponseMetadataType0', None]):
         created_at (datetime.datetime):
         updated_at (datetime.datetime):

{bytekit_sdk-0.5.2 → bytekit_sdk-0.5.3}/src/bytekit/models/monitor_response.py

@@ -50,8 +50,10 @@ class MonitorResponse:
         consecutive_failures (int): Number of consecutive capture failures. Resets to 0 on success. Used to trigger
             auto-suspension.
         last_error_code (Union[None, str]): Error code from the most recent failed capture, if any.
-        suspension_reason (Union[None, str]): Reason the monitor was auto-suspended (e.g.
-            "auto_suspended_consecutive_failures"), if applicable.
+        suspension_reason (Union[None, str]): Reason the monitor was auto-suspended, if applicable.
+            `insufficient_balance` means the account ran out of spendable balance; `auto_suspended_consecutive_failures`
+            means the monitor failed too many times in a row. Either way the monitor stops capturing until it is reactivated
+            by sending `status: "active"` to `PATCH /v1/monitors/{id}`.
         metadata (Union['MonitorResponseMetadataType0', None]):
         created_at (datetime.datetime):
         updated_at (datetime.datetime):

{bytekit_sdk-0.5.2 → bytekit_sdk-0.5.3}/src/bytekit/models/scrape_queued_envelope.py

@@ -23,7 +23,7 @@ class ScrapeQueuedEnvelope:
     """
     Example:
         {'schema_version': 1, 'status': 'queued', 'id': 'sc_01j9abc123', 'url': 'https://example.com', 'status_url':
-            'https://api.bytekit.com/v1/scrape/sc_01j9abc123', 'queued_at': datetime.datetime(2025, 1, 15, 12, 0,
+            '/v1/scrape/sc_01j9abc123', 'queued_at': datetime.datetime(2025, 1, 15, 12, 0,
             tzinfo=datetime.timezone(datetime.timedelta(0), 'Z')), 'events': []}
 
     Attributes:
@@ -32,7 +32,9 @@ class ScrapeQueuedEnvelope:
         status (ScrapeQueuedEnvelopeStatus):
         id (str): Stable job identifier (sc_… prefixed).
         url (str):
-        status_url (str):
+        status_url (str): Root-relative path to poll for this job's terminal envelope — not an absolute URI. Join it
+            onto the base URL of the server you called (see `servers`; they carry no trailing slash) to get the pollable
+            URL, e.g. `https://api.bytekit.com` + `/v1/scrape/sc_01j9abc123`.
         queued_at (datetime.datetime):
         events (list[str]):
     """