@checkbox-site/node 0.1.0 → 0.1.1

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.0";
+    static readonly VERSION = "0.1.1";
     static readonly API_VERSION = "2026-10-30";
     static readonly errors: typeof errors;
     static readonly webhooks: Webhooks;
@@ -1138,6 +1138,40 @@ export declare class Checkbox implements RequestSender {
             readonly paginated: false;
             readonly summary: "Get the dates each required notice must be sent";
         };
+        readonly listSiteSuggestions: {
+            readonly operationId: "listSiteSuggestions";
+            readonly namespace: "suggestions";
+            readonly method: "forSite";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/suggestions";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly ["surfaces"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "checks:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Get conversion suggestions for a site";
+        };
+        readonly suggestImprovements: {
+            readonly operationId: "suggestImprovements";
+            readonly namespace: "suggestions";
+            readonly method: "generate";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/suggestions";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "checks:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Get conversion suggestions for copy you send";
+        };
         readonly getElementsBundle: {
             readonly operationId: "getElementsBundle";
             readonly namespace: "elements";

package/dist/client.js

@@ -13,7 +13,7 @@ export const DEFAULT_MAX_NETWORK_RETRIES = 2;
 const MAX_RETRY_DELAY_MS = 20_000;
 /** `ck_test_…` / `rk_test_…` / `pk_test_…` -> test; `ck_live_…` / `rk_live_…` / `sk_live_…` / `pk_live_…` -> live. */
 export function modeOfKey(key) {
-    const m = /^(?:ck|rk|sk|pk)_(test|live)_/.exec(key ?? '');
+    const m = /^(?:ckr|ck|rk|sk|pk)_(test|live)_/.exec(key ?? '');
     return m ? m[1] : undefined;
 }
 const env = (name) => {
@@ -77,7 +77,8 @@ export class Checkbox {
         this.#apiKey = (apiKey ?? env('CHECKBOX_API_KEY') ?? env('CHECKBOX_SECRET_KEY'))?.trim() || undefined;
         this.#config = { maxNetworkRetries: DEFAULT_MAX_NETWORK_RETRIES, timeout: DEFAULT_TIMEOUT_MS, ...config };
         this.apiVersion = config.apiVersion ?? API_VERSION;
-        this.baseUrl = (config.baseUrl ?? env('CHECKBOX_API_BASE') ?? DEFAULT_BASE_URL).replace(/\/+$/, '');
+        // Round-4 pilot (express): the dashboard shows the base URL with /v1; with or without it, requests go to /v1/… once.
+        this.baseUrl = (config.baseUrl ?? env('CHECKBOX_API_BASE') ?? DEFAULT_BASE_URL).replace(/\/+$/, '').replace(/\/v1$/i, '');
         this.mode = modeOfKey(this.#apiKey);
         const app = config.appInfo ? ` ${config.appInfo.name}${config.appInfo.version ? `/${config.appInfo.version}` : ''}${config.appInfo.url ? ` (${config.appInfo.url})` : ''}` : '';
         this.#userAgent = `checkbox-node/${SDK_VERSION} ${runtimeLabel()}${app}`;

package/dist/generated/operations.d.ts

@@ -1090,6 +1090,40 @@ export declare const OPERATIONS: {
         readonly paginated: false;
         readonly summary: "Get the dates each required notice must be sent";
     };
+    readonly listSiteSuggestions: {
+        readonly operationId: "listSiteSuggestions";
+        readonly namespace: "suggestions";
+        readonly method: "forSite";
+        readonly httpMethod: "GET";
+        readonly path: "/v1/sites/{site}/suggestions";
+        readonly pathParams: readonly ["site"];
+        readonly queryParams: readonly ["surfaces"];
+        readonly body: false;
+        readonly idempotent: false;
+        readonly auth: true;
+        readonly scope: "checks:read";
+        readonly response: "json";
+        readonly list: false;
+        readonly paginated: false;
+        readonly summary: "Get conversion suggestions for a site";
+    };
+    readonly suggestImprovements: {
+        readonly operationId: "suggestImprovements";
+        readonly namespace: "suggestions";
+        readonly method: "generate";
+        readonly httpMethod: "POST";
+        readonly path: "/v1/suggestions";
+        readonly pathParams: readonly [];
+        readonly queryParams: readonly [];
+        readonly body: true;
+        readonly idempotent: false;
+        readonly auth: true;
+        readonly scope: "checks:read";
+        readonly response: "json";
+        readonly list: false;
+        readonly paginated: false;
+        readonly summary: "Get conversion suggestions for copy you send";
+    };
     readonly getElementsBundle: {
         readonly operationId: "getElementsBundle";
         readonly namespace: "elements";
@@ -2112,6 +2146,16 @@ export interface OperationTypes {
         args: T.NoticeScheduleParams;
         response: T.NoticeScheduleResult;
     };
+    listSiteSuggestions: {
+        args: {
+            site: string;
+        } & T.ListSiteSuggestionsParams;
+        response: T.SuggestionReport;
+    };
+    suggestImprovements: {
+        args: T.SuggestionsParams;
+        response: T.SuggestionReport;
+    };
     getElementsBundle: {
         args: Record<string, never>;
         response: string;
@@ -2432,7 +2476,7 @@ export declare class SitesResource extends Resource {
     /**
      * Retrieve a site.
      *
-     * Returns a site with its latest compliance verdict (score, insurable) and install details.
+     * Returns a site with its latest compliance verdict (score, status) and install details.
      *
      * @param site Unique identifier of the site (site_…).
      * @see GET /v1/sites/{site} (operation `retrieveSite`, scope `sites:read`)
@@ -2450,7 +2494,7 @@ export declare class SitesResource extends Resource {
     /**
      * Archive a site.
      *
-     * Archives (soft-deletes) the site: monitoring stops and it disappears from lists, but evidence and findings are retained for the warranty. Undo with restoreSite.
+     * Archives (soft-deletes) the site: monitoring stops and it disappears from lists, but evidence and findings are retained. Undo with restoreSite.
      *
      * @param site Unique identifier of the site (site_…).
      * @see DELETE /v1/sites/{site} (operation `deleteSite`, scope `sites:write`)
@@ -2470,7 +2514,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. Pilot fix: this used to be possible only in the dashboard, which could not open test-mode sites.
+     * 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.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/integrations (operation `connectBillingPlatform`, scope `sites:write`)
@@ -2567,7 +2611,7 @@ export declare class EvaluationsResource extends Resource {
     /**
      * Retrieve an evaluation.
      *
-     * Returns one verdict with all checks and the insurability blockers.
+     * Returns one verdict with all checks and the blocking checks.
      *
      * @param evaluation Unique identifier of the evaluation (eval_…).
      * @see GET /v1/evaluations/{evaluation} (operation `retrieveEvaluation`, scope `evaluations:read`)
@@ -2576,7 +2620,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 insurable, and what blocks it. 404 resource_missing with next_action createScan when the site was never evaluated.
+     * 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.
      *
      * @param site Unique identifier of the site (site_…).
      * @see GET /v1/sites/{site}/evaluation (operation `retrieveLatestEvaluation`, scope `evaluations:read`)
@@ -2765,7 +2809,7 @@ export declare class CertificatesResource extends Resource {
     /**
      * Issue a certificate.
      *
-     * Issues a signed monitoring certificate once the site has been insurable for the required streak of days with a verified domain and fresh scans. Otherwise fails with resource_conflict and next_action describing what is missing.
+     * Issues a signed monitoring certificate once the site has passed every critical and high check for the required streak of days with a verified domain and fresh scans. Otherwise fails with resource_conflict and next_action describing what is missing.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/certificates (operation `createCertificate`, scope `certificates:write`, live mode needs an activated account)
@@ -2927,6 +2971,26 @@ export declare class ChecksResource extends Resource {
      */
     noticeSchedule(params: T.NoticeScheduleParams, options?: RequestOptions): Promise<T.NoticeScheduleResult>;
 }
+/** `checkbox.suggestions` */
+export declare class SuggestionsResource extends Resource {
+    /**
+     * Get conversion suggestions for a site.
+     *
+     * Suggestions for a site, detected from what Checkbox observed (checkout captures, emails, the test cancellation, billing settings, registered Stripe Checkout params) and its latest evaluation. Optional, deterministic suggestions (no LLM) from Checkbox’s curated library: each has the surface, what to change, why it commonly helps (no invented figures), a concrete before/after built from your plan terms, the exact copy / Stripe patch / flow change to apply, the legal guardrails it respects (catalog requirement ids, e.g. California’s and Minnesota’s save-offer rules), and the engine check of the after-example (only verified suggestions are offered). Surfaces whose compliance checks fail are held until fixed. Suggestions never block and never count toward compliance.
+     *
+     * @param site Unique identifier of the site (site_…).
+     * @see GET /v1/sites/{site}/suggestions (operation `listSiteSuggestions`, scope `checks:read`)
+     */
+    forSite(site: string, params?: T.ListSiteSuggestionsParams, options?: RequestOptions): Promise<T.SuggestionReport>;
+    /**
+     * Get conversion suggestions for copy you send.
+     *
+     * Stateless: send any of the inputs of /v1/checks/* (disclosure, page html, Stripe Checkout params, emails) plus a cancellation flow and your plan terms; get suggestions for them. The current status of what you send comes from the same preflight checks; nothing is stored. Optional, deterministic suggestions (no LLM) from Checkbox’s curated library: each has the surface, what to change, why it commonly helps (no invented figures), a concrete before/after built from your plan terms, the exact copy / Stripe patch / flow change to apply, the legal guardrails it respects (catalog requirement ids, e.g. California’s and Minnesota’s save-offer rules), and the engine check of the after-example (only verified suggestions are offered). Surfaces whose compliance checks fail are held until fixed. Suggestions never block and never count toward compliance.
+     *
+     * @see POST /v1/suggestions (operation `suggestImprovements`, scope `checks:read`)
+     */
+    generate(params?: T.SuggestionsParams, options?: RequestOptions): Promise<T.SuggestionReport>;
+}
 /** `checkbox.elements` */
 export declare class ElementsResource extends Resource {
     /**
@@ -3079,7 +3143,7 @@ export declare class ReceiptsResource extends Resource {
     /**
      * Download a self-verifying receipt bundle.
      *
-     * ZIP for a lawyer, insurer or court expert: manifest.json (the receipt's evidence record with its chain links) + manifest.sig.json, the canonical receipt JSON under records/, receipt.sig.json (Checkbox's signature over the receipt hash), receipt.png and render.html (the reconstruction), README.md and verify.mjs (zero-dependency offline verifier: node verify.mjs --keys checkbox-keys.json).
+     * ZIP for a lawyer or court expert: manifest.json (the receipt's evidence record with its chain links) + manifest.sig.json, the canonical receipt JSON under records/, receipt.sig.json (Checkbox's signature over the receipt hash), receipt.png and render.html (the reconstruction), README.md and verify.mjs (zero-dependency offline verifier: node verify.mjs --keys checkbox-keys.json).
      *
      * @param receipt Unique identifier of the receipt (rcpt_…).
      * @see GET /v1/receipts/{receipt}/export (operation `exportReceipt`, scope `receipts:read`)
@@ -3326,6 +3390,7 @@ export declare const RESOURCES: {
     readonly notices: typeof NoticesResource;
     readonly lawUpdates: typeof LawUpdatesResource;
     readonly checks: typeof ChecksResource;
+    readonly suggestions: typeof SuggestionsResource;
     readonly elements: typeof ElementsResource;
     readonly disclosures: typeof DisclosuresResource;
     readonly consents: typeof ConsentsResource;

package/dist/generated/operations.js

@@ -1089,6 +1089,40 @@ export const OPERATIONS = {
         paginated: false,
         summary: "Get the dates each required notice must be sent",
     },
+    listSiteSuggestions: {
+        operationId: "listSiteSuggestions",
+        namespace: "suggestions",
+        method: "forSite",
+        httpMethod: "GET",
+        path: "/v1/sites/{site}/suggestions",
+        pathParams: ["site"],
+        queryParams: ["surfaces"],
+        body: false,
+        idempotent: false,
+        auth: true,
+        scope: "checks:read",
+        response: "json",
+        list: false,
+        paginated: false,
+        summary: "Get conversion suggestions for a site",
+    },
+    suggestImprovements: {
+        operationId: "suggestImprovements",
+        namespace: "suggestions",
+        method: "generate",
+        httpMethod: "POST",
+        path: "/v1/suggestions",
+        pathParams: [],
+        queryParams: [],
+        body: true,
+        idempotent: false,
+        auth: true,
+        scope: "checks:read",
+        response: "json",
+        list: false,
+        paginated: false,
+        summary: "Get conversion suggestions for copy you send",
+    },
     getElementsBundle: {
         operationId: "getElementsBundle",
         namespace: "elements",
@@ -1891,7 +1925,7 @@ export class SitesResource extends Resource {
     /**
      * Retrieve a site.
      *
-     * Returns a site with its latest compliance verdict (score, insurable) and install details.
+     * Returns a site with its latest compliance verdict (score, status) and install details.
      *
      * @param site Unique identifier of the site (site_…).
      * @see GET /v1/sites/{site} (operation `retrieveSite`, scope `sites:read`)
@@ -1913,7 +1947,7 @@ export class SitesResource extends Resource {
     /**
      * Archive a site.
      *
-     * Archives (soft-deletes) the site: monitoring stops and it disappears from lists, but evidence and findings are retained for the warranty. Undo with restoreSite.
+     * Archives (soft-deletes) the site: monitoring stops and it disappears from lists, but evidence and findings are retained. Undo with restoreSite.
      *
      * @param site Unique identifier of the site (site_…).
      * @see DELETE /v1/sites/{site} (operation `deleteSite`, scope `sites:write`)
@@ -1939,7 +1973,7 @@ export 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. Pilot fix: this used to be possible only in the dashboard, which could not open test-mode sites.
+     * 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.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/integrations (operation `connectBillingPlatform`, scope `sites:write`)
@@ -2056,7 +2090,7 @@ export class EvaluationsResource extends Resource {
     /**
      * Retrieve an evaluation.
      *
-     * Returns one verdict with all checks and the insurability blockers.
+     * Returns one verdict with all checks and the blocking checks.
      *
      * @param evaluation Unique identifier of the evaluation (eval_…).
      * @see GET /v1/evaluations/{evaluation} (operation `retrieveEvaluation`, scope `evaluations:read`)
@@ -2067,7 +2101,7 @@ export class EvaluationsResource extends Resource {
     /**
      * Get the current verdict of a site.
      *
-     * The latest evaluation of the site: is it compliant (score) and insurable, and what blocks it. 404 resource_missing with next_action createScan when the site was never evaluated.
+     * 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.
      *
      * @param site Unique identifier of the site (site_…).
      * @see GET /v1/sites/{site}/evaluation (operation `retrieveLatestEvaluation`, scope `evaluations:read`)
@@ -2294,7 +2328,7 @@ export class CertificatesResource extends Resource {
     /**
      * Issue a certificate.
      *
-     * Issues a signed monitoring certificate once the site has been insurable for the required streak of days with a verified domain and fresh scans. Otherwise fails with resource_conflict and next_action describing what is missing.
+     * Issues a signed monitoring certificate once the site has passed every critical and high check for the required streak of days with a verified domain and fresh scans. Otherwise fails with resource_conflict and next_action describing what is missing.
      *
      * @param site Unique identifier of the site (site_…).
      * @see POST /v1/sites/{site}/certificates (operation `createCertificate`, scope `certificates:write`, live mode needs an activated account)
@@ -2492,6 +2526,30 @@ export class ChecksResource extends Resource {
         return this._request(OPERATIONS.checkNoticeSchedule, [], params, options);
     }
 }
+/** `checkbox.suggestions` */
+export class SuggestionsResource extends Resource {
+    /**
+     * Get conversion suggestions for a site.
+     *
+     * Suggestions for a site, detected from what Checkbox observed (checkout captures, emails, the test cancellation, billing settings, registered Stripe Checkout params) and its latest evaluation. Optional, deterministic suggestions (no LLM) from Checkbox’s curated library: each has the surface, what to change, why it commonly helps (no invented figures), a concrete before/after built from your plan terms, the exact copy / Stripe patch / flow change to apply, the legal guardrails it respects (catalog requirement ids, e.g. California’s and Minnesota’s save-offer rules), and the engine check of the after-example (only verified suggestions are offered). Surfaces whose compliance checks fail are held until fixed. Suggestions never block and never count toward compliance.
+     *
+     * @param site Unique identifier of the site (site_…).
+     * @see GET /v1/sites/{site}/suggestions (operation `listSiteSuggestions`, scope `checks:read`)
+     */
+    forSite(site, params, options) {
+        return this._request(OPERATIONS.listSiteSuggestions, [site], params, options);
+    }
+    /**
+     * Get conversion suggestions for copy you send.
+     *
+     * Stateless: send any of the inputs of /v1/checks/* (disclosure, page html, Stripe Checkout params, emails) plus a cancellation flow and your plan terms; get suggestions for them. The current status of what you send comes from the same preflight checks; nothing is stored. Optional, deterministic suggestions (no LLM) from Checkbox’s curated library: each has the surface, what to change, why it commonly helps (no invented figures), a concrete before/after built from your plan terms, the exact copy / Stripe patch / flow change to apply, the legal guardrails it respects (catalog requirement ids, e.g. California’s and Minnesota’s save-offer rules), and the engine check of the after-example (only verified suggestions are offered). Surfaces whose compliance checks fail are held until fixed. Suggestions never block and never count toward compliance.
+     *
+     * @see POST /v1/suggestions (operation `suggestImprovements`, scope `checks:read`)
+     */
+    generate(params, options) {
+        return this._request(OPERATIONS.suggestImprovements, [], params, options);
+    }
+}
 /** `checkbox.elements` */
 export class ElementsResource extends Resource {
     /**
@@ -2676,7 +2734,7 @@ export class ReceiptsResource extends Resource {
     /**
      * Download a self-verifying receipt bundle.
      *
-     * ZIP for a lawyer, insurer or court expert: manifest.json (the receipt's evidence record with its chain links) + manifest.sig.json, the canonical receipt JSON under records/, receipt.sig.json (Checkbox's signature over the receipt hash), receipt.png and render.html (the reconstruction), README.md and verify.mjs (zero-dependency offline verifier: node verify.mjs --keys checkbox-keys.json).
+     * ZIP for a lawyer or court expert: manifest.json (the receipt's evidence record with its chain links) + manifest.sig.json, the canonical receipt JSON under records/, receipt.sig.json (Checkbox's signature over the receipt hash), receipt.png and render.html (the reconstruction), README.md and verify.mjs (zero-dependency offline verifier: node verify.mjs --keys checkbox-keys.json).
      *
      * @param receipt Unique identifier of the receipt (rcpt_…).
      * @see GET /v1/receipts/{receipt}/export (operation `exportReceipt`, scope `receipts:read`)
@@ -2975,6 +3033,7 @@ export const RESOURCES = {
     notices: NoticesResource,
     lawUpdates: LawUpdatesResource,
     checks: ChecksResource,
+    suggestions: SuggestionsResource,
     elements: ElementsResource,
     disclosures: DisclosuresResource,
     consents: ConsentsResource,