@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/cliPipelines.md

@@ -0,0 +1,562 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.cliPipelines`: CLI Pipelines
+
+12 operations (3 read, 6 write, 2 destructive, 1 billable).
+
+12 of these also have a hand-written method (`g8.pipelines`), marked **★** below. Prefer the hand-written method when one exists: it unwraps the `data` envelope and takes friendlier arguments. See [../sdk-clients.md](../sdk-clients.md).
+
+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: [cliPipelines.d.ts](cliPipelines.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`createPipeline`](#op-createpipeline) ★ | `POST /api/v1/pipelines` | write | `campaigns:write` | Create Pipeline |
+| [`createPipelineFromSuggestion`](#op-createpipelinefromsuggestion) ★ | `POST /api/v1/pipelines/from-suggestion` | write | `campaigns:write` | Create Pipeline From Suggestion |
+| [`createStage`](#op-createstage) ★ | `POST /api/v1/pipelines/{pipeline_id}/stages` | write | `campaigns:write` | Create Stage |
+| [`deletePipeline`](#op-deletepipeline) ★ | `DELETE /api/v1/pipelines/{pipeline_id}` | destructive | `campaigns:delete` | Delete Pipeline |
+| [`deleteStage`](#op-deletestage) ★ | `DELETE /api/v1/pipelines/{pipeline_id}/stages/{stage_id}` | destructive | `campaigns:delete` | Delete Stage |
+| [`getPipeline`](#op-getpipeline) ★ | `GET /api/v1/pipelines/{pipeline_id}` | read | `campaigns:read` | Get Pipeline |
+| [`listPipelines`](#op-listpipelines) ★ | `GET /api/v1/pipelines` | read | `campaigns:read` | List Pipelines |
+| [`listStageEvidenceLibrary`](#op-liststageevidencelibrary) ★ | `GET /api/v1/pipelines/evidence-library` | read | `campaigns:read` | List Stage Evidence Library |
+| [`reorderStages`](#op-reorderstages) ★ | `PUT /api/v1/pipelines/{pipeline_id}/stages/reorder` | write | `campaigns:write` | Reorder Stages |
+| [`suggestPipeline`](#op-suggestpipeline) ★ | `POST /api/v1/pipelines/suggest` | billable | `campaigns:run` | Suggest Pipeline |
+| [`updatePipeline`](#op-updatepipeline) ★ | `PUT /api/v1/pipelines/{pipeline_id}` | write | `campaigns:write` | Update Pipeline |
+| [`updateStage`](#op-updatestage) ★ | `PUT /api/v1/pipelines/{pipeline_id}/stages/{stage_id}` | write | `campaigns:write` | Update Stage |
+
+---
+
+<a id="op-createpipeline"></a>
+
+### `g8.api.cliPipelines.createPipeline(input)`
+
+**Create Pipeline**
+
+- HTTP: `POST /api/v1/pipelines`
+- operationId: `create_pipeline_pipelines_post` (also callable as `g8.api.call("create_pipeline_pipelines_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+- ★ Hand-written: [`g8.pipelines.create()`](../sdk-clients.md#g8-pipelines-create)
+
+Create a new pipeline, auto-seeded with the appropriate target's default stages.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `PipelineCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`PipelineCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.blank` | `boolean` | no | default `false` |
+| `body.name` | `string` | no | default `"Sales Pipeline"` |
+| `body.target` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_PipelineResponse_`: the envelope `{ data: PipelineResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`PipelineResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `name` | `string` | yes |  |
+| `is_default` | `boolean` | no | default `false` |
+| `stages` | `Array<PipelineStageResponse>` | no | default `[]` |
+
+**Example**
+
+```ts
+const result = await g8.api.cliPipelines.createPipeline({ body: {} });
+```
+
+---
+
+<a id="op-createpipelinefromsuggestion"></a>
+
+### `g8.api.cliPipelines.createPipelineFromSuggestion(input)`
+
+**Create Pipeline From Suggestion**
+
+- HTTP: `POST /api/v1/pipelines/from-suggestion`
+- operationId: `create_pipeline_from_suggestion_pipelines_from_suggestion_post` (also callable as `g8.api.call("create_pipeline_from_suggestion_pipelines_from_suggestion_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+- ★ Hand-written: [`g8.pipelines.fromSuggestion()`](../sdk-clients.md#g8-pipelines-fromsuggestion)
+
+Persist a (possibly edited) PipelineSuggestion as a real pipeline.
+
+Validates evidence keys against STAGE_EVIDENCE_LIBRARY, sanitizes
+channel_scripts, and creates the pipeline + stages atomically. No
+dedup — the caller is responsible for not posting the same draft twice.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `Record<string, unknown>` | yes | Request body; fields below. |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.cliPipelines.createPipelineFromSuggestion({ body: {} });
+```
+
+---
+
+<a id="op-createstage"></a>
+
+### `g8.api.cliPipelines.createStage(input)`
+
+**Create Stage**
+
+- HTTP: `POST /api/v1/pipelines/{pipeline_id}/stages`
+- operationId: `create_stage_pipelines__pipeline_id__stages_post` (also callable as `g8.api.call("create_stage_pipelines__pipeline_id__stages_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+- ★ Hand-written: [`g8.pipelines.createStage()`](../sdk-clients.md#g8-pipelines-createstage)
+
+Add a new stage to a pipeline, with v2 checklist + scripts fields.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.pipeline_id` | `string` | yes |  |
+| `body` | `StageCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`StageCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string` | yes |  |
+| `body.channel_scripts` | `Record<string, string> \| null` | no |  |
+| `body.color` | `string` | no | default `"#6B7280"` |
+| `body.probability` | `integer` | no | default `0` |
+| `body.recommended_elements` | `Array<string>` | no |  |
+| `body.required_elements` | `Array<string>` | no |  |
+| `body.stage_type` | `string` | no | default `"open"` |
+
+**Returns** `ApiResponse_PipelineStageResponse_`: the envelope `{ data: PipelineStageResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`PipelineStageResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `name` | `string` | yes |  |
+| `channel_scripts` | `Record<string, string>` | no |  |
+| `color` | `string \| null` | no |  |
+| `position` | `integer \| null` | no |  |
+| `probability` | `integer \| null` | no |  |
+| `recommended_elements` | `Array<string>` | no |  |
+| `required_elements` | `Array<string>` | no |  |
+| `stage_type` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.cliPipelines.createStage({ path: { pipeline_id: "id" }, body: { name: "Example" } });
+```
+
+---
+
+<a id="op-deletepipeline"></a>
+
+### `g8.api.cliPipelines.deletePipeline(input)`
+
+**Delete Pipeline**
+
+- HTTP: `DELETE /api/v1/pipelines/{pipeline_id}`
+- operationId: `delete_pipeline_pipelines__pipeline_id__delete` (also callable as `g8.api.call("delete_pipeline_pipelines__pipeline_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+- ★ Hand-written: [`g8.pipelines.delete()`](../sdk-clients.md#g8-pipelines-delete)
+
+Delete a pipeline. Fails if it has deals or is the org's only pipeline.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.pipeline_id` | `string` | yes |  |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `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.cliPipelines.deletePipeline({ path: { pipeline_id: "id" } });
+```
+
+---
+
+<a id="op-deletestage"></a>
+
+### `g8.api.cliPipelines.deleteStage(input)`
+
+**Delete Stage**
+
+- HTTP: `DELETE /api/v1/pipelines/{pipeline_id}/stages/{stage_id}`
+- operationId: `delete_stage_pipelines__pipeline_id__stages__stage_id__delete` (also callable as `g8.api.call("delete_stage_pipelines__pipeline_id__stages__stage_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+- ★ Hand-written: [`g8.pipelines.deleteStage()`](../sdk-clients.md#g8-pipelines-deletestage)
+
+Delete a stage. Fails if it has deals or pipeline would drop below 2 stages.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.pipeline_id` | `string` | yes |  |
+| `path.stage_id` | `string` | yes |  |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `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.cliPipelines.deleteStage({ path: { pipeline_id: "id", stage_id: "id" } });
+```
+
+---
+
+<a id="op-getpipeline"></a>
+
+### `g8.api.cliPipelines.getPipeline(input)`
+
+**Get Pipeline**
+
+- HTTP: `GET /api/v1/pipelines/{pipeline_id}`
+- operationId: `get_pipeline_pipelines__pipeline_id__get` (also callable as `g8.api.call("get_pipeline_pipelines__pipeline_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+- ★ Hand-written: [`g8.pipelines.get()`](../sdk-clients.md#g8-pipelines-get)
+
+Get one pipeline by ID, with stages including v2 fields.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.pipeline_id` | `string` | yes |  |
+
+**Returns** `ApiResponse_PipelineResponse_`: the envelope `{ data: PipelineResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`PipelineResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `name` | `string` | yes |  |
+| `is_default` | `boolean` | no | default `false` |
+| `stages` | `Array<PipelineStageResponse>` | no | default `[]` |
+
+**Example**
+
+```ts
+const result = await g8.api.cliPipelines.getPipeline({ path: { pipeline_id: "id" } });
+```
+
+---
+
+<a id="op-listpipelines"></a>
+
+### `g8.api.cliPipelines.listPipelines(input?)`
+
+**List Pipelines**
+
+- HTTP: `GET /api/v1/pipelines`
+- operationId: `list_pipelines_pipelines_get` (also callable as `g8.api.call("list_pipelines_pipelines_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+- ★ Hand-written: [`g8.pipelines.list()`](../sdk-clients.md#g8-pipelines-list)
+
+List all deal pipelines for the org, with stages including v2 fields.
+
+**Input**: none.
+
+**Returns** `ApiResponse_list_PipelineResponse__`: the envelope `{ data: Array<PipelineResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`PipelineResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `name` | `string` | yes |  |
+| `is_default` | `boolean` | no | default `false` |
+| `stages` | `Array<PipelineStageResponse>` | no | default `[]` |
+
+**Example**
+
+```ts
+const result = await g8.api.cliPipelines.listPipelines();
+```
+
+---
+
+<a id="op-liststageevidencelibrary"></a>
+
+### `g8.api.cliPipelines.listStageEvidenceLibrary(input?)`
+
+**List Stage Evidence Library**
+
+- HTTP: `GET /api/v1/pipelines/evidence-library`
+- operationId: `list_stage_evidence_library_pipelines_evidence_library_get` (also callable as `g8.api.call("list_stage_evidence_library_pipelines_evidence_library_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+- ★ Hand-written: [`g8.pipelines.evidenceLibrary()`](../sdk-clients.md#g8-pipelines-evidencelibrary)
+
+Return the canonical 8 stage evidence keys + human-readable labels.
+
+**Input**: none.
+
+**Returns** `ApiResponse_list_dict__`: the envelope `{ data: Array<Record<string, unknown>>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.cliPipelines.listStageEvidenceLibrary();
+```
+
+---
+
+<a id="op-reorderstages"></a>
+
+### `g8.api.cliPipelines.reorderStages(input)`
+
+**Reorder Stages**
+
+- HTTP: `PUT /api/v1/pipelines/{pipeline_id}/stages/reorder`
+- operationId: `reorder_stages_pipelines__pipeline_id__stages_reorder_put` (also callable as `g8.api.call("reorder_stages_pipelines__pipeline_id__stages_reorder_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+- ★ Hand-written: [`g8.pipelines.reorderStages()`](../sdk-clients.md#g8-pipelines-reorderstages)
+
+Reorder stages by passing the full ordered list of stage IDs.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.pipeline_id` | `string` | yes |  |
+| `body` | `StageReorderRequest` | yes | Request body; fields below. |
+
+Body fields (`StageReorderRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.stage_ids` | `Array<string>` | yes |  |
+
+**Returns** `ApiResponse_list_PipelineStageResponse__`: the envelope `{ data: Array<PipelineStageResponse>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`PipelineStageResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `name` | `string` | yes |  |
+| `channel_scripts` | `Record<string, string>` | no |  |
+| `color` | `string \| null` | no |  |
+| `position` | `integer \| null` | no |  |
+| `probability` | `integer \| null` | no |  |
+| `recommended_elements` | `Array<string>` | no |  |
+| `required_elements` | `Array<string>` | no |  |
+| `stage_type` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.cliPipelines.reorderStages({ path: { pipeline_id: "id" }, body: { stage_ids: ["id"] } });
+```
+
+---
+
+<a id="op-suggestpipeline"></a>
+
+### `g8.api.cliPipelines.suggestPipeline(input)`
+
+**Suggest Pipeline**
+
+- HTTP: `POST /api/v1/pipelines/suggest`
+- operationId: `suggest_pipeline_pipelines_suggest_post` (also callable as `g8.api.call("suggest_pipeline_pipelines_suggest_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `campaigns:run`
+- ★ Hand-written: [`g8.pipelines.suggest()`](../sdk-clients.md#g8-pipelines-suggest)
+
+Generate an AI-suggested pipeline draft grounded in the org's global context.
+
+Returns the draft dict (PipelineSuggestion shape) — does NOT persist.
+Charges credits at the g8_t2 (Sonnet) tier per call. On Anthropic API
+failure or empty global context, returns a generic target-appropriate
+fallback with `context_sources: []`.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SuggestRequest` | yes | Request body; fields below. |
+
+Body fields (`SuggestRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.motion_hint` | `string \| null` | no |  |
+| `body.target` | `string \| null` | no |  |
+| `body.use_brief_only` | `boolean` | no | default `true` |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `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.cliPipelines.suggestPipeline({ body: {} });
+```
+
+---
+
+<a id="op-updatepipeline"></a>
+
+### `g8.api.cliPipelines.updatePipeline(input)`
+
+**Update Pipeline**
+
+- HTTP: `PUT /api/v1/pipelines/{pipeline_id}`
+- operationId: `update_pipeline_pipelines__pipeline_id__put` (also callable as `g8.api.call("update_pipeline_pipelines__pipeline_id__put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+- ★ Hand-written: [`g8.pipelines.update()`](../sdk-clients.md#g8-pipelines-update)
+
+Rename, retarget, and/or promote a pipeline to default.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.pipeline_id` | `string` | yes |  |
+| `body` | `PipelineUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`PipelineUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string \| null` | no |  |
+| `body.set_default` | `boolean` | no | default `false` |
+| `body.target` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_PipelineResponse_`: the envelope `{ data: PipelineResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`PipelineResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `name` | `string` | yes |  |
+| `is_default` | `boolean` | no | default `false` |
+| `stages` | `Array<PipelineStageResponse>` | no | default `[]` |
+
+**Example**
+
+```ts
+const result = await g8.api.cliPipelines.updatePipeline({ path: { pipeline_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updatestage"></a>
+
+### `g8.api.cliPipelines.updateStage(input)`
+
+**Update Stage**
+
+- HTTP: `PUT /api/v1/pipelines/{pipeline_id}/stages/{stage_id}`
+- operationId: `update_stage_pipelines__pipeline_id__stages__stage_id__put` (also callable as `g8.api.call("update_stage_pipelines__pipeline_id__stages__stage_id__put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+- ★ Hand-written: [`g8.pipelines.updateStage()`](../sdk-clients.md#g8-pipelines-updatestage)
+
+Update a stage. All parameters optional.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.pipeline_id` | `string` | yes |  |
+| `path.stage_id` | `string` | yes |  |
+| `body` | `StageUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`StageUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.channel_scripts` | `Record<string, string> \| null` | no |  |
+| `body.color` | `string \| null` | no |  |
+| `body.name` | `string \| null` | no |  |
+| `body.probability` | `integer \| null` | no |  |
+| `body.recommended_elements` | `Array<string> \| null` | no |  |
+| `body.required_elements` | `Array<string> \| null` | no |  |
+| `body.stage_type` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_PipelineStageResponse_`: the envelope `{ data: PipelineStageResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`PipelineStageResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `name` | `string` | yes |  |
+| `channel_scripts` | `Record<string, string>` | no |  |
+| `color` | `string \| null` | no |  |
+| `position` | `integer \| null` | no |  |
+| `probability` | `integer \| null` | no |  |
+| `recommended_elements` | `Array<string>` | no |  |
+| `required_elements` | `Array<string>` | no |  |
+| `stage_type` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.cliPipelines.updateStage({ path: { pipeline_id: "id", stage_id: "id" }, body: {} });
+```

package/docs/api/clickHouse.d.ts

@@ -0,0 +1,115 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.clickHouse` (ClickHouse): 2 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"clickhouse_mashup_clickhouse_mashup_post">;
+ *
+ * Reference with examples: clickHouse.md
+ */
+/* eslint-disable */
+
+/** `g8.api.clickHouse.<member>` -> the operationId it calls. */
+export interface ClickHouseMembers {
+  clickhouseMashup: "clickhouse_mashup_clickhouse_mashup_post";
+  clickhouseOrgAnalytics: "clickhouse_org_analytics_clickhouse_org_analytics_post";
+}
+
+/** Input and output of every `g8.api.clickHouse` operation, keyed by operationId. */
+export interface ClickHouseOperations {
+  /**
+   * POST /clickhouse/mashup
+   * Clickhouse Mashup
+   * tier: write · scope: search:write
+   */
+  clickhouse_mashup_clickhouse_mashup_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ClickhouseMashupRequest;
+  };
+    output: ApiResponse_ClickhouseMashupResponse_;
+  };
+  /**
+   * POST /clickhouse/org-analytics
+   * Clickhouse Org Analytics
+   * tier: write · scope: search:write
+   */
+  clickhouse_org_analytics_clickhouse_org_analytics_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ClickhouseOrgAnalyticsRequest;
+  };
+    output: ApiResponse_ClickhouseOrgAnalyticsResponse_;
+  };
+}
+
+// 7 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_ClickhouseMashupResponse_ {
+  data: ClickhouseMashupResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_ClickhouseOrgAnalyticsResponse_ {
+  data: ClickhouseOrgAnalyticsResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ClickhouseMashupRequest {
+  limit?: number;
+  /** Which mashup PK to filter by. */
+  mode: "by_upid" | "by_hem" | "by_domain";
+  /** Which mashup table to read. 'joined' returns the lighter denormalized mashup_new with both profiles partially populated. */
+  profile?: "b2b" | "b2c" | "joined";
+  /** Up to 100 key values (UP_IDs, HEMs, or domains). */
+  values: Array<string>;
+}
+
+export interface ClickhouseMashupResponse {
+  matched?: number;
+  mode: string;
+  profile: string;
+  records?: Array<Record<string, unknown>>;
+  requested?: number;
+}
+
+export interface ClickhouseOrgAnalyticsRequest {
+  /** 'raw' returns the matching rows (capped). 'daily_counts' returns {day, count}. 'top_n' returns {value, count} grouped by the dataset's primary group key (contact_id, company_id, keyword_id). */
+  aggregation?: "raw" | "daily_counts" | "top_n";
+  /** Which per-org table to read. */
+  dataset: "people_visitors" | "company_visitors" | "5x5_visitors" | "intent_resolved";
+  /** Optional equality filters. Keys must match dataset columns; unknown columns are silently dropped so an LLM guess can't produce a SQL error. */
+  filters?: Record<string, unknown>;
+  limit?: number;
+  /** ISO date or datetime (inclusive lower bound). */
+  since: string;
+  /** ISO date or datetime (exclusive upper bound). Defaults to now. */
+  until?: string | null;
+}
+
+export interface ClickhouseOrgAnalyticsResponse {
+  aggregation: string;
+  dataset: string;
+  rows?: Array<Record<string, unknown>>;
+  total?: number;
+  window?: Record<string, string>;
+}
+
+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;
+}