@checkbox-site/node 0.0.0-stage → 0.1.1

package/dist/client.d.ts

@@ -0,0 +1,1884 @@
+import * as errors from './errors.ts';
+import { RESOURCES, type OperationId, type OperationSpec, type OperationTypes } from './generated/operations.ts';
+import { type ApiListPromise, type RequestOptions, type RequestSender, type ResponseMeta } from './resource.ts';
+import { Webhooks } from './webhooks.ts';
+export declare const DEFAULT_BASE_URL = "https://app.checkbox.site";
+export declare const DEFAULT_TIMEOUT_MS = 80000;
+export declare const DEFAULT_MAX_NETWORK_RETRIES = 2;
+export interface CheckboxConfig {
+    /** Checkbox-Version to pin (default: the version this SDK was generated for). */
+    apiVersion?: string;
+    /** API origin (default CHECKBOX_API_BASE or https://app.checkbox.site). */
+    baseUrl?: string;
+    /** Retries on network errors, 409 idempotency_key_in_use, 429 and 5xx with exponential backoff (default 2). */
+    maxNetworkRetries?: number;
+    /** Per-attempt timeout in milliseconds (default 80 000). */
+    timeout?: number;
+    /** fetch implementation (default globalThis.fetch). */
+    fetch?: typeof fetch;
+    /** Identifies your integration in the User-Agent (e.g. { name: 'checkbox-cli', version: '1.2.0' }). */
+    appInfo?: {
+        name: string;
+        version?: string;
+        url?: string;
+    };
+    /** Headers sent with every request. */
+    headers?: Record<string, string>;
+}
+export type Mode = 'test' | 'live';
+/** `ck_test_…` / `rk_test_…` / `pk_test_…` -> test; `ck_live_…` / `rk_live_…` / `sk_live_…` / `pk_live_…` -> live. */
+export declare function modeOfKey(key: string | undefined): Mode | undefined;
+type ResourceInstances = {
+    readonly [K in keyof typeof RESOURCES]: InstanceType<(typeof RESOURCES)[K]>;
+};
+export interface Checkbox extends ResourceInstances {
+}
+/**
+ * Checkbox API client.
+ *
+ * ```ts
+ * import Checkbox from '@checkbox-site/node';
+ * const checkbox = new Checkbox(process.env.CHECKBOX_API_KEY);
+ * const site = await checkbox.sites.create({ url: 'https://acme.example' });
+ * for await (const finding of checkbox.findings.list({ site: site.id })) console.log(finding.check_id, finding.status);
+ * ```
+ */
+export declare class Checkbox implements RequestSender {
+    #private;
+    static readonly VERSION = "0.1.1";
+    static readonly API_VERSION = "2026-10-30";
+    static readonly errors: typeof errors;
+    static readonly webhooks: Webhooks;
+    static readonly OPERATIONS: {
+        readonly createDeviceAuthorization: {
+            readonly operationId: "createDeviceAuthorization";
+            readonly namespace: "device";
+            readonly method: "authorize";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/device/authorize";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: false;
+            readonly auth: false;
+            readonly scope: "none";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Start a device login (setup_checkbox)";
+        };
+        readonly createDeviceToken: {
+            readonly operationId: "createDeviceToken";
+            readonly namespace: "device";
+            readonly method: "token";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/device/token";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: false;
+            readonly auth: false;
+            readonly scope: "none";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Poll a device login for its keys";
+        };
+        readonly createSetupSession: {
+            readonly operationId: "createSetupSession";
+            readonly namespace: "setupSessions";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/setup_sessions";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "setup_sessions:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Start a setup session (agents that already have a key)";
+        };
+        readonly listSetupSessions: {
+            readonly operationId: "listSetupSessions";
+            readonly namespace: "setupSessions";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/setup_sessions";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "setup_sessions:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List setup sessions";
+        };
+        readonly retrieveSetupSession: {
+            readonly operationId: "retrieveSetupSession";
+            readonly namespace: "setupSessions";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/setup_sessions/{setup_session}";
+            readonly pathParams: readonly ["setup_session"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "setup_sessions:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a setup session";
+        };
+        readonly updateSetupSession: {
+            readonly operationId: "updateSetupSession";
+            readonly namespace: "setupSessions";
+            readonly method: "update";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/setup_sessions/{setup_session}";
+            readonly pathParams: readonly ["setup_session"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "setup_sessions:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Report what the agent learned or changed";
+        };
+        readonly verifySetupSession: {
+            readonly operationId: "verifySetupSession";
+            readonly namespace: "setupSessions";
+            readonly method: "verify";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/setup_sessions/{setup_session}/verify";
+            readonly pathParams: readonly ["setup_session"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "setup_sessions:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Re-check the site now";
+        };
+        readonly completeSetupSession: {
+            readonly operationId: "completeSetupSession";
+            readonly namespace: "setupSessions";
+            readonly method: "complete";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/setup_sessions/{setup_session}/complete";
+            readonly pathParams: readonly ["setup_session"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "setup_sessions:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Finish the setup and notify the human";
+        };
+        readonly retrieveAccount: {
+            readonly operationId: "retrieveAccount";
+            readonly namespace: "account";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/account";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "account:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve the account";
+        };
+        readonly updateAccount: {
+            readonly operationId: "updateAccount";
+            readonly namespace: "account";
+            readonly method: "update";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/account";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "account:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Update the account";
+        };
+        readonly listSites: {
+            readonly operationId: "listSites";
+            readonly namespace: "sites";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "archived"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "sites:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List sites";
+        };
+        readonly createSite: {
+            readonly operationId: "createSite";
+            readonly namespace: "sites";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "sites:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Create a site";
+        };
+        readonly retrieveSite: {
+            readonly operationId: "retrieveSite";
+            readonly namespace: "sites";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly ["expand[]"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "sites:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a site";
+        };
+        readonly updateSite: {
+            readonly operationId: "updateSite";
+            readonly namespace: "sites";
+            readonly method: "update";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "sites:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Update a site";
+        };
+        readonly deleteSite: {
+            readonly operationId: "deleteSite";
+            readonly namespace: "sites";
+            readonly method: "del";
+            readonly httpMethod: "DELETE";
+            readonly path: "/v1/sites/{site}";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "sites:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Archive a site";
+        };
+        readonly restoreSite: {
+            readonly operationId: "restoreSite";
+            readonly namespace: "sites";
+            readonly method: "restore";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/restore";
+            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: "Restore an archived site";
+        };
+        readonly connectBillingPlatform: {
+            readonly operationId: "connectBillingPlatform";
+            readonly namespace: "sites";
+            readonly method: "connectBillingPlatform";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/integrations";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "sites:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Connect a billing platform";
+        };
+        readonly retrieveDomainVerification: {
+            readonly operationId: "retrieveDomainVerification";
+            readonly namespace: "domainVerifications";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/domain_verification";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "sites:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve domain verification";
+        };
+        readonly createDomainVerification: {
+            readonly operationId: "createDomainVerification";
+            readonly namespace: "domainVerifications";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/domain_verification";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "sites:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Start domain verification";
+        };
+        readonly checkDomainVerification: {
+            readonly operationId: "checkDomainVerification";
+            readonly namespace: "domainVerifications";
+            readonly method: "check";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/domain_verification/check";
+            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: "Check domain verification now";
+        };
+        readonly createScan: {
+            readonly operationId: "createScan";
+            readonly namespace: "scans";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/scans";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "scans:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Run a scan";
+        };
+        readonly listScans: {
+            readonly operationId: "listScans";
+            readonly namespace: "scans";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/scans";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "scans:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List scans";
+        };
+        readonly retrieveScan: {
+            readonly operationId: "retrieveScan";
+            readonly namespace: "scans";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/scans/{scan}";
+            readonly pathParams: readonly ["scan"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "scans:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a scan";
+        };
+        readonly createEvaluation: {
+            readonly operationId: "createEvaluation";
+            readonly namespace: "evaluations";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/evaluations";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "evaluations:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Re-evaluate a site now";
+        };
+        readonly listEvaluations: {
+            readonly operationId: "listEvaluations";
+            readonly namespace: "evaluations";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/evaluations";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "evaluations:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List evaluations";
+        };
+        readonly retrieveEvaluation: {
+            readonly operationId: "retrieveEvaluation";
+            readonly namespace: "evaluations";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/evaluations/{evaluation}";
+            readonly pathParams: readonly ["evaluation"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "evaluations:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve an evaluation";
+        };
+        readonly retrieveLatestEvaluation: {
+            readonly operationId: "retrieveLatestEvaluation";
+            readonly namespace: "evaluations";
+            readonly method: "retrieveLatest";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/evaluation";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "evaluations:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Get the current verdict of a site";
+        };
+        readonly listFindings: {
+            readonly operationId: "listFindings";
+            readonly namespace: "findings";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/findings";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site", "status", "state"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "findings:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List findings";
+        };
+        readonly retrieveFinding: {
+            readonly operationId: "retrieveFinding";
+            readonly namespace: "findings";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/findings/{finding}";
+            readonly pathParams: readonly ["finding"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "findings:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a finding";
+        };
+        readonly updateFinding: {
+            readonly operationId: "updateFinding";
+            readonly namespace: "findings";
+            readonly method: "update";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/findings/{finding}";
+            readonly pathParams: readonly ["finding"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "findings:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Triage a finding";
+        };
+        readonly retrieveCompliancePlan: {
+            readonly operationId: "retrieveCompliancePlan";
+            readonly namespace: "plans";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/plan";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "compliance_plans:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Get the compliance plan for a site";
+        };
+        readonly retrieveTask: {
+            readonly operationId: "retrieveTask";
+            readonly namespace: "tasks";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/tasks/{task}";
+            readonly pathParams: readonly ["task"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "compliance_plans:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Get one task of a compliance plan";
+        };
+        readonly updateTask: {
+            readonly operationId: "updateTask";
+            readonly namespace: "tasks";
+            readonly method: "update";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/tasks/{task}";
+            readonly pathParams: readonly ["task"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "compliance_plans:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Claim, decline or reopen a task";
+        };
+        readonly answerTask: {
+            readonly operationId: "answerTask";
+            readonly namespace: "tasks";
+            readonly method: "answer";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/tasks/{task}/answer";
+            readonly pathParams: readonly ["task"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "compliance_plans:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Record the human answer to a manual task";
+        };
+        readonly verifyTask: {
+            readonly operationId: "verifyTask";
+            readonly namespace: "tasks";
+            readonly method: "verify";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/tasks/{task}/verify";
+            readonly pathParams: readonly ["task"];
+            readonly queryParams: readonly ["wait"];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "compliance_plans:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Verify a task after applying its change";
+        };
+        readonly verifySite: {
+            readonly operationId: "verifySite";
+            readonly namespace: "sites";
+            readonly method: "verify";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/verify";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly ["wait"];
+            readonly body: false;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "compliance_plans:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Re-check the whole site now";
+        };
+        readonly retrieveVerification: {
+            readonly operationId: "retrieveVerification";
+            readonly namespace: "verifications";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/verifications/{verification}";
+            readonly pathParams: readonly ["verification"];
+            readonly queryParams: readonly ["wait"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "compliance_plans:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Get a verification (long-poll with ?wait=30)";
+        };
+        readonly listVerifications: {
+            readonly operationId: "listVerifications";
+            readonly namespace: "verifications";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/verifications";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "task"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "compliance_plans:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List verifications of a site";
+        };
+        readonly retrieveFindingFix: {
+            readonly operationId: "retrieveFindingFix";
+            readonly namespace: "fixes";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/findings/{finding}/fix";
+            readonly pathParams: readonly ["finding"];
+            readonly queryParams: readonly ["plan", "cancel_url", "target"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "fixes:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Get the fix for a finding";
+        };
+        readonly listSiteFixes: {
+            readonly operationId: "listSiteFixes";
+            readonly namespace: "fixes";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/fixes";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly ["plan", "cancel_url", "target"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "fixes:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: false;
+            readonly summary: "List fix plans for a site";
+        };
+        readonly listEvidence: {
+            readonly operationId: "listEvidence";
+            readonly namespace: "evidence";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/evidence";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site", "kind"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "evidence:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List evidence";
+        };
+        readonly retrieveEvidence: {
+            readonly operationId: "retrieveEvidence";
+            readonly namespace: "evidence";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/evidence/{evidence}";
+            readonly pathParams: readonly ["evidence"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "evidence:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve evidence metadata";
+        };
+        readonly downloadEvidenceContent: {
+            readonly operationId: "downloadEvidenceContent";
+            readonly namespace: "evidence";
+            readonly method: "downloadContent";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/evidence/{evidence}/content";
+            readonly pathParams: readonly ["evidence"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "evidence:read";
+            readonly response: "binary";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Download evidence content";
+        };
+        readonly verifyEvidenceChain: {
+            readonly operationId: "verifyEvidenceChain";
+            readonly namespace: "evidence";
+            readonly method: "verifyChain";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/evidence/verify";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "evidence:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Verify the evidence chain";
+        };
+        readonly listCertificates: {
+            readonly operationId: "listCertificates";
+            readonly namespace: "certificates";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/certificates";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "certificates:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List certificates";
+        };
+        readonly retrieveCertificate: {
+            readonly operationId: "retrieveCertificate";
+            readonly namespace: "certificates";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/certificates/{certificate}";
+            readonly pathParams: readonly ["certificate"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "certificates:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a certificate";
+        };
+        readonly createCertificate: {
+            readonly operationId: "createCertificate";
+            readonly namespace: "certificates";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/certificates";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "certificates:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Issue a certificate";
+        };
+        readonly revokeCertificate: {
+            readonly operationId: "revokeCertificate";
+            readonly namespace: "certificates";
+            readonly method: "revoke";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/certificates/{certificate}/revoke";
+            readonly pathParams: readonly ["certificate"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "certificates:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Revoke a certificate";
+        };
+        readonly retrieveNoticeSettings: {
+            readonly operationId: "retrieveNoticeSettings";
+            readonly namespace: "noticeSettings";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/notice_settings";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "notices:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve notice settings";
+        };
+        readonly updateNoticeSettings: {
+            readonly operationId: "updateNoticeSettings";
+            readonly namespace: "noticeSettings";
+            readonly method: "update";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/notice_settings";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "notices:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Update notice settings";
+        };
+        readonly listDueNotices: {
+            readonly operationId: "listDueNotices";
+            readonly namespace: "notices";
+            readonly method: "listDue";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/notices/due";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site", "status", "kind", "subscription"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "notices:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List due notices";
+        };
+        readonly listNoticeTemplates: {
+            readonly operationId: "listNoticeTemplates";
+            readonly namespace: "notices";
+            readonly method: "listTemplates";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/notices/templates";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["site"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "notices:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: false;
+            readonly summary: "List notice email templates";
+        };
+        readonly checkNoticeTemplate: {
+            readonly operationId: "checkNoticeTemplate";
+            readonly namespace: "notices";
+            readonly method: "checkTemplate";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/notices/templates/check";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "notices:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Check a notice email template";
+        };
+        readonly retrieveDueNotice: {
+            readonly operationId: "retrieveDueNotice";
+            readonly namespace: "notices";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/notices/{notice}";
+            readonly pathParams: readonly ["notice"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "notices:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a due notice";
+        };
+        readonly markNoticeSent: {
+            readonly operationId: "markNoticeSent";
+            readonly namespace: "notices";
+            readonly method: "markSent";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/notices/{notice}/sent";
+            readonly pathParams: readonly ["notice"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "notices:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Mark a due notice as sent";
+        };
+        readonly markNoticeMissed: {
+            readonly operationId: "markNoticeMissed";
+            readonly namespace: "notices";
+            readonly method: "markMissed";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/notices/{notice}/missed";
+            readonly pathParams: readonly ["notice"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "notices:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Record a due notice as missed";
+        };
+        readonly listLawUpdates: {
+            readonly operationId: "listLawUpdates";
+            readonly namespace: "lawUpdates";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/law_updates";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "since"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "law_updates:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List law updates";
+        };
+        readonly retrieveLawUpdate: {
+            readonly operationId: "retrieveLawUpdate";
+            readonly namespace: "lawUpdates";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/law_updates/{law_update}";
+            readonly pathParams: readonly ["law_update"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "law_updates:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a law update";
+        };
+        readonly checkDisclosure: {
+            readonly operationId: "checkDisclosure";
+            readonly namespace: "checks";
+            readonly method: "disclosure";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/checks/disclosure";
+            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: "Check checkout disclosure text";
+        };
+        readonly checkStripeCheckoutSession: {
+            readonly operationId: "checkStripeCheckoutSession";
+            readonly namespace: "checks";
+            readonly method: "stripeCheckoutSession";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/checks/stripe_checkout_session";
+            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: "Check Stripe Checkout Session params";
+        };
+        readonly checkStripePaymentLink: {
+            readonly operationId: "checkStripePaymentLink";
+            readonly namespace: "checks";
+            readonly method: "stripePaymentLink";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/checks/stripe_payment_link";
+            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: "Check Stripe Payment Link params";
+        };
+        readonly checkEmail: {
+            readonly operationId: "checkEmail";
+            readonly namespace: "checks";
+            readonly method: "email";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/checks/email";
+            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: "Check a subscription lifecycle email";
+        };
+        readonly checkPage: {
+            readonly operationId: "checkPage";
+            readonly namespace: "checks";
+            readonly method: "page";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/checks/page";
+            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: "Check a checkout page (HTML or URL)";
+        };
+        readonly checkNoticeSchedule: {
+            readonly operationId: "checkNoticeSchedule";
+            readonly namespace: "checks";
+            readonly method: "noticeSchedule";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/checks/notice_schedule";
+            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 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";
+            readonly method: "retrieveBundle";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/elements.js";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: false;
+            readonly scope: "none";
+            readonly response: "text";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Load the Elements browser bundle";
+        };
+        readonly getElementsManifest: {
+            readonly operationId: "getElementsManifest";
+            readonly namespace: "elements";
+            readonly method: "retrieveManifest";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/elements/manifest.json";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: false;
+            readonly scope: "none";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "List Elements bundle versions and SRI hashes";
+        };
+        readonly getElementsBundleVersion: {
+            readonly operationId: "getElementsBundleVersion";
+            readonly namespace: "elements";
+            readonly method: "retrieveBundleVersion";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/elements/{version}/elements.js";
+            readonly pathParams: readonly ["version"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: false;
+            readonly scope: "none";
+            readonly response: "text";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Load a pinned Elements bundle version";
+        };
+        readonly createDisclosure: {
+            readonly operationId: "createDisclosure";
+            readonly namespace: "disclosures";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/disclosures";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "consents:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Create a locked disclosure for a site";
+        };
+        readonly retrieveDisclosure: {
+            readonly operationId: "retrieveDisclosure";
+            readonly namespace: "disclosures";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/disclosures/{disclosure}";
+            readonly pathParams: readonly ["disclosure"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "publishable";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a disclosure";
+        };
+        readonly createConsent: {
+            readonly operationId: "createConsent";
+            readonly namespace: "consents";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/consents";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "publishable";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Record a consent";
+        };
+        readonly listConsents: {
+            readonly operationId: "listConsents";
+            readonly namespace: "consents";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/consents";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site", "customer_reference", "disclosure", "created_gte", "created_lte"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "consents:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List consents";
+        };
+        readonly retrieveConsent: {
+            readonly operationId: "retrieveConsent";
+            readonly namespace: "consents";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/consents/{consent}";
+            readonly pathParams: readonly ["consent"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "consents:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a consent";
+        };
+        readonly updateConsent: {
+            readonly operationId: "updateConsent";
+            readonly namespace: "consents";
+            readonly method: "update";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/consents/{consent}";
+            readonly pathParams: readonly ["consent"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "consents:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Attach a customer reference to a consent";
+        };
+        readonly createReceiptToken: {
+            readonly operationId: "createReceiptToken";
+            readonly namespace: "receiptTokens";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/receipt_tokens";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "receipts:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Mint a capture token for a checkout";
+        };
+        readonly createReceipt: {
+            readonly operationId: "createReceipt";
+            readonly namespace: "receipts";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/receipts";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "publishable";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Record a consent receipt";
+        };
+        readonly listReceipts: {
+            readonly operationId: "listReceipts";
+            readonly namespace: "receipts";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/receipts";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "site", "customer_reference", "checkout_session", "email", "source", "binding", "created_gte", "created_lte"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "receipts:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List consent receipts";
+        };
+        readonly eraseReceipts: {
+            readonly operationId: "eraseReceipts";
+            readonly namespace: "receipts";
+            readonly method: "erase";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/receipts/erase";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "receipts:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Erase a subscriber's receipts";
+        };
+        readonly retrieveReceipt: {
+            readonly operationId: "retrieveReceipt";
+            readonly namespace: "receipts";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/receipts/{receipt}";
+            readonly pathParams: readonly ["receipt"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "receipts:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a consent receipt";
+        };
+        readonly renderReceipt: {
+            readonly operationId: "renderReceipt";
+            readonly namespace: "receipts";
+            readonly method: "render";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/receipts/{receipt}/render.png";
+            readonly pathParams: readonly ["receipt"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "receipts:read";
+            readonly response: "binary";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Render a receipt as an image";
+        };
+        readonly verifyReceipt: {
+            readonly operationId: "verifyReceipt";
+            readonly namespace: "receipts";
+            readonly method: "verify";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/receipts/{receipt}/verify";
+            readonly pathParams: readonly ["receipt"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "receipts:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Verify a receipt's integrity";
+        };
+        readonly exportReceipt: {
+            readonly operationId: "exportReceipt";
+            readonly namespace: "receipts";
+            readonly method: "export";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/receipts/{receipt}/export";
+            readonly pathParams: readonly ["receipt"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "receipts:read";
+            readonly response: "binary";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Download a self-verifying receipt bundle";
+        };
+        readonly retrieveReceiptSettings: {
+            readonly operationId: "retrieveReceiptSettings";
+            readonly namespace: "receiptSettings";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/receipt_settings";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "receipts:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve receipt settings";
+        };
+        readonly updateReceiptSettings: {
+            readonly operationId: "updateReceiptSettings";
+            readonly namespace: "receiptSettings";
+            readonly method: "update";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/receipt_settings";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "receipts:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Update receipt settings";
+        };
+        readonly createTestCredential: {
+            readonly operationId: "createTestCredential";
+            readonly namespace: "testCredentials";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/test_credentials";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "test_runs:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Store a billing test-mode key";
+        };
+        readonly listTestCredentials: {
+            readonly operationId: "listTestCredentials";
+            readonly namespace: "testCredentials";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/test_credentials";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "test_runs:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: false;
+            readonly summary: "List billing test-mode keys of a site";
+        };
+        readonly deleteTestCredential: {
+            readonly operationId: "deleteTestCredential";
+            readonly namespace: "testCredentials";
+            readonly method: "del";
+            readonly httpMethod: "DELETE";
+            readonly path: "/v1/sites/{site}/test_credentials/{test_credential}";
+            readonly pathParams: readonly ["site", "test_credential"];
+            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 billing test-mode key";
+        };
+        readonly createStripeCheckoutConfig: {
+            readonly operationId: "createStripeCheckoutConfig";
+            readonly namespace: "stripeCheckoutConfigs";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/stripe_checkout_configs";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "test_runs:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Register the Checkout Session params your code uses";
+        };
+        readonly listStripeCheckoutConfigs: {
+            readonly operationId: "listStripeCheckoutConfigs";
+            readonly namespace: "stripeCheckoutConfigs";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/stripe_checkout_configs";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "test_runs:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List registered checkout configs";
+        };
+        readonly retrieveStripeCheckoutConfig: {
+            readonly operationId: "retrieveStripeCheckoutConfig";
+            readonly namespace: "stripeCheckoutConfigs";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/stripe_checkout_configs/{stripe_checkout_config}";
+            readonly pathParams: readonly ["stripe_checkout_config"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "test_runs:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a registered checkout config";
+        };
+        readonly deleteStripeCheckoutConfig: {
+            readonly operationId: "deleteStripeCheckoutConfig";
+            readonly namespace: "stripeCheckoutConfigs";
+            readonly method: "del";
+            readonly httpMethod: "DELETE";
+            readonly path: "/v1/stripe_checkout_configs/{stripe_checkout_config}";
+            readonly pathParams: readonly ["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";
+        };
+        readonly createTestRun: {
+            readonly operationId: "createTestRun";
+            readonly namespace: "testRuns";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/test_runs";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "test_runs:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Start a lifecycle test run";
+        };
+        readonly listTestRuns: {
+            readonly operationId: "listTestRuns";
+            readonly namespace: "testRuns";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/test_runs";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "test_runs:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List test runs of a site";
+        };
+        readonly retrieveTestRun: {
+            readonly operationId: "retrieveTestRun";
+            readonly namespace: "testRuns";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/test_runs/{test_run}";
+            readonly pathParams: readonly ["test_run"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "test_runs:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a test run";
+        };
+        readonly cancelTestRun: {
+            readonly operationId: "cancelTestRun";
+            readonly namespace: "testRuns";
+            readonly method: "cancel";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/test_runs/{test_run}/cancel";
+            readonly pathParams: readonly ["test_run"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "test_runs:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Cancel a test run";
+        };
+        readonly createWebhookEndpoint: {
+            readonly operationId: "createWebhookEndpoint";
+            readonly namespace: "webhookEndpoints";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/webhook_endpoints";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "webhook_endpoints:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Create a webhook endpoint";
+        };
+        readonly listWebhookEndpoints: {
+            readonly operationId: "listWebhookEndpoints";
+            readonly namespace: "webhookEndpoints";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/webhook_endpoints";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "webhook_endpoints:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List webhook endpoints";
+        };
+        readonly retrieveWebhookEndpoint: {
+            readonly operationId: "retrieveWebhookEndpoint";
+            readonly namespace: "webhookEndpoints";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/webhook_endpoints/{webhook_endpoint}";
+            readonly pathParams: readonly ["webhook_endpoint"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "webhook_endpoints:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve a webhook endpoint";
+        };
+        readonly updateWebhookEndpoint: {
+            readonly operationId: "updateWebhookEndpoint";
+            readonly namespace: "webhookEndpoints";
+            readonly method: "update";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/webhook_endpoints/{webhook_endpoint}";
+            readonly pathParams: readonly ["webhook_endpoint"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "webhook_endpoints:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Update a webhook endpoint";
+        };
+        readonly deleteWebhookEndpoint: {
+            readonly operationId: "deleteWebhookEndpoint";
+            readonly namespace: "webhookEndpoints";
+            readonly method: "del";
+            readonly httpMethod: "DELETE";
+            readonly path: "/v1/webhook_endpoints/{webhook_endpoint}";
+            readonly pathParams: readonly ["webhook_endpoint"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "webhook_endpoints:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Delete a webhook endpoint";
+        };
+        readonly rollWebhookEndpointSecret: {
+            readonly operationId: "rollWebhookEndpointSecret";
+            readonly namespace: "webhookEndpoints";
+            readonly method: "rollSecret";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/webhook_endpoints/{webhook_endpoint}/roll_secret";
+            readonly pathParams: readonly ["webhook_endpoint"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "webhook_endpoints:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Roll a webhook signing secret";
+        };
+        readonly listEvents: {
+            readonly operationId: "listEvents";
+            readonly namespace: "events";
+            readonly method: "list";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/events";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly ["limit", "starting_after", "ending_before", "type", "created_gte", "created_lte"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "events:read";
+            readonly response: "json";
+            readonly list: true;
+            readonly paginated: true;
+            readonly summary: "List events";
+        };
+        readonly retrieveEvent: {
+            readonly operationId: "retrieveEvent";
+            readonly namespace: "events";
+            readonly method: "retrieve";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/events/{event}";
+            readonly pathParams: readonly ["event"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "events:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Retrieve an event";
+        };
+        readonly createFeedback: {
+            readonly operationId: "createFeedback";
+            readonly namespace: "feedbacks";
+            readonly method: "create";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/feedback";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "account:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Send feedback";
+        };
+    };
+    static readonly Webhooks: typeof Webhooks;
+    /** Webhook signature verification: `checkbox.webhooks.constructEvent(rawBody, header, secret)`. */
+    readonly webhooks: Webhooks;
+    /** The API version sent as Checkbox-Version. */
+    readonly apiVersion: string;
+    readonly baseUrl: string;
+    /** 'test' for ck_test_/rk_test_ keys, 'live' for live keys, undefined without a (recognised) key. */
+    readonly mode: Mode | undefined;
+    /**
+     * @param apiKey secret (`ck_test_…`, `ck_live_…`), restricted (`rk_…`) or legacy (`sk_live_…`) key. Defaults to
+     *   the CHECKBOX_API_KEY environment variable, then CHECKBOX_SECRET_KEY (what `checkbox init` writes to .env.local).
+     */
+    constructor(apiKey?: string | null, config?: CheckboxConfig);
+    /** True for live keys, false for test keys, undefined when unknown. */
+    get livemode(): boolean | undefined;
+    /** Whether an API key is configured. */
+    get hasApiKey(): boolean;
+    /**
+     * Calls any operation by its operationId with flat arguments (path parameters and params together). This is the
+     * shape MCP tools and agents use: `checkbox.call('retrieveSite', { site: 'site_…' })`.
+     */
+    call<K extends OperationId>(operationId: K, args?: OperationTypes[K]['args'], options?: RequestOptions): Promise<OperationTypes[K]['response']>;
+    /** Like `call` for a paginated list operation, returning the auto-paginating list promise. */
+    callList<K extends OperationId>(operationId: K, args?: OperationTypes[K]['args'], options?: RequestOptions): ApiListPromise<unknown>;
+    /**
+     * Request to any API path with an explicit query and JSON body (escape hatch for endpoints newer than this SDK):
+     * `checkbox.request('POST', '/v1/new_thing', { query: { wait: 5 }, body: { a: 1 } })`. Retries, idempotency keys,
+     * versioning and typed errors apply as for the generated methods.
+     */
+    request<T = unknown>(method: 'GET' | 'POST' | 'DELETE', path: string, opts?: RequestOptions & {
+        query?: Record<string, unknown>;
+        body?: Record<string, unknown>;
+    }): Promise<T>;
+    /**
+     * Stripe-style raw request: `params` go to the query string for GET/DELETE and to the JSON body for POST.
+     * `checkbox.rawRequest('GET', '/v1/sites', { limit: 3 })`.
+     */
+    rawRequest<T = unknown>(method: 'GET' | 'POST' | 'DELETE', path: string, params?: Record<string, unknown>, options?: RequestOptions): Promise<T>;
+    /** @internal Used by the generated resources. */
+    _send(op: OperationSpec, pathArgs: readonly unknown[], params: Record<string, unknown> | undefined, options?: RequestOptions): Promise<unknown>;
+}
+/** Response metadata of an object returned by the SDK (status, request id, idempotency replay, headers). */
+export declare function getLastResponse(obj: unknown): ResponseMeta | undefined;
+/** 0.5 s, 1 s, 2 s, ... capped at 20 s, with jitter (75-100 %). */
+export declare function backoff(attempt: number): number;
+export {};