@graph8/sdk 0.251.0 → 0.262.0

package/docs/api/scheduleBuy.md

@@ -0,0 +1,431 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.scheduleBuy`: Schedule Buy
+
+9 operations (5 read, 1 write, 1 destructive, 2 billable).
+
+No hand-written client covers this area. Call it through `g8.api.scheduleBuy.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
+
+Every example below assumes this setup (server-side, API key):
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+```
+
+Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
+
+Exact TypeScript types for every operation on this page, and every schema they use: [scheduleBuy.d.ts](scheduleBuy.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`cancelPlan`](#op-cancelplan) | `DELETE /api/v1/mailboxes/schedule-buy/plans/{plan_id}` | destructive | `campaigns:delete` | Cancel Plan |
+| [`checkPlanDomains`](#op-checkplandomains) | `POST /api/v1/mailboxes/schedule-buy/check-domains` | read | `campaigns:read` | Check Plan Domains |
+| [`createPlan`](#op-createplan) | `POST /api/v1/mailboxes/schedule-buy/plans` | billable | `campaigns:run` | Create Plan |
+| [`getPlan`](#op-getplan) | `GET /api/v1/mailboxes/schedule-buy/plans/{plan_id}` | read | `campaigns:read` | Get Plan |
+| [`listPlans`](#op-listplans) | `GET /api/v1/mailboxes/schedule-buy/plans` | read | `campaigns:read` | List Plans |
+| [`pausePlan`](#op-pauseplan) | `POST /api/v1/mailboxes/schedule-buy/plans/{plan_id}/pause` | write | `campaigns:write` | Pause Plan |
+| [`resumePlan`](#op-resumeplan) | `POST /api/v1/mailboxes/schedule-buy/plans/{plan_id}/resume` | billable | `campaigns:run` | Resume Plan |
+| [`suggestPlan`](#op-suggestplan) | `POST /api/v1/mailboxes/schedule-buy/suggest` | read | `campaigns:read` | Suggest Plan |
+| [`suggestPlanDomains`](#op-suggestplandomains) | `POST /api/v1/mailboxes/schedule-buy/suggest-domains` | read | `campaigns:read` | Suggest Plan Domains |
+
+---
+
+<a id="op-cancelplan"></a>
+
+### `g8.api.scheduleBuy.cancelPlan(input)`
+
+**Cancel Plan**
+
+- HTTP: `DELETE /api/v1/mailboxes/schedule-buy/plans/{plan_id}`
+- operationId: `cancel_plan_mailboxes_schedule_buy_plans__plan_id__delete` (also callable as `g8.api.call("cancel_plan_mailboxes_schedule_buy_plans__plan_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Cancel a plan and release every hold it has not yet spent. NOT REVERSIBLE.
+
+Batches already bought stay bought - this stops the plan buying MORE. The
+released credits return to the org's balance; there is no un-cancel, so a
+plan you want to stop temporarily is a different operation.
+
+Org admins and owners only. 409 if the plan is executing a batch right now
+(retry in a few minutes - cancelling mid-batch could release a hold the
+executor is about to charge) or if the plan is in a state that cannot be
+cancelled at all.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.plan_id` | `integer` | yes | Schedule Buy plan id - from GET /mailboxes/schedule-buy/plans |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.scheduleBuy.cancelPlan({ path: { plan_id: 1 } });
+```
+
+---
+
+<a id="op-checkplandomains"></a>
+
+### `g8.api.scheduleBuy.checkPlanDomains(input)`
+
+**Check Plan Domains**
+
+- HTTP: `POST /api/v1/mailboxes/schedule-buy/check-domains`
+- operationId: `check_plan_domains_mailboxes_schedule_buy_check_domains_post` (also callable as `g8.api.call("check_plan_domains_mailboxes_schedule_buy_check_domains_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Validate names you edited: already yours, available, or refused. SPENDS NOTHING.
+
+One entry per name. `available: null` means the probe itself failed and
+the answer is UNKNOWN - not that the name is taken. Treat null as "check
+again" rather than as a no.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `ScheduleBuyDomainCheckRequest` | yes | Request body; fields below. |
+
+Body fields (`ScheduleBuyDomainCheckRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.names` | `Array<string>` | yes | Domain names to validate min items 1, max items 100 |
+
+**Returns** `ApiResponse_MailboxDomainListPayload_`: the envelope `{ data: MailboxDomainListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`MailboxDomainListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.scheduleBuy.checkPlanDomains({ body: { names: ["Example"] } });
+```
+
+---
+
+<a id="op-createplan"></a>
+
+### `g8.api.scheduleBuy.createPlan(input)`
+
+**Create Plan**
+
+- HTTP: `POST /api/v1/mailboxes/schedule-buy/plans`
+- operationId: `create_plan_mailboxes_schedule_buy_plans_post` (also callable as `g8.api.call("create_plan_mailboxes_schedule_buy_plans_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+Create and LOCK a buying plan. PLACES REAL CREDIT HOLDS IMMEDIATELY.
+
+Locking reserves credits for the WHOLE plan up front - one hold per batch,
+up to two hundred of them - even though the domains are bought a batch a
+day afterwards. The credits are gone from your spendable balance the
+moment this returns. `total_credits_held` in the response is the figure.
+
+Org admins and owners only, and only for an org on a paid or pre-funded
+plan. 402 if the balance cannot cover the plan, 429 if the org has locked
+more than five plans this hour, 400 for an unsupported extension or an
+empty plan.
+
+`persona_ids` and the manual `registrants`/`mailbox_aliases` pair are
+mutually exclusive: name the personas OR spell the identities out, never
+both. `idle_mailboxes_snapshot` is your own count, used to detect drift -
+the server recomputes it and returns its own as
+`server_idle_mailboxes`.
+
+Send an `Idempotency-Key` header. A retried lock without one places a
+second full set of holds.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `ScheduleBuyPlanRequest` | yes | Request body; fields below. |
+
+Body fields (`ScheduleBuyPlanRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.idle_mailboxes_snapshot` | `integer` | yes | Idle mailboxes you already hold, from /suggest min 0 |
+| `body.target_monthly_volume` | `integer` | yes | Contacts you intend to reach per month min 0, max 100000000 |
+| `body.daily_send_cap` | `integer` | no | Sends per mailbox per day default `15`, min 1, max 100 |
+| `body.domain_names` | `Array<string> \| null` | no | Approved names to buy, in order min items 1, max items 500 |
+| `body.domain_tld` | `string` | no | Extension to buy, e.g. '.com' default `".com"` |
+| `body.domains_per_batch` | `integer` | no | Domains bought per daily batch default `10`, min 1, max 100 |
+| `body.mailbox_aliases` | `Array<Record<string, unknown>>` | no | One alias per mailbox_per_domain. Required unless persona_ids is set. |
+| `body.mailboxes_per_domain` | `integer` | no | Mailboxes bought on each domain default `3`, min 1, max 5 |
+| `body.persona_ids` | `Array<integer> \| null` | no | Sender personas to buy for. Excludes the two above. min items 1, max items 20 |
+| `body.registrants` | `Array<Record<string, unknown>>` | no | Registrant identities. Required unless persona_ids is set. max items 20 |
+| `body.reuse_domains` | `Array<string> \| null` | no | Adopt these owned EMPTY domains instead of buying min items 1, max items 500 |
+| `body.sending_days_per_month` | `integer` | no | Sending days assumed per month default `22`, min 1, max 31 |
+| `body.warmup_provider` | `"warmy" \| "instantly" \| "smartlead"` | no | Warmup engine the bought mailboxes are enrolled with default `"warmy"` |
+| `body.workspace_uid` | `string \| null` | no | Existing provisioning workspace to reuse |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.scheduleBuy.createPlan({ body: { idle_mailboxes_snapshot: 0, target_monthly_volume: 0 } });
+```
+
+---
+
+<a id="op-getplan"></a>
+
+### `g8.api.scheduleBuy.getPlan(input)`
+
+**Get Plan**
+
+- HTTP: `GET /api/v1/mailboxes/schedule-buy/plans/{plan_id}`
+- operationId: `get_plan_mailboxes_schedule_buy_plans__plan_id__get` (also callable as `g8.api.call("get_plan_mailboxes_schedule_buy_plans__plan_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+One plan and every batch it has run, in order.
+
+A batch carries what it bought and what it was charged. The internal
+credit-ledger transaction ids are deliberately not published - use
+`GET /usage` for the ledger.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.plan_id` | `integer` | yes | Schedule Buy plan id - from GET /mailboxes/schedule-buy/plans |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.scheduleBuy.getPlan({ path: { plan_id: 1 } });
+```
+
+---
+
+<a id="op-listplans"></a>
+
+### `g8.api.scheduleBuy.listPlans(input?)`
+
+**List Plans**
+
+- HTTP: `GET /api/v1/mailboxes/schedule-buy/plans`
+- operationId: `list_plans_mailboxes_schedule_buy_plans_get` (also callable as `g8.api.call("list_plans_mailboxes_schedule_buy_plans_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+The org's plans, newest first, with live progress on each.
+
+`mailboxes_provisioned` and `landing_pages_hosted` are best-effort
+decoration: a failure computing them reports zero rather than failing the
+list, so do not read a zero as "nothing has been provisioned".
+
+**Input**: none.
+
+**Returns** `ApiResponse_MailboxDomainListPayload_`: the envelope `{ data: MailboxDomainListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`MailboxDomainListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.scheduleBuy.listPlans();
+```
+
+---
+
+<a id="op-pauseplan"></a>
+
+### `g8.api.scheduleBuy.pausePlan(input)`
+
+**Pause Plan**
+
+- HTTP: `POST /api/v1/mailboxes/schedule-buy/plans/{plan_id}/pause`
+- operationId: `pause_plan_mailboxes_schedule_buy_plans__plan_id__pause_post` (also callable as `g8.api.call("pause_plan_mailboxes_schedule_buy_plans__plan_id__pause_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Pause a plan: the daily executor skips it and buys nothing more.
+
+Every credit hold stays RESERVED - pausing does not release money, it only
+stops it being spent. Resume picks up exactly where it left off. Org admins
+and owners only; 409 if the plan is not in a pausable state.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.plan_id` | `integer` | yes | Schedule Buy plan id - from GET /mailboxes/schedule-buy/plans |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.scheduleBuy.pausePlan({ path: { plan_id: 1 } });
+```
+
+---
+
+<a id="op-resumeplan"></a>
+
+### `g8.api.scheduleBuy.resumePlan(input)`
+
+**Resume Plan**
+
+- HTTP: `POST /api/v1/mailboxes/schedule-buy/plans/{plan_id}/resume`
+- operationId: `resume_plan_mailboxes_schedule_buy_plans__plan_id__resume_post` (also callable as `g8.api.call("resume_plan_mailboxes_schedule_buy_plans__plan_id__resume_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+
+Resume a paused plan. BUYING RESTARTS on the next daily tick.
+
+The plan goes back to in-progress and its held credits start being charged
+again, batch by batch, catching up first. Org admins and owners only; 409
+unless the plan is paused.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.plan_id` | `integer` | yes | Schedule Buy plan id - from GET /mailboxes/schedule-buy/plans |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.scheduleBuy.resumePlan({ path: { plan_id: 1 } });
+```
+
+---
+
+<a id="op-suggestplan"></a>
+
+### `g8.api.scheduleBuy.suggestPlan(input)`
+
+**Suggest Plan**
+
+- HTTP: `POST /api/v1/mailboxes/schedule-buy/suggest`
+- operationId: `suggest_plan_mailboxes_schedule_buy_suggest_post` (also callable as `g8.api.call("suggest_plan_mailboxes_schedule_buy_suggest_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Size a plan before you lock it. SPENDS NOTHING, holds nothing.
+
+Counts the idle mailboxes you already have, then works out how many new
+domains and mailboxes the target volume still needs and what they would
+cost in credits. Pass its idle count back as `idle_mailboxes_snapshot`
+when you lock the plan.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `ScheduleBuySuggestRequest` | yes | Request body; fields below. |
+
+Body fields (`ScheduleBuySuggestRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.target_monthly_volume` | `integer` | yes | Contacts you intend to reach per month min 0, max 100000000 |
+| `body.daily_send_cap` | `integer` | no | Sends per mailbox per day default `15`, min 1, max 100 |
+| `body.domains_per_batch` | `integer` | no | Domains bought per daily batch default `10`, min 1, max 100 |
+| `body.mailboxes_per_domain` | `integer` | no | Mailboxes bought on each domain default `3`, min 1, max 5 |
+| `body.sending_days_per_month` | `integer` | no | Sending days assumed per month default `22`, min 1, max 31 |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.scheduleBuy.suggestPlan({ body: { target_monthly_volume: 0 } });
+```
+
+---
+
+<a id="op-suggestplandomains"></a>
+
+### `g8.api.scheduleBuy.suggestPlanDomains(input)`
+
+**Suggest Plan Domains**
+
+- HTTP: `POST /api/v1/mailboxes/schedule-buy/suggest-domains`
+- operationId: `suggest_plan_domains_mailboxes_schedule_buy_suggest_domains_post` (also callable as `g8.api.call("suggest_plan_domains_mailboxes_schedule_buy_suggest_domains_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Candidate domain names a plan WOULD buy. SPENDS NOTHING, buys nothing.
+
+Same generator, same owned-domain exclusion and same live availability
+probe the executor uses at buy time, so the preview is honest rather than
+decorative.
+
+`offset` rotates the generator: call again with a higher offset to get a
+fresh set instead of the same list. `avoid` excludes names you have
+already rejected.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `ScheduleBuyDomainSuggestRequest` | yes | Request body; fields below. |
+
+Body fields (`ScheduleBuyDomainSuggestRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.count` | `integer` | yes | How many candidate names to return min 1, max 100 |
+| `body.avoid` | `Array<string> \| null` | no | Names to exclude max items 50 |
+| `body.domain_tld` | `string` | no | Extension to generate against, e.g. '.com' default `".com"` |
+| `body.offset` | `integer` | no | Rotate the generator to get fresh candidates default `0`, min 0, max 1000 |
+| `body.pattern` | `"prefix" \| "suffix" \| "both" \| null` | no | Where to attach the root |
+| `body.roots` | `Array<string> \| null` | no | Word roots to build names from max items 10 |
+| `body.tlds` | `Array<string> \| null` | no | Restrict to these extensions min items 1 |
+
+**Returns** `ApiResponse_MailboxDomainPayload_`: the envelope `{ data: MailboxDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.scheduleBuy.suggestPlanDomains({ body: { count: 1 } });
+```

package/docs/api/scraping.d.ts

@@ -0,0 +1,266 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.scraping` (Scraping): 10 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"confirm_scrape_job_scrape_jobs__job_id__confirm_post">;
+ *
+ * Reference with examples: scraping.md
+ */
+/* eslint-disable */
+
+/** `g8.api.scraping.<member>` -> the operationId it calls. */
+export interface ScrapingMembers {
+  confirmScrapeJob: "confirm_scrape_job_scrape_jobs__job_id__confirm_post";
+  exportScrapeJobCsv: "export_scrape_job_csv_scrape_jobs__job_id__export_csv_get";
+  getCrawlStatus: "get_crawl_status_settings_scrape_config_crawl_status__job_id__get";
+  getScrapeConfig: "get_scrape_config_settings_scrape_config_get";
+  getScrapeJob: "get_scrape_job_scrape_jobs__job_id__get";
+  listScrapeAdapters: "list_scrape_adapters_scrape_adapters_get";
+  rejectScrapeJob: "reject_scrape_job_scrape_jobs__job_id__reject_post";
+  startFullSiteCrawl: "start_full_site_crawl_settings_scrape_config_crawl_post";
+  submitScrapeRequest: "submit_scrape_request_scrape_requests_post";
+  updateScrapeConfig: "update_scrape_config_settings_scrape_config_patch";
+}
+
+/** Input and output of every `g8.api.scraping` operation, keyed by operationId. */
+export interface ScrapingOperations {
+  /**
+   * POST /scrape/jobs/{job_id}/confirm
+   * Confirm Scrape Job
+   * tier: write · scope: enrichment:write
+   */
+  confirm_scrape_job_scrape_jobs__job_id__confirm_post: {
+    input: {
+    path: {
+      /** Scrape job id. */
+      job_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SettingsPayload_;
+  };
+  /**
+   * GET /scrape/jobs/{job_id}/export.csv
+   * Export Scrape Job Csv
+   * tier: read · scope: enrichment:read
+   */
+  export_scrape_job_csv_scrape_jobs__job_id__export_csv_get: {
+    input: {
+    path: {
+      /** Scrape job id. */
+      job_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: void;
+  };
+  /**
+   * GET /settings/scrape-config/crawl/status/{job_id}
+   * Get Crawl Status
+   * tier: read · scope: enrichment:read
+   */
+  get_crawl_status_settings_scrape_config_crawl_status__job_id__get: {
+    input: {
+    path: {
+      /** Crawl job id. */
+      job_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SettingsPayload_;
+  };
+  /**
+   * GET /settings/scrape-config
+   * Get Scrape Config
+   * tier: read · scope: enrichment:read
+   */
+  get_scrape_config_settings_scrape_config_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SettingsPayload_;
+  };
+  /**
+   * GET /scrape/jobs/{job_id}
+   * Get Scrape Job
+   * tier: read · scope: enrichment:read
+   */
+  get_scrape_job_scrape_jobs__job_id__get: {
+    input: {
+    path: {
+      /** Scrape job id. */
+      job_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SettingsPayload_;
+  };
+  /**
+   * GET /scrape/adapters
+   * List Scrape Adapters
+   * tier: read · scope: enrichment:read
+   */
+  list_scrape_adapters_scrape_adapters_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SettingsListPayload_;
+  };
+  /**
+   * POST /scrape/jobs/{job_id}/reject
+   * Reject Scrape Job
+   * tier: write · scope: enrichment:write
+   */
+  reject_scrape_job_scrape_jobs__job_id__reject_post: {
+    input: {
+    path: {
+      /** Scrape job id. */
+      job_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SettingsPayload_;
+  };
+  /**
+   * POST /settings/scrape-config/crawl
+   * Start Full Site Crawl
+   * tier: external · scope: enrichment:run
+   */
+  start_full_site_crawl_settings_scrape_config_crawl_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: StartCrawlRequest;
+  };
+    output: ApiResponse_SettingsPayload_;
+  };
+  /**
+   * POST /scrape/requests
+   * Submit Scrape Request
+   * tier: billable · scope: enrichment:run
+   */
+  submit_scrape_request_scrape_requests_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SubmitScrapeRequest;
+  };
+    output: ApiResponse_SettingsPayload_;
+  };
+  /**
+   * PATCH /settings/scrape-config
+   * Update Scrape Config
+   * tier: write · scope: enrichment:write
+   */
+  update_scrape_config_settings_scrape_config_patch: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ScrapeConfigUpdateRequest;
+  };
+    output: ApiResponse_SettingsPayload_;
+  };
+}
+
+// 8 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_SettingsListPayload_ {
+  data: SettingsListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SettingsPayload_ {
+  data: SettingsPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface PaginationMeta {
+  /** Whether there are more pages */
+  has_next: boolean;
+  /** Items per page */
+  limit: number;
+  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
+  next_cursor?: string | null;
+  /** Current page number (1-indexed) */
+  page: number;
+  /** Total number of items */
+  total: number;
+}
+
+/** Change how the org crawls. Only what you send is written. */
+export interface ScrapeConfigUpdateRequest {
+  /** URL path patterns to skip while crawling. */
+  exclude_paths?: Array<string> | null;
+  include_blog_pages?: boolean | null;
+  /** Pages per crawl. The app's own bounds. */
+  max_pages?: number | null;
+}
+
+/** An open envelope for a LIST result, so a bare list keeps its shape. */
+export interface SettingsListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/**
+ * An open envelope for a settings object.
+ *
+ * Open because an ontology concept and an SSO config both grow fields as the
+ * product does, and on a settings read a dropped field reads as "not
+ * configured" rather than "we did not tell you".
+ */
+export type SettingsPayload = Record<string, unknown>;
+
+/** Crawl a whole site. Long-running, and it fetches every reachable page. */
+export interface StartCrawlRequest {
+  max_pages?: number | null;
+  /** Where to start. Omit to use the org's configured site. */
+  source_url?: string | null;
+}
+
+/**
+ * Ask for a scrape, in plain English.
+ *
+ * `preview` defaults to TRUE and that default is load-bearing: it holds the
+ * run behind a five-row sample so you can see what it will do before it does
+ * it at scale. Turning it off is what makes a run expensive.
+ */
+export interface SubmitScrapeRequest {
+  /** Skip the planner and use this capability directly. */
+  adapter?: string | null;
+  params?: Record<string, unknown>;
+  /** Hold the run behind a 5-row preview. Leave it on for a first run. */
+  preview?: boolean;
+  /** What to scrape, in plain English. */
+  requirement: string;
+  /** Re-run rows that already have a result. */
+  rescrape?: boolean;
+  /** Limit the run to these rows. */
+  row_ids?: Array<number> | null;
+  /** Cold start: add these as rows in `source_column` before scraping. */
+  seed_targets?: Array<string> | null;
+  /** Column holding the values to scrape from. */
+  source_column?: string | null;
+  /** Staging table to read from and write into. */
+  staging_table_id?: string | null;
+}