@hunt-labs/bytekit-sdk 0.11.7 → 0.11.9

package/CHANGELOG.md

@@ -10,6 +10,29 @@ today, see [README.md](./README.md), which remains the authoritative usage guide
 
 ## [Unreleased]
 
+## [0.11.9] - 2026-10-02
+
+### Changed
+
+- **Terms-version doc comments describe the new onboarding contract (#5055).** Bootstrap no
+  longer records Terms acceptance: the internal `POST /v1/account/bootstrap` `terms_version` body
+  is now documented as a version guard, with acceptance recorded by
+  `POST /v1/account/accept-terms`. The account `terms_version` description now says an empty
+  string means the account has not accepted the Terms yet. Regenerated `src/generated/api.d.ts`;
+  description text only, no type or SDK method signature moves.
+
+## [0.11.8] - 2026-09-30
+
+### Changed
+
+- **Bulk job types add `total_billed_bytes` and deprecate the bulk credit fields (#5021).** Every
+  bulk job body (`POST`/`GET`/`DELETE /v1/bulk`, `/v1/scrape/bulk`, `/v1/fetch/bulk`, and the
+  `GET /v1/bulk` list) gains `total_billed_bytes: number | null`: the bandwidth billed for the job,
+  in bytes, after multipliers. It is `null` on the create response and for a bulk that predates
+  the field. `total_credits_charged` and the bulk item `credits_charged` are marked
+  `@deprecated`; they report `0` under the `dual` and `bytes` billing modes. Regenerated
+  `src/generated/api.d.ts`; no SDK method signature moves.
+
 ## [0.11.7] - 2026-09-29
 
 ### Changed

package/dist/generated/api.d.ts

@@ -644,9 +644,6 @@ export interface paths {
          *     endpoint factor (a 100 KiB estimate is pre-charged, then reconciled). The
          *     bandwidth is still billed when the scrape succeeds but extraction later
          *     fails; both axes are refunded only when the scrape itself never runs.
-         *
-         *     Availability is gated by a server-side feature flag; when disabled the
-         *     endpoint returns `404`.
          */
         post: operations["createSchemaExtraction"];
         delete?: never;
@@ -1517,7 +1514,13 @@ export interface components {
             total: number;
             completed: number;
             failed: number;
+            /**
+             * @deprecated
+             * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is the total credits billed for the job.
+             */
             total_credits_charged: number;
+            /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` (not raw wire bytes). Null for a bulk with a completed child missing from the sum (completed before this field, or with no settled amount) — never a partial sum. */
+            total_billed_bytes: number | null;
             /** Format: uri */
             webhook_url: string;
             /** @description Complete item records included before the 500-item or 1-MiB manifest bound. Every record carries a stable `id`, a `type`, and a terminal `status`. */
@@ -2724,7 +2727,7 @@ export interface components {
                 /** @description Whether the account admin wants an email when bandwidth reaches 100 % of the plan limit. */
                 bandwidth_100_enabled: boolean;
             };
-            /** @description The Terms of Service version this account has accepted. An empty string means the account predates clickwrap acceptance (issue #1025). The dashboard diffs this against the published current version to decide whether to show the re-acceptance prompt. */
+            /** @description The Terms of Service version this account has accepted. An empty string means the account has not accepted the Terms yet; acceptance is recorded only by `POST /v1/account/accept-terms`, never by bootstrap (issue #5055). The dashboard diffs this against the published current version to decide whether to show the re-acceptance prompt. */
             terms_version: string;
             /** Format: date-time */
             created_at: string;
@@ -2762,7 +2765,7 @@ export interface components {
                 /** @description Whether the account admin wants an email when bandwidth reaches 100 % of the plan limit. */
                 bandwidth_100_enabled: boolean;
             };
-            /** @description The Terms of Service version this account has accepted. An empty string means the account predates clickwrap acceptance (issue #1025). The dashboard diffs this against the published current version to decide whether to show the re-acceptance prompt. */
+            /** @description The Terms of Service version this account has accepted. An empty string means the account has not accepted the Terms yet; acceptance is recorded only by `POST /v1/account/accept-terms`, never by bootstrap (issue #5055). The dashboard diffs this against the published current version to decide whether to show the re-acceptance prompt. */
             terms_version: string;
             /** @description 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. */
             has_subscription: boolean;
@@ -3931,8 +3934,13 @@ export interface operations {
                         created_at: string;
                         /** Format: date-time */
                         completed_at: string | null;
-                        /** @description Always null on the create response — the job has not been billed yet (routes/scrape-bulk.ts builds the 202 body from a partial job row). Fractional when populated (credits are NUMERIC(10,2)); the numeric branch is unreachable on this path and exists only so the 202 and 200 bodies share one shape. */
+                        /**
+                         * @deprecated
+                         * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is always null on the create response — the job has not been billed yet (routes/scrape-bulk.ts builds the 202 body from a partial job row).
+                         */
                         total_credits_charged: number | null;
+                        /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` across the whole job (not raw wire bytes, not just this page). Always null on the create response — nothing has settled yet. */
+                        total_billed_bytes: number | null;
                         /** @description Estimated credits at submission time. Null in GET responses. Fetch-bulk items use the raw fetch bandwidth billing factor. */
                         estimated_credits: number | null;
                         /** @description Webhook endpoint URL (HTTPS only; http:// rejected with 400 invalid_url, reason scheme_unsupported) */
@@ -4017,8 +4025,13 @@ export interface operations {
                         created_at: string;
                         /** Format: date-time */
                         completed_at: string | null;
-                        /** @description Total credits billed for the job. Null until the job is billed. Fractional — credits are NUMERIC(10,2). */
+                        /**
+                         * @deprecated
+                         * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is the total credits billed for the job, null until the job is billed; fractional — credits are NUMERIC(10,2).
+                         */
                         total_credits_charged: number | null;
+                        /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` across the whole job (not raw wire bytes, not just this page). Null for a bulk with a completed child missing from the sum (completed before this field, or with no settled amount) — never a partial sum. */
+                        total_billed_bytes: number | null;
                         /** @description Null in GET responses (computed at submission time only). */
                         estimated_credits: number | null;
                         /** @description Webhook endpoint URL (HTTPS only; http:// rejected with 400 invalid_url, reason scheme_unsupported) */
@@ -4056,8 +4069,13 @@ export interface operations {
                         created_at: string;
                         /** Format: date-time */
                         completed_at: string | null;
-                        /** @description Total credits billed for the job. Null until the job is billed. Fractional — credits are NUMERIC(10,2). */
+                        /**
+                         * @deprecated
+                         * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is the total credits billed for the job, null until the job is billed; fractional — credits are NUMERIC(10,2).
+                         */
                         total_credits_charged: number | null;
+                        /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` across the whole job (not raw wire bytes, not just this page). Null for a bulk with a completed child missing from the sum (completed before this field, or with no settled amount) — never a partial sum. */
+                        total_billed_bytes: number | null;
                         /** @description Null in GET responses (computed at submission time only). */
                         estimated_credits: number | null;
                         /** @description Webhook endpoint URL (HTTPS only; http:// rejected with 400 invalid_url, reason scheme_unsupported) */
@@ -4405,8 +4423,13 @@ export interface operations {
                         created_at: string;
                         /** Format: date-time */
                         completed_at: string | null;
-                        /** @description Always null on the create response — the job has not been billed yet (routes/fetch-bulk.ts builds the 202 body from a partial job row). Fractional when populated (credits are NUMERIC(10,2)); the numeric branch is unreachable on this path and exists only so the 202 and 200 bodies share one shape. */
+                        /**
+                         * @deprecated
+                         * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is always null on the create response — the job has not been billed yet (routes/fetch-bulk.ts builds the 202 body from a partial job row).
+                         */
                         total_credits_charged: number | null;
+                        /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` across the whole job (not raw wire bytes, not just this page). Always null on the create response — nothing has settled yet. */
+                        total_billed_bytes: number | null;
                         /** @description Estimated credits at submission time. Null in GET responses. Fetch items are raw passthrough requests and use the raw fetch bandwidth billing factor. */
                         estimated_credits: number | null;
                         /** @description Webhook endpoint URL (HTTPS only; http:// rejected with 400 invalid_url, reason scheme_unsupported) */
@@ -4485,8 +4508,13 @@ export interface operations {
                         created_at: string;
                         /** Format: date-time */
                         completed_at: string | null;
-                        /** @description Total credits billed for the job. Null until the job is billed. Fractional — credits are NUMERIC(10,2). */
+                        /**
+                         * @deprecated
+                         * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is the total credits billed for the job, null until the job is billed; fractional — credits are NUMERIC(10,2).
+                         */
                         total_credits_charged: number | null;
+                        /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` across the whole job (not raw wire bytes, not just this page). Null for a bulk with a completed child missing from the sum (completed before this field, or with no settled amount) — never a partial sum. */
+                        total_billed_bytes: number | null;
                         /** @description Null in GET responses (computed at submission time only). */
                         estimated_credits: number | null;
                         /** @description Webhook endpoint URL (HTTPS only; http:// rejected with 400 invalid_url, reason scheme_unsupported) */
@@ -4577,8 +4605,13 @@ export interface operations {
                         created_at: string;
                         /** Format: date-time */
                         completed_at: string | null;
-                        /** @description Total credits billed for the job. Null until the job is billed. Fractional — credits are NUMERIC(10,2). */
+                        /**
+                         * @deprecated
+                         * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is the total credits billed for the job, null until the job is billed; fractional — credits are NUMERIC(10,2).
+                         */
                         total_credits_charged: number | null;
+                        /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` across the whole job (not raw wire bytes, not just this page). Null for a bulk with a completed child missing from the sum (completed before this field, or with no settled amount) — never a partial sum. */
+                        total_billed_bytes: number | null;
                         /** @description Null in GET responses (computed at submission time only). */
                         estimated_credits: number | null;
                         /** @description Webhook endpoint URL (HTTPS only; http:// rejected with 400 invalid_url, reason scheme_unsupported) */
@@ -4687,8 +4720,13 @@ export interface operations {
                             created_at: string;
                             /** Format: date-time */
                             completed_at: string | null;
-                            /** @description Total credits billed for the job. Null until the job is billed. Fractional — credits are NUMERIC(10,2). */
+                            /**
+                             * @deprecated
+                             * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is the total credits billed for the job, null until the job is billed; fractional — credits are NUMERIC(10,2).
+                             */
                             total_credits_charged: number | null;
+                            /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` across the whole job (not raw wire bytes, not just this page). Null for a bulk with a completed child missing from the sum (completed before this field, or with no settled amount) — never a partial sum. */
+                            total_billed_bytes: number | null;
                             /** @description Null in GET responses (computed at submission time only). */
                             estimated_credits: number | null;
                             /** @description Webhook endpoint URL (HTTPS only; http:// rejected with 400 invalid_url, reason scheme_unsupported) */
@@ -4899,8 +4937,13 @@ export interface operations {
                         created_at: string;
                         /** Format: date-time */
                         completed_at: string | null;
-                        /** @description Always null on the create response — the job has not been billed yet (routes/bulk.ts builds the 202 body from a partial job row). Fractional when populated (credits are NUMERIC(10,2)); the numeric branch is unreachable on this path and exists only so the 202 and 200 bodies share one shape. */
+                        /**
+                         * @deprecated
+                         * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is always null on the create response — the job has not been billed yet (routes/bulk.ts builds the 202 body from a partial job row).
+                         */
                         total_credits_charged: number | null;
+                        /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` across the whole job (not raw wire bytes, not just this page). Always null on the create response — nothing has settled yet. */
+                        total_billed_bytes: number | null;
                         /** @description Estimated credits at submission time. Null in GET responses. Fetch-bulk items use the raw fetch bandwidth billing factor. */
                         estimated_credits: number | null;
                         /** @description Webhook endpoint URL (HTTPS only; http:// rejected with 400 invalid_url, reason scheme_unsupported) */
@@ -4982,8 +5025,13 @@ export interface operations {
                         created_at: string;
                         /** Format: date-time */
                         completed_at: string | null;
-                        /** @description Total credits billed for the job. Null until the job is billed. Fractional — credits are NUMERIC(10,2). */
+                        /**
+                         * @deprecated
+                         * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is the total credits billed for the job, null until the job is billed; fractional — credits are NUMERIC(10,2).
+                         */
                         total_credits_charged: number | null;
+                        /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` across the whole job (not raw wire bytes, not just this page). Null for a bulk with a completed child missing from the sum (completed before this field, or with no settled amount) — never a partial sum. */
+                        total_billed_bytes: number | null;
                         /** @description Null in GET responses (computed at submission time only). */
                         estimated_credits: number | null;
                         /** @description Webhook endpoint URL (HTTPS only; http:// rejected with 400 invalid_url, reason scheme_unsupported) */
@@ -5014,8 +5062,13 @@ export interface operations {
                         created_at: string;
                         /** Format: date-time */
                         completed_at: string | null;
-                        /** @description Total credits billed for the job. Null until the job is billed. Fractional — credits are NUMERIC(10,2). */
+                        /**
+                         * @deprecated
+                         * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is the total credits billed for the job, null until the job is billed; fractional — credits are NUMERIC(10,2).
+                         */
                         total_credits_charged: number | null;
+                        /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` across the whole job (not raw wire bytes, not just this page). Null for a bulk with a completed child missing from the sum (completed before this field, or with no settled amount) — never a partial sum. */
+                        total_billed_bytes: number | null;
                         /** @description Null in GET responses (computed at submission time only). */
                         estimated_credits: number | null;
                         /** @description Webhook endpoint URL (HTTPS only; http:// rejected with 400 invalid_url, reason scheme_unsupported) */
@@ -5063,8 +5116,13 @@ export interface operations {
                         created_at: string;
                         /** Format: date-time */
                         completed_at: string | null;
-                        /** @description Total credits billed for the job. Null until the job is billed. Fractional — credits are NUMERIC(10,2). */
+                        /**
+                         * @deprecated
+                         * @description Deprecated: bulk jobs are billed on bandwidth — read `total_billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is the total credits billed for the job, null until the job is billed; fractional — credits are NUMERIC(10,2).
+                         */
                         total_credits_charged: number | null;
+                        /** @description Bandwidth billed for the job, in bytes: the settled amount after multipliers, summed over every settled child's `billing.billed_bytes` across the whole job (not raw wire bytes, not just this page). Null for a bulk with a completed child missing from the sum (completed before this field, or with no settled amount) — never a partial sum. */
+                        total_billed_bytes: number | null;
                         /** @description Null in cancel responses (computed at submission time only). */
                         estimated_credits: number | null;
                         /** @description Webhook endpoint URL (HTTPS only; http:// rejected with 400 invalid_url, reason scheme_unsupported) */
@@ -5127,6 +5185,10 @@ export interface operations {
                             status: "pending" | "processing" | "completed" | "failed" | "cancelled";
                             /** Format: uri */
                             url: string;
+                            /**
+                             * @deprecated
+                             * @description Deprecated: bulk jobs are billed on bandwidth — read this item's `billing.billed_bytes`. Reports `0` under the `dual` and `bytes` billing modes, where no credits are drawn. Under `credits` it is the credits billed for the item, null until it is billed; fractional (NUMERIC(10,2), 0.5 cache-hit credits).
+                             */
                             credits_charged?: number | null;
                             /**
                              * @description Itemised account of this item's charge — the basis, the named factors
@@ -5855,15 +5917,6 @@ export interface operations {
                 };
             };
             402: components["responses"]["PaymentRequired"];
-            /** @description Endpoint not available (feature flag disabled). */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["Error"];
-                };
-            };
             /** @description Validation error (`validation_error`) or non-normalizable schema (`schema_incompatible`). */
             422: {
                 headers: {
@@ -7045,11 +7098,11 @@ export interface operations {
             path?: never;
             cookie?: never;
         };
-        /** @description Optional clickwrap acceptance signal (issue #1025). When present, terms_version MUST equal the published current version or the request is rejected with 400 terms_version_mismatch. When absent, the server stamps the current version server-side (back-compatible). */
+        /** @description Optional Terms version guard (issue #1025). When present, terms_version MUST equal the published current version or the request is rejected with 400 terms_version_mismatch. It is never recorded as acceptance: a new account starts with an empty terms_version, and acceptance is recorded only by POST /v1/account/accept-terms. When absent, the guard is skipped (back-compatible). */
         requestBody?: {
             content: {
                 "application/json": {
-                    /** @description The Terms of Service version the user is accepting. */
+                    /** @description The Terms of Service version the client was built against. Checked against the current version, never recorded as acceptance. */
                     terms_version?: string;
                 };
             };
@@ -7073,7 +7126,7 @@ export interface operations {
                     "application/json": components["schemas"]["Account"];
                 };
             };
-            /** @description terms_version does not match the published current version. */
+            /** @description terms_version does not match the published current version (version guard only; acceptance is recorded by POST /v1/account/accept-terms). */
             400: {
                 headers: {
                     [name: string]: unknown;

package/dist/version.d.ts

@@ -5,4 +5,4 @@
  * outbound request carries — see the emit site in `client.ts`. The header name is spelled
  * only there, so issue #2905's pre-merge gate 1 counts exactly one occurrence in `src/`.
  */
-export declare const SDK_VERSION = "0.11.7";
+export declare const SDK_VERSION = "0.11.9";

package/dist/version.js

@@ -9,4 +9,4 @@
  * outbound request carries — see the emit site in `client.ts`. The header name is spelled
  * only there, so issue #2905's pre-merge gate 1 counts exactly one occurrence in `src/`.
  */
-export const SDK_VERSION = '0.11.7';
+export const SDK_VERSION = '0.11.9';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hunt-labs/bytekit-sdk",
-  "version": "0.11.7",
+  "version": "0.11.9",
   "description": "Official TypeScript SDK for the ByteKit API",
   "license": "MIT",
   "type": "module",