@checkbox-site/node 0.1.1 → 0.2.0

package/README.md

@@ -31,6 +31,7 @@ sandbox and never need activation.
 | Retries | Network errors, 409 `idempotency_key_in_use`, 429 (honours `Retry-After`) and 5xx are retried with exponential backoff and jitter (`maxNetworkRetries`, default 2) |
 | Idempotency | Every POST that changes something gets an `Idempotency-Key` automatically, reused across retries; pass your own with `{ idempotencyKey }` |
 | Versioning | Sends `Checkbox-Version: 2026-10-30` (the version the SDK was generated for); override with `new Checkbox(key, { apiVersion })` or per request |
+| Base URL | `new Checkbox(key, { baseUrl: 'http://localhost:4000' })`, or the `CHECKBOX_API_BASE` environment variable (the same one the MCP server reads); a trailing `/v1` is ignored. Default `https://app.checkbox.site` |
 | Mode | `checkbox.mode` is `'test'` or `'live'` from the key prefix (`ck_test_` / `ck_live_` / `rk_…` / legacy `sk_live_`) |
 | Errors | `CheckboxInvalidRequestError`, `CheckboxAuthenticationError`, `CheckboxPermissionError`, `CheckboxRateLimitError`, `CheckboxIdempotencyError`, `CheckboxAPIError`, `CheckboxConnectionError` (all `CheckboxError`), each with a stable `code`, `param`, `statusCode`, `requestId`, `docUrl` and `nextAction` |
 | Webhooks | `checkbox.webhooks.constructEvent(rawBody, signatureHeader, secret)` verifies `Checkbox-Signature` and returns a typed `WebhookEvent`; `constructEventAsync` for edge runtimes |
@@ -45,6 +46,7 @@ const checkbox = new Checkbox(process.env.CHECKBOX_API_KEY, {
   maxNetworkRetries: 2, // default
   timeout: 80_000, // ms per attempt
   appInfo: { name: 'my-app', version: '1.0.0' },
+  // baseUrl: 'http://localhost:4000', // API origin (default https://app.checkbox.site); or set CHECKBOX_API_BASE
 });
 
 // Register a site (idempotent per key) and read its compliance plan: ordered tasks with the law, the exact change and
@@ -70,7 +72,7 @@ try {
   await checkbox.certificates.create(site.id);
 } catch (err) {
   if (!(err instanceof CheckboxError)) throw err;
-  // resource_conflict: not eligible yet (verify the domain, stay compliant for 7 days);
+  // resource_conflict: not eligible yet (verify the domain, keep the checks passing for 7 days);
   // account_not_activated: a live key before any domain is verified.
   console.log(err.code, err.message, err.nextAction);
 }

package/dist/client.d.ts

@@ -45,7 +45,7 @@ export interface Checkbox extends ResourceInstances {
  */
 export declare class Checkbox implements RequestSender {
     #private;
-    static readonly VERSION = "0.1.1";
+    static readonly VERSION = "0.2.0";
     static readonly API_VERSION = "2026-10-30";
     static readonly errors: typeof errors;
     static readonly webhooks: Webhooks;
@@ -390,6 +390,23 @@ export declare class Checkbox implements RequestSender {
             readonly paginated: false;
             readonly summary: "Check domain verification now";
         };
+        readonly resyncBilling: {
+            readonly operationId: "resyncBilling";
+            readonly namespace: "billings";
+            readonly method: "resync";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/billing/resync";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "sites:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Re-sync Stripe settings";
+        };
         readonly createScan: {
             readonly operationId: "createScan";
             readonly namespace: "scans";
@@ -730,6 +747,23 @@ export declare class Checkbox implements RequestSender {
             readonly paginated: false;
             readonly summary: "List fix plans for a site";
         };
+        readonly publishShopifyTerms: {
+            readonly operationId: "publishShopifyTerms";
+            readonly namespace: "fixes";
+            readonly method: "publishShopifyTerms";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/fixes/shopify/publish";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "fixes:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Publish the renewal terms to the Shopify app block";
+        };
         readonly listEvidence: {
             readonly operationId: "listEvidence";
             readonly namespace: "evidence";
@@ -1614,6 +1648,23 @@ export declare class Checkbox implements RequestSender {
             readonly paginated: false;
             readonly summary: "Delete a registered checkout config";
         };
+        readonly deleteSiteStripeCheckoutConfig: {
+            readonly operationId: "deleteSiteStripeCheckoutConfig";
+            readonly namespace: "siteStripeCheckoutConfigs";
+            readonly method: "del";
+            readonly httpMethod: "DELETE";
+            readonly path: "/v1/sites/{site}/stripe_checkout_configs/{stripe_checkout_config}";
+            readonly pathParams: readonly ["site", "stripe_checkout_config"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "test_runs:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Delete a registered checkout config (site path)";
+        };
         readonly createTestRun: {
             readonly operationId: "createTestRun";
             readonly namespace: "testRuns";
@@ -1655,7 +1706,7 @@ export declare class Checkbox implements RequestSender {
             readonly httpMethod: "GET";
             readonly path: "/v1/test_runs/{test_run}";
             readonly pathParams: readonly ["test_run"];
-            readonly queryParams: readonly [];
+            readonly queryParams: readonly ["wait"];
             readonly body: false;
             readonly idempotent: false;
             readonly auth: true;
@@ -1835,6 +1886,23 @@ export declare class Checkbox implements RequestSender {
             readonly paginated: false;
             readonly summary: "Send feedback";
         };
+        readonly claimReviewPrompt: {
+            readonly operationId: "claimReviewPrompt";
+            readonly namespace: "reviewPrompts";
+            readonly method: "claim";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/review_prompt";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "compliance_plans:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Claim the one-time review prompt for a site";
+        };
     };
     static readonly Webhooks: typeof Webhooks;
     /** Webhook signature verification: `checkbox.webhooks.constructEvent(rawBody, header, secret)`. */

package/dist/generated/operations.d.ts

@@ -342,6 +342,23 @@ export declare const OPERATIONS: {
         readonly paginated: false;
         readonly summary: "Check domain verification now";
     };
+    readonly resyncBilling: {
+        readonly operationId: "resyncBilling";
+        readonly namespace: "billings";
+        readonly method: "resync";
+        readonly httpMethod: "POST";
+        readonly path: "/v1/sites/{site}/billing/resync";
+        readonly pathParams: readonly ["site"];
+        readonly queryParams: readonly [];
+        readonly body: false;
+        readonly idempotent: true;
+        readonly auth: true;
+        readonly scope: "sites:write";
+        readonly response: "json";
+        readonly list: false;
+        readonly paginated: false;
+        readonly summary: "Re-sync Stripe settings";
+    };
     readonly createScan: {
         readonly operationId: "createScan";
         readonly namespace: "scans";
@@ -682,6 +699,23 @@ export declare const OPERATIONS: {
         readonly paginated: false;
         readonly summary: "List fix plans for a site";
     };
+    readonly publishShopifyTerms: {
+        readonly operationId: "publishShopifyTerms";
+        readonly namespace: "fixes";
+        readonly method: "publishShopifyTerms";
+        readonly httpMethod: "POST";
+        readonly path: "/v1/sites/{site}/fixes/shopify/publish";
+        readonly pathParams: readonly ["site"];
+        readonly queryParams: readonly [];
+        readonly body: true;
+        readonly idempotent: true;
+        readonly auth: true;
+        readonly scope: "fixes:write";
+        readonly response: "json";
+        readonly list: false;
+        readonly paginated: false;
+        readonly summary: "Publish the renewal terms to the Shopify app block";
+    };
     readonly listEvidence: {
         readonly operationId: "listEvidence";
         readonly namespace: "evidence";
@@ -1566,6 +1600,23 @@ export declare const OPERATIONS: {
         readonly paginated: false;
         readonly summary: "Delete a registered checkout config";
     };
+    readonly deleteSiteStripeCheckoutConfig: {
+        readonly operationId: "deleteSiteStripeCheckoutConfig";
+        readonly namespace: "siteStripeCheckoutConfigs";
+        readonly method: "del";
+        readonly httpMethod: "DELETE";
+        readonly path: "/v1/sites/{site}/stripe_checkout_configs/{stripe_checkout_config}";
+        readonly pathParams: readonly ["site", "stripe_checkout_config"];
+        readonly queryParams: readonly [];
+        readonly body: false;
+        readonly idempotent: false;
+        readonly auth: true;
+        readonly scope: "test_runs:write";
+        readonly response: "json";
+        readonly list: false;
+        readonly paginated: false;
+        readonly summary: "Delete a registered checkout config (site path)";
+    };
     readonly createTestRun: {
         readonly operationId: "createTestRun";
         readonly namespace: "testRuns";
@@ -1607,7 +1658,7 @@ export declare const OPERATIONS: {
         readonly httpMethod: "GET";
         readonly path: "/v1/test_runs/{test_run}";
         readonly pathParams: readonly ["test_run"];
-        readonly queryParams: readonly [];
+        readonly queryParams: readonly ["wait"];
         readonly body: false;
         readonly idempotent: false;
         readonly auth: true;
@@ -1787,6 +1838,23 @@ export declare const OPERATIONS: {
         readonly paginated: false;
         readonly summary: "Send feedback";
     };
+    readonly claimReviewPrompt: {
+        readonly operationId: "claimReviewPrompt";
+        readonly namespace: "reviewPrompts";
+        readonly method: "claim";
+        readonly httpMethod: "POST";
+        readonly path: "/v1/sites/{site}/review_prompt";
+        readonly pathParams: readonly ["site"];
+        readonly queryParams: readonly [];
+        readonly body: true;
+        readonly idempotent: false;
+        readonly auth: true;
+        readonly scope: "compliance_plans:read";
+        readonly response: "json";
+        readonly list: false;
+        readonly paginated: false;
+        readonly summary: "Claim the one-time review prompt for a site";
+    };
 };
 export interface OperationSpec {
     operationId: string;
@@ -1912,6 +1980,12 @@ export interface OperationTypes {
         };
         response: T.DomainVerification;
     };
+    resyncBilling: {
+        args: {
+            site: string;
+        };
+        response: T.BillingSync;
+    };
     createScan: {
         args: {
             site: string;
@@ -1988,7 +2062,7 @@ export interface OperationTypes {
         args: {
             task: string;
         } & T.AnswerTaskParams;
-        response: T.Task;
+        response: T.AnsweredTask;
     };
     verifyTask: {
         args: {
@@ -2026,6 +2100,12 @@ export interface OperationTypes {
         } & T.ListSiteFixesParams;
         response: T.FixList;
     };
+    publishShopifyTerms: {
+        args: {
+            site: string;
+        } & T.PublishShopifyTermsParams;
+        response: T.ShopifyTermsPublication;
+    };
     listEvidence: {
         args: T.ListEvidenceParams;
         response: T.EvidenceList;
@@ -2291,6 +2371,13 @@ export interface OperationTypes {
         };
         response: T.DeletedStripeCheckoutConfig;
     };
+    deleteSiteStripeCheckoutConfig: {
+        args: {
+            site: string;
+            stripe_checkout_config: string;
+        };
+        response: T.DeletedStripeCheckoutConfig;
+    };
     createTestRun: {
         args: {
             site: string;
@@ -2306,7 +2393,7 @@ export interface OperationTypes {
     retrieveTestRun: {
         args: {
             test_run: string;
-        };
+        } & T.RetrieveTestRunParams;
         response: T.TestRun;
     };
     cancelTestRun: {
@@ -2361,6 +2448,12 @@ export interface OperationTypes {
         args: T.FeedbackParams;
         response: T.Feedback;
     };
+    claimReviewPrompt: {
+        args: {
+            site: string;
+        } & T.ReviewPromptParams;
+        response: T.ReviewPrompt;
+    };
 }
 /** `checkbox.device` */
 export declare class DeviceResource extends Resource {
@@ -2420,7 +2513,7 @@ export declare class SetupSessionsResource extends Resource {
     /**
      * Re-check the site now.
      *
-     * Loads the site (is the snippet live? which policy links does it have?), re-fetches the Terms and policies, re-evaluates compliance and queues the first synthetic-shopper scan. Call it after every change the agent made (and after deploying). Returns what was seen plus the updated session.
+     * Loads the site (is the snippet live? which policy links does it have?), re-fetches the Terms and policies, re-evaluates compliance and queues the first synthetic-shopper scan. While the domain is not verified: a live snippet (or the checkbox-verify meta tag) on the homepage verifies it now; otherwise a read-only scan of the site's own public pages is queued (unverified: no checkout is submitted). Call it after every change the agent made (and after deploying). Returns what was seen plus the updated session.
      *
      * @param setupSession Unique identifier of the setup session (setup_…).
      * @see POST /v1/setup_sessions/{setup_session}/verify (operation `verifySetupSession`, scope `setup_sessions:write`)
@@ -2449,7 +2542,7 @@ export declare class AccountResource extends Resource {
     /**
      * Update the account.
      *
-     * Pins the account to an API version (requests without a Checkbox-Version header use it). Known versions: 2026-10-30.
+     * Pins the account to an API version (requests without a Checkbox-Version header use it; known versions: 2026-10-30), sets the default retention, and turns the account-wide legal hold on or off. Retention and legal hold apply to the key's mode (test mode has its own).
      *
      * @see POST /v1/account (operation `updateAccount`, scope `account:write`)
      */
@@ -2476,7 +2569,7 @@ export declare class SitesResource extends Resource {
     /**
      * Retrieve a site.
      *
-     * Returns a site with its latest compliance verdict (score, status) and install details.
+     * Returns a site with its latest compliance status (label and counts) and install details.
      *
      * @param site Unique identifier of the site (site_…).
      * @see GET /v1/sites/{site} (operation `retrieveSite`, scope `sites:read`)
@@ -2514,7 +2607,7 @@ export declare class SitesResource extends Resource {
     /**
      * Connect a billing platform.
      *
-     * Connects the site's billing platform with read-only credentials (a Stripe restricted key, a Recharge token or a Shopify Admin API token), so Checkbox reads the customer-portal and reminder settings. Works for test-mode sites too (use an rk_test_ key). The credentials are validated by reading the settings once and stored encrypted.
+     * Connects the site's billing platform with read-only credentials (a Stripe restricted key, a Recharge token, a Shopify Admin API token, a Chargebee read-only API key, a Recurly private API key or a Paddle API key with read permissions), so Checkbox reads the customer-portal and reminder settings. Works for test-mode sites too (use an rk_test_ key). The credentials are validated by reading the settings once and stored encrypted.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/integrations (operation `connectBillingPlatform`, scope `sites:write`)
@@ -2553,13 +2646,25 @@ export declare class DomainVerificationsResource extends Resource {
     /**
      * Check domain verification now.
      *
-     * Looks for the DNS TXT record and the /.well-known file now. On success in live mode, the account is activated and held monitoring starts.
+     * Looks for the DNS TXT record, the /.well-known file, and the site's Checkbox snippet or the checkbox-verify meta tag on https://<domain>/ now. On success in live mode, the account is activated and held monitoring starts.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/domain_verification/check (operation `checkDomainVerification`, scope `sites:write`)
      */
     check(site: string, options?: RequestOptions): Promise<T.DomainVerification>;
 }
+/** `checkbox.billings` */
+export declare class BillingsResource extends Resource {
+    /**
+     * Re-sync Stripe settings.
+     *
+     * Re-reads the site's billing-platform settings now (Stripe customer-portal cancellation, trial-ending emails, plans) and re-evaluates the site, so a setting you just changed in Stripe shows up without waiting for the next scan. Every scan also re-reads them. Then poll retrieveLatestEvaluation (or listFindings) after about a minute.
+     *
+     * @param site Unique identifier of the site (site_…).
+     * @see POST /v1/sites/{site}/billing/resync (operation `resyncBilling`, scope `sites:write`)
+     */
+    resync(site: string, options?: RequestOptions): Promise<T.BillingSync>;
+}
 /** `checkbox.scans` */
 export declare class ScansResource extends Resource {
     /**
@@ -2603,7 +2708,7 @@ export declare class EvaluationsResource extends Resource {
     /**
      * List evaluations.
      *
-     * Verdicts newest first (score history), optionally for one site.
+     * Verdicts newest first (status history), optionally for one site.
      *
      * @see GET /v1/evaluations (operation `listEvaluations`, scope `evaluations:read`)
      */
@@ -2620,7 +2725,7 @@ export declare class EvaluationsResource extends Resource {
     /**
      * Get the current verdict of a site.
      *
-     * The latest evaluation of the site: is it compliant (score and status), and what blocks it. 404 resource_missing with next_action createScan when the site was never evaluated.
+     * The latest evaluation of the site: its compliance status and what blocks it. 404 resource_missing with next_action createScan when the site was never evaluated.
      *
      * @param site Unique identifier of the site (site_…).
      * @see GET /v1/sites/{site}/evaluation (operation `retrieveLatestEvaluation`, scope `evaluations:read`)
@@ -2632,7 +2737,7 @@ export declare class FindingsResource extends Resource {
     /**
      * List findings.
      *
-     * Findings ordered by urgency (failing first, then by severity). Filter by site, status (fail, needs_review, pass, not_applicable) and state (open, acknowledged, resolved, accepted_risk). Fix the open `fail` findings to become compliant.
+     * Findings ordered by urgency (failing first, then by severity). Filter by site, status (fail, needs_review, pass, not_applicable) and state (open, acknowledged, resolved, accepted_risk). Fix the open `fail` findings so the checks pass.
      *
      * @see GET /v1/findings (operation `listFindings`, scope `findings:read`)
      */
@@ -2661,7 +2766,7 @@ export declare class PlansResource extends Resource {
     /**
      * Get the compliance plan for a site.
      *
-     * Ordered tasks that make the site compliant, recomputed from its latest evaluation: each with the requirement and citation, where to change (file / URL / selector / Stripe object), the exact change (unified-diff template with machine-applicable edits, copy, or Stripe params) and how to verify it. Do plan.next_action: apply the first open task, call verifyTask, repeat until status is compliant. Tasks with status manual hold a question for the human (answerTask); they never block the others.
+     * Ordered tasks that make the site's checks pass, recomputed from its latest evaluation: each with the requirement and citation, where to change (file / URL / selector / Stripe object), the exact change (unified-diff template with machine-applicable edits, copy, or Stripe params) and how to verify it. Do plan.next_action: apply the first open task, call verifyTask, and repeat until the checks pass (status value compliant; status_label "Checks pass"). Tasks with status manual hold a question for the human (answerTask); they never block the others.
      *
      * @param site Unique identifier of the site (site_…).
      * @see GET /v1/sites/{site}/plan (operation `retrieveCompliancePlan`, scope `compliance_plans:read`)
@@ -2696,7 +2801,7 @@ export declare class TasksResource extends Resource {
      * @param task Unique identifier of the task (task_…).
      * @see POST /v1/tasks/{task}/answer (operation `answerTask`, scope `compliance_plans:write`)
      */
-    answer(task: string, params: T.AnswerTaskParams, options?: RequestOptions): Promise<T.Task>;
+    answer(task: string, params: T.AnswerTaskParams, options?: RequestOptions): Promise<T.AnsweredTask>;
     /**
      * Verify a task after applying its change.
      *
@@ -2712,7 +2817,7 @@ export declare class VerificationsResource extends Resource {
     /**
      * Get a verification (long-poll with ?wait=30).
      *
-     * The verification's status (pending, passed, failed), expected vs observed per check, the diff and next_action. ?wait=N (≤ 30) holds the request until it resolves or N seconds pass.
+     * The verification's status (pending, passed, failed), expected vs observed per check, the diff and next_action. Also takes a task id (task_…): the newest verification of that task. ?wait=N (≤ 30) holds the request until it resolves or N seconds pass.
      *
      * @param verification Unique identifier of the verification (ver_…).
      * @see GET /v1/verifications/{verification} (operation `retrieveVerification`, scope `compliance_plans:read`)
@@ -2748,6 +2853,15 @@ export declare class FixesResource extends Resource {
      * @see GET /v1/sites/{site}/fixes (operation `listSiteFixes`, scope `fixes:read`)
      */
     list(site: string, params?: T.ListSiteFixesParams, options?: RequestOptions): Promise<T.FixList>;
+    /**
+     * Publish the renewal terms to the Shopify app block.
+     *
+     * For a Shopify store connected through the Checkbox Shopify app (site.shopify.connection = app): generates the renewal disclosure and consent label from the site's real plan, verifies them against the rules engine, and publishes them to the app-owned metafield the Checkbox "Renewal terms + consent" theme block reads. Nothing else in the store changes (no theme, product or checkout edits). The merchant places the block once in the theme editor (theme_editor_url); after that, publishing again updates the text the block shows. Then verify the sign-up task (verifyTask) or the site (verifySite). Errors: shopify_not_connected (only the merchant can install and connect the app; next_action has the step), terms_incomplete (problems lists the missing plan facts; next_action names the call that sets them), fix_verification_failed, platform_error (Shopify refused the write). In test mode it acts on test-mode sites, whose connected store is written the same way.
+     *
+     * @param site Unique identifier of the site (site_…).
+     * @see POST /v1/sites/{site}/fixes/shopify/publish (operation `publishShopifyTerms`, scope `fixes:write`, live mode needs an activated account)
+     */
+    publishShopifyTerms(site: string, params?: T.PublishShopifyTermsParams, options?: RequestOptions): Promise<T.ShopifyTermsPublication>;
 }
 /** `checkbox.evidence` */
 export declare class EvidenceResource extends Resource {
@@ -2839,7 +2953,7 @@ export declare class NoticeSettingsResource extends Resource {
     /**
      * Update notice settings.
      *
-     * Chooses who sends the required emails (mode: merchant = you send them and Checkbox tracks them, the default; checkbox = Checkbox sends them), and sets branding, cancel_url and the confirmed cancellation policy. In checkbox mode, turning a notice on (enabled_kinds) requires cancel_url, a confirmed policy, a connected Stripe or Recharge account and a sending address; otherwise resource_conflict explains what is missing.
+     * Chooses who sends the required emails (mode: merchant = you send them and Checkbox tracks them, the default; checkbox = Checkbox sends them), and sets branding, cancel_url and the confirmed cancellation policy. add_kinds / remove_kinds turn single notices on or off and leave the others as they are; enabled_kinds replaces the whole list. In checkbox mode, turning a notice on requires cancel_url, a confirmed policy, a connected Stripe, Recharge, Chargebee, Recurly or Paddle account and a sending address; otherwise resource_conflict explains what is missing.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/notice_settings (operation `updateNoticeSettings`, scope `notices:write`, live mode needs an activated account)
@@ -2925,7 +3039,7 @@ export declare class ChecksResource extends Resource {
     /**
      * Check checkout disclosure text.
      *
-     * Checks the automatic-renewal disclosure you are about to show next to a subscribe button: what it says (renewal until canceled, price, frequency, trial, term, how to cancel), where it sits (above the button, same page) and how it looks (size, contrast, set off), and the consent checkbox (present, not pre-checked). Returns the verdict per check and per legal requirement, plus `replacement`: compliant text and drop-in HTML generated from your price/interval/trial/cancel_url and verified by the engine. Call it whenever you write or change checkout copy. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
+     * Checks the automatic-renewal disclosure you are about to show next to a subscribe button: what it says (renewal until canceled, price, frequency, trial, term, how to cancel), where it sits (above the button, same page) and how it looks (size, contrast, set off), and the consent checkbox (present, not pre-checked). Returns the verdict per check and per legal requirement, plus `replacement`: suggested text that passes the checks and drop-in HTML (and the same markup as JSX for React) generated from your price/interval/trial/cancel_url and verified by the engine. Call it whenever you write or change checkout copy. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
      *
      * @see POST /v1/checks/disclosure (operation `checkDisclosure`, scope `checks:read`)
      */
@@ -2949,7 +3063,7 @@ export declare class ChecksResource extends Resource {
     /**
      * Check a subscription lifecycle email.
      *
-     * Checks the content of an acknowledgment (welcome) email, trial-ending reminder, renewal reminder, price-change notice, yearly terms reminder or cancellation confirmation against the requirements for that notice (renewal terms, amount, frequency, how to cancel, trial cancellation). The email is modelled as sent on time, so the verdict is about content; get send dates from checkNoticeSchedule. Returns `required_by` (requirements that make the email mandatory for this plan) and a compliant `template` with {{merge_tags}}, verified by the engine. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
+     * Checks the content of an acknowledgment (welcome) email, trial-ending reminder, renewal reminder, price-change notice, yearly terms reminder or cancellation confirmation against the requirements for that notice (renewal terms, amount, frequency, how to cancel, trial cancellation). The email is modelled as sent on time, so the verdict is about content; get send dates from checkNoticeSchedule. Prices are judged against what Stripe charges: with `site` (or, without it, the account's one site with Stripe connected) the plan fields come from the site's plans and the email is matched to the plan it names ("Annual") first; a price that contradicts it fails, and `warnings` say which site and plan were used. Returns `required_by` (requirements that make the email mandatory for this plan) and a `template` that passes the checks, with {{merge_tags}}, verified by the engine. Stateless and deterministic: nothing is stored, the same input on the same as_of date gives the same verdicts. Every verdict comes from the Checkbox rules engine over the legal catalog (federal ROSCA / EFTA plus the state automatic-renewal laws); the response carries rules_version, catalog_version and a disclaimer (not legal advice). Read `verdict`, then `next_action`: it tells you exactly what to change and to call the check again until verdict is pass.
      *
      * @see POST /v1/checks/email (operation `checkEmail`, scope `checks:read`)
      */
@@ -2965,11 +3079,11 @@ export declare class ChecksResource extends Resource {
     /**
      * Get the dates each required notice must be sent.
      *
-     * For a subscription plan (price, interval, trial) and where you sell, returns every legally required notice — acknowledgment, trial-ending reminder, renewal reminders, yearly terms reminder, price-change notice — with the recommended send time and the compliant window (opens / closes), the jurisdictions each send satisfies and the citations. Uses the same timing as Checkbox Notices: per-state windows intersected, or the fewest sends that cover conflicting windows. Stateless. Check each email's content with checkEmail, or let Checkbox Notices send them.
+     * For a subscription plan (price, interval, trial) and where you sell, returns every legally required notice — acknowledgment, trial-ending reminder, renewal reminders, yearly terms reminder, price-change notice — with the recommended send time and the allowed send window (opens / closes), the jurisdictions each send satisfies and the citations. Uses the same timing as Checkbox Notices: per-state windows intersected, or the fewest sends that cover conflicting windows. Stateless. Check each email's content with checkEmail, or let Checkbox Notices send them.
      *
      * @see POST /v1/checks/notice_schedule (operation `checkNoticeSchedule`, scope `checks:read`)
      */
-    noticeSchedule(params: T.NoticeScheduleParams, options?: RequestOptions): Promise<T.NoticeScheduleResult>;
+    noticeSchedule(params?: T.NoticeScheduleParams, options?: RequestOptions): Promise<T.NoticeScheduleResult>;
 }
 /** `checkbox.suggestions` */
 export declare class SuggestionsResource extends Resource {
@@ -3108,7 +3222,7 @@ export declare class ReceiptsResource extends Resource {
     /**
      * Erase a subscriber's receipts.
      *
-     * For a subscriber's deletion request: deletes every receipt that matches customer_reference, email (hashed before the lookup) or checkout_session (optionally only for one site). The signed copy in the write-once evidence vault is kept but holds only a salted commitment to the subscriber's identifiers; erasing destroys the salt, so it can no longer be tied to the person. Pending attorney review.
+     * For a subscriber's deletion request: deletes every receipt that matches customer_reference, email (hashed before the lookup) or checkout_session (optionally only for one site). The signed copy in the write-once evidence vault is kept but holds only a salted commitment to the subscriber's identifiers; erasing destroys the salt, so it can no longer be tied to the person. Ask your counsel whether this meets a deletion request in your jurisdiction.
      *
      * @see POST /v1/receipts/erase (operation `eraseReceipts`, scope `receipts:write`)
      */
@@ -3163,7 +3277,7 @@ export declare class ReceiptSettingsResource extends Resource {
     /**
      * Update receipt settings.
      *
-     * Turn receipts on or off and set the retention in days (default 1461 = 4 years, the California UCL limitation period; pending attorney review). A new retention applies to receipts recorded afterwards.
+     * Turn receipts on or off and set the retention in days (default 1461 = 4 years: the California Unfair Competition Law limitation period; adjust to your counsel's advice). A new retention applies to receipts recorded afterwards.
      *
      * @see POST /v1/receipt_settings (operation `updateReceiptSettings`, scope `receipts:write`)
      */
@@ -3207,7 +3321,7 @@ export declare class StripeCheckoutConfigsResource extends Resource {
     /**
      * Register the Checkout Session params your code uses.
      *
-     * Registers exactly the object your code passes to stripe.checkout.sessions.create (customer, URLs and secrets are not needed and are ignored). Test runs mirror it into Stripe test mode; when it matches your latest live checkout, the scanned test page counts as an observation of your live checkout. Re-register after changing your checkout code, then call createTestRun.
+     * Registers exactly the object your code passes to stripe.checkout.sessions.create (customer, URLs and secrets are not needed and are ignored; `warnings` says what was not stored). It is judged exactly like checkStripeCheckoutSession, discounts included. A config with the same name, or for the same Price ids, replaces the older one (`replaced`). Test runs mirror it into Stripe test mode; when it matches your latest live checkout, the scanned test page counts as an observation of your live checkout. Re-register after changing your checkout code, then call createTestRun.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/stripe_checkout_configs (operation `createStripeCheckoutConfig`, scope `test_runs:write`)
@@ -3243,12 +3357,27 @@ export declare class StripeCheckoutConfigsResource extends Resource {
     /** Alias of `del()`. */
     delete(stripeCheckoutConfig: string, options?: RequestOptions): Promise<T.DeletedStripeCheckoutConfig>;
 }
+/** `checkbox.siteStripeCheckoutConfigs` */
+export declare class SiteStripeCheckoutConfigsResource extends Resource {
+    /**
+     * Delete a registered checkout config (site path).
+     *
+     * The same as deleteStripeCheckoutConfig, under the site path where configs are created and listed.
+     *
+     * @param site Unique identifier of the site (site_…).
+     * @param stripeCheckoutConfig Unique identifier of the stripe checkout config (scc_…).
+     * @see DELETE /v1/sites/{site}/stripe_checkout_configs/{stripe_checkout_config} (operation `deleteSiteStripeCheckoutConfig`, scope `test_runs:write`)
+     */
+    del(site: string, stripeCheckoutConfig: string, options?: RequestOptions): Promise<T.DeletedStripeCheckoutConfig>;
+    /** Alias of `del()`. */
+    delete(site: string, stripeCheckoutConfig: string, options?: RequestOptions): Promise<T.DeletedStripeCheckoutConfig>;
+}
 /** `checkbox.testRuns` */
 export declare class TestRunsResource extends Resource {
     /**
      * Start a lifecycle test run.
      *
-     * Starts a synthetic test subscription in TEST mode and returns it queued. Stripe runs mirror your checkout into a test-mode Checkout Session, subscribe a test customer (card 4242) whose email is a Checkbox inbox, wait for your acknowledgment, advance a test clock through every legal notice window before trial end and renewal, cancel online in the customer portal and wait for the confirmation; then delete the test clock. Takes about 5-20 minutes: poll retrieveTestRun (next_action says when) or listen for test_run.completed. Each step reports observations, check results and agent-readable fixes; apply them and run again to verify.
+     * Starts a synthetic test subscription in TEST mode and returns it queued. Stripe runs mirror your checkout into a test-mode Checkout Session, subscribe a test customer (card 4242) whose email is a Checkbox inbox, wait for your acknowledgment, advance a test clock through every legal notice window before trial end and renewal, cancel online in the customer portal and wait for the confirmation; then delete the test clock. Usually takes 2-4 minutes (longer when your own emails are slow to arrive): poll retrieveTestRun (next_action says when) or listen for test_run.completed. Each step reports observations, check results and agent-readable fixes; apply them and run again to verify.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/test_runs (operation `createTestRun`, scope `test_runs:write`, live mode needs an activated account)
@@ -3266,12 +3395,12 @@ export declare class TestRunsResource extends Resource {
     /**
      * Retrieve a test run.
      *
-     * The run with every step's status, observations, check results and fixes. While it runs, next_action.type is "wait"; when it finished, next_action says what to fix (apply_fixes / review_warnings) or "none".
+     * The run with every step's status, observations, check results and fixes. While it runs, next_action.type is "wait" and waiting_for says what it waits for; ?wait=30 answers as soon as the run moves on (or after 30 seconds). When it finished, next_action says what to fix (apply_fixes / review_warnings), retrieve_plan when the only warnings have nothing to change, or "none".
      *
      * @param testRun Unique identifier of the test run (run_…).
      * @see GET /v1/test_runs/{test_run} (operation `retrieveTestRun`, scope `test_runs:read`)
      */
-    retrieve(testRun: string, options?: RequestOptions): Promise<T.TestRun>;
+    retrieve(testRun: string, params?: T.RetrieveTestRunParams, options?: RequestOptions): Promise<T.TestRun>;
     /**
      * Cancel a test run.
      *
@@ -3364,11 +3493,23 @@ export declare class FeedbacksResource extends Resource {
     /**
      * Send feedback.
      *
-     * Report a problem or a missing feature in Checkbox. Include what you tried, what happened and what you expected, and the site / request id when there is one. The Checkbox team reads every message. Rate limited to 20 per key per hour.
+     * Report a problem or a missing feature in Checkbox. Include what you tried, what happened and what you expected, and the site / request id when there is one. With type review, send a structured review of Checkbox the product (score 0-10, liked, disliked, wrong_verdicts, would_keep_using, stack) — only after the human said yes and saw the text. A review describes what worked or did not in Checkbox: it never states that the site broke a law or had unfixed problems, and carries no site names, URLs, customer data or quotes of the site's pages or emails (URLs are removed and no site is attached). Never include secrets or customer data: anything that looks like a secret, card number or email address is replaced with [redacted]. The Checkbox team reads every message. Rate limited to 20 per key per hour.
      *
      * @see POST /v1/feedback (operation `createFeedback`, scope `account:read`)
      */
-    create(params: T.FeedbackParams, options?: RequestOptions): Promise<T.Feedback>;
+    create(params?: T.FeedbackParams, options?: RequestOptions): Promise<T.Feedback>;
+}
+/** `checkbox.reviewPrompts` */
+export declare class ReviewPromptsResource extends Resource {
+    /**
+     * Claim the one-time review prompt for a site.
+     *
+     * The MCP tools call this when a site's compliance plan reaches status compliant, i.e. checks pass (including "Checks pass · N live checks pending"). show is true exactly once per site: the agent then asks the human once whether they want to send a quick review of Checkbox (createFeedback with type review), and sends it only on a yes, after showing the text. Never send a review without the human's yes.
+     *
+     * @param site Unique identifier of the site (site_…).
+     * @see POST /v1/sites/{site}/review_prompt (operation `claimReviewPrompt`, scope `compliance_plans:read`)
+     */
+    claim(site: string, params?: T.ReviewPromptParams, options?: RequestOptions): Promise<T.ReviewPrompt>;
 }
 /** Resource namespaces of the client. */
 export declare const RESOURCES: {
@@ -3377,6 +3518,7 @@ export declare const RESOURCES: {
     readonly account: typeof AccountResource;
     readonly sites: typeof SitesResource;
     readonly domainVerifications: typeof DomainVerificationsResource;
+    readonly billings: typeof BillingsResource;
     readonly scans: typeof ScansResource;
     readonly evaluations: typeof EvaluationsResource;
     readonly findings: typeof FindingsResource;
@@ -3399,8 +3541,10 @@ export declare const RESOURCES: {
     readonly receiptSettings: typeof ReceiptSettingsResource;
     readonly testCredentials: typeof TestCredentialsResource;
     readonly stripeCheckoutConfigs: typeof StripeCheckoutConfigsResource;
+    readonly siteStripeCheckoutConfigs: typeof SiteStripeCheckoutConfigsResource;
     readonly testRuns: typeof TestRunsResource;
     readonly webhookEndpoints: typeof WebhookEndpointsResource;
     readonly events: typeof EventsResource;
     readonly feedbacks: typeof FeedbacksResource;
+    readonly reviewPrompts: typeof ReviewPromptsResource;
 };