@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/cliCampaigns.md

@@ -0,0 +1,256 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.cliCampaigns`: CLI Campaigns
+
+6 operations (3 read, 2 write, 1 external).
+
+No hand-written client covers this area. Call it through `g8.api.cliCampaigns.*` 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: [cliCampaigns.d.ts](cliCampaigns.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`createCampaign`](#op-createcampaign) | `POST /api/v1/repos/{repo_id}/campaigns` | write | `campaigns:write` | Create Campaign |
+| [`getCampaign`](#op-getcampaign) | `GET /api/v1/repos/{repo_id}/campaigns/{campaign_id}` | read | `campaigns:read` | Get Campaign |
+| [`getCampaignDocument`](#op-getcampaigndocument) | `GET /api/v1/repos/{repo_id}/campaigns/{campaign_id}/documents/{document_id}` | read | `campaigns:read` | Get Campaign Document |
+| [`launchCampaign`](#op-launchcampaign) | `POST /api/v1/repos/{repo_id}/campaigns/{campaign_id}/launch` | external | `campaigns:launch` | Launch Campaign |
+| [`listCampaigns`](#op-listcampaigns) | `GET /api/v1/repos/{repo_id}/campaigns` | read | `campaigns:read` | List Campaigns |
+| [`updateCampaign`](#op-updatecampaign) | `PATCH /api/v1/repos/{repo_id}/campaigns/{campaign_id}` | write | `campaigns:write` | Update Campaign |
+
+---
+
+<a id="op-createcampaign"></a>
+
+### `g8.api.cliCampaigns.createCampaign(input)`
+
+**Create Campaign**
+
+- HTTP: `POST /api/v1/repos/{repo_id}/campaigns`
+- operationId: `create_campaign_repos__repo_id__campaigns_post` (also callable as `g8.api.call("create_campaign_repos__repo_id__campaigns_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Create a new campaign from scratch.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.repo_id` | `string` | yes | Repository ID |
+| `body` | `developer_api__interfaces__v1__cli_campaigns_router__CampaignCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`developer_api__interfaces__v1__cli_campaigns_router__CampaignCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string` | yes | Campaign name |
+| `body.brief` | `string \| null` | no | Campaign brief |
+| `body.category` | `string` | no | Campaign category default `"Outbound"` |
+| `body.core_concept` | `string \| null` | no | Core concept |
+| `body.goal` | `string \| null` | no | Campaign goal |
+| `body.primary_hook` | `string \| null` | no | Primary hook text |
+| `body.target_persona` | `string \| null` | no | Target persona |
+
+**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.cliCampaigns.createCampaign({ path: { repo_id: "id" }, body: { name: "Example" } });
+```
+
+---
+
+<a id="op-getcampaign"></a>
+
+### `g8.api.cliCampaigns.getCampaign(input)`
+
+**Get Campaign**
+
+- HTTP: `GET /api/v1/repos/{repo_id}/campaigns/{campaign_id}`
+- operationId: `get_campaign_repos__repo_id__campaigns__campaign_id__get` (also callable as `g8.api.call("get_campaign_repos__repo_id__campaigns__campaign_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Get details of a specific campaign including generated documents.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.repo_id` | `string` | yes | Repository ID |
+| `path.campaign_id` | `string` | yes | Campaign ID |
+
+**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.cliCampaigns.getCampaign({ path: { repo_id: "id", campaign_id: "id" } });
+```
+
+---
+
+<a id="op-getcampaigndocument"></a>
+
+### `g8.api.cliCampaigns.getCampaignDocument(input)`
+
+**Get Campaign Document**
+
+- HTTP: `GET /api/v1/repos/{repo_id}/campaigns/{campaign_id}/documents/{document_id}`
+- operationId: `get_campaign_document_repos__repo_id__campaigns__campaign_id__documents__document_id__get` (also callable as `g8.api.call("get_campaign_document_repos__repo_id__campaigns__campaign_id__documents__document_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Get full content of a specific campaign document.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.repo_id` | `string` | yes | Repository ID |
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `path.document_id` | `string` | yes | Document ID |
+
+**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.cliCampaigns.getCampaignDocument({ path: { repo_id: "id", campaign_id: "id", document_id: "id" } });
+```
+
+---
+
+<a id="op-launchcampaign"></a>
+
+### `g8.api.cliCampaigns.launchCampaign(input)`
+
+**Launch Campaign**
+
+- HTTP: `POST /api/v1/repos/{repo_id}/campaigns/{campaign_id}/launch`
+- operationId: `launch_campaign_repos__repo_id__campaigns__campaign_id__launch_post` (also callable as `g8.api.call("launch_campaign_repos__repo_id__campaigns__campaign_id__launch_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `campaigns:launch`
+
+Launch a campaign via the sequencer bridge.
+
+Same behaviour as ``POST /api/v1/campaigns/{campaign_id}/launch`` — this
+is the repo-scoped variant used by the CLI. See the GTM router docstring
+for the full push-then-run flow.
+
+WARNING: begins sending real outreach to real contacts.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.repo_id` | `string` | yes | Repository ID |
+| `path.campaign_id` | `string` | yes | Campaign ID |
+
+**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
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.cliCampaigns.launchCampaign({ path: { repo_id: "id", campaign_id: "id" } });
+```
+
+---
+
+<a id="op-listcampaigns"></a>
+
+### `g8.api.cliCampaigns.listCampaigns(input)`
+
+**List Campaigns**
+
+- HTTP: `GET /api/v1/repos/{repo_id}/campaigns`
+- operationId: `list_campaigns_repos__repo_id__campaigns_get` (also callable as `g8.api.call("list_campaigns_repos__repo_id__campaigns_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+List campaigns generated for a connected repository.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.repo_id` | `string` | yes | Repository ID |
+| `query.page` | `integer` | no | Page number default `1` |
+| `query.limit` | `integer` | no | Items per page default `50` |
+
+**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.cliCampaigns.listCampaigns({ path: { repo_id: "id" } });
+```
+
+---
+
+<a id="op-updatecampaign"></a>
+
+### `g8.api.cliCampaigns.updateCampaign(input)`
+
+**Update Campaign**
+
+- HTTP: `PATCH /api/v1/repos/{repo_id}/campaigns/{campaign_id}`
+- operationId: `update_campaign_repos__repo_id__campaigns__campaign_id__patch` (also callable as `g8.api.call("update_campaign_repos__repo_id__campaigns__campaign_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Update campaign content fields (name, brief, hook, persona, etc.).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.repo_id` | `string` | yes | Repository ID |
+| `path.campaign_id` | `string` | yes | Campaign ID |
+| `body` | `developer_api__interfaces__v1__cli_campaigns_router__CampaignUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`developer_api__interfaces__v1__cli_campaigns_router__CampaignUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.brief` | `string \| null` | no | Campaign brief |
+| `body.category` | `string \| null` | no | Campaign category |
+| `body.core_concept` | `string \| null` | no | Core concept |
+| `body.goal` | `string \| null` | no | Campaign goal |
+| `body.name` | `string \| null` | no | Campaign name |
+| `body.primary_hook` | `string \| null` | no | Primary hook text |
+| `body.target_persona` | `string \| null` | no | Target persona |
+
+**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.cliCampaigns.updateCampaign({ path: { repo_id: "id", campaign_id: "id" }, body: {} });
+```

package/docs/api/cliPipelines.d.ts

@@ -0,0 +1,324 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.cliPipelines` (CLI Pipelines): 12 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"create_pipeline_pipelines_post">;
+ *
+ * Reference with examples: cliPipelines.md
+ */
+/* eslint-disable */
+
+/** `g8.api.cliPipelines.<member>` -> the operationId it calls. */
+export interface CliPipelinesMembers {
+  createPipeline: "create_pipeline_pipelines_post";
+  createPipelineFromSuggestion: "create_pipeline_from_suggestion_pipelines_from_suggestion_post";
+  createStage: "create_stage_pipelines__pipeline_id__stages_post";
+  deletePipeline: "delete_pipeline_pipelines__pipeline_id__delete";
+  deleteStage: "delete_stage_pipelines__pipeline_id__stages__stage_id__delete";
+  getPipeline: "get_pipeline_pipelines__pipeline_id__get";
+  listPipelines: "list_pipelines_pipelines_get";
+  listStageEvidenceLibrary: "list_stage_evidence_library_pipelines_evidence_library_get";
+  reorderStages: "reorder_stages_pipelines__pipeline_id__stages_reorder_put";
+  suggestPipeline: "suggest_pipeline_pipelines_suggest_post";
+  updatePipeline: "update_pipeline_pipelines__pipeline_id__put";
+  updateStage: "update_stage_pipelines__pipeline_id__stages__stage_id__put";
+}
+
+/** Input and output of every `g8.api.cliPipelines` operation, keyed by operationId. */
+export interface CliPipelinesOperations {
+  /**
+   * POST /pipelines
+   * Create Pipeline
+   * tier: write · scope: campaigns:write
+   */
+  create_pipeline_pipelines_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: PipelineCreateRequest;
+  };
+    output: ApiResponse_PipelineResponse_;
+  };
+  /**
+   * POST /pipelines/from-suggestion
+   * Create Pipeline From Suggestion
+   * tier: write · scope: campaigns:write
+   */
+  create_pipeline_from_suggestion_pipelines_from_suggestion_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: Record<string, unknown>;
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /pipelines/{pipeline_id}/stages
+   * Create Stage
+   * tier: write · scope: campaigns:write
+   */
+  create_stage_pipelines__pipeline_id__stages_post: {
+    input: {
+    path: {
+      pipeline_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: StageCreateRequest;
+  };
+    output: ApiResponse_PipelineStageResponse_;
+  };
+  /**
+   * DELETE /pipelines/{pipeline_id}
+   * Delete Pipeline
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_pipeline_pipelines__pipeline_id__delete: {
+    input: {
+    path: {
+      pipeline_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * DELETE /pipelines/{pipeline_id}/stages/{stage_id}
+   * Delete Stage
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_stage_pipelines__pipeline_id__stages__stage_id__delete: {
+    input: {
+    path: {
+      pipeline_id: string;
+      stage_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * GET /pipelines/{pipeline_id}
+   * Get Pipeline
+   * tier: read · scope: campaigns:read
+   */
+  get_pipeline_pipelines__pipeline_id__get: {
+    input: {
+    path: {
+      pipeline_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_PipelineResponse_;
+  };
+  /**
+   * GET /pipelines
+   * List Pipelines
+   * tier: read · scope: campaigns:read
+   */
+  list_pipelines_pipelines_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_PipelineResponse__;
+  };
+  /**
+   * GET /pipelines/evidence-library
+   * List Stage Evidence Library
+   * tier: read · scope: campaigns:read
+   */
+  list_stage_evidence_library_pipelines_evidence_library_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_dict__;
+  };
+  /**
+   * PUT /pipelines/{pipeline_id}/stages/reorder
+   * Reorder Stages
+   * tier: write · scope: campaigns:write
+   */
+  reorder_stages_pipelines__pipeline_id__stages_reorder_put: {
+    input: {
+    path: {
+      pipeline_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: StageReorderRequest;
+  };
+    output: ApiResponse_list_PipelineStageResponse__;
+  };
+  /**
+   * POST /pipelines/suggest
+   * Suggest Pipeline
+   * tier: billable · scope: campaigns:run
+   */
+  suggest_pipeline_pipelines_suggest_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SuggestRequest;
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * PUT /pipelines/{pipeline_id}
+   * Update Pipeline
+   * tier: write · scope: campaigns:write
+   */
+  update_pipeline_pipelines__pipeline_id__put: {
+    input: {
+    path: {
+      pipeline_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: PipelineUpdateRequest;
+  };
+    output: ApiResponse_PipelineResponse_;
+  };
+  /**
+   * PUT /pipelines/{pipeline_id}/stages/{stage_id}
+   * Update Stage
+   * tier: write · scope: campaigns:write
+   */
+  update_stage_pipelines__pipeline_id__stages__stage_id__put: {
+    input: {
+    path: {
+      pipeline_id: string;
+      stage_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: StageUpdateRequest;
+  };
+    output: ApiResponse_PipelineStageResponse_;
+  };
+}
+
+// 15 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_PipelineResponse_ {
+  data: PipelineResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_PipelineStageResponse_ {
+  data: PipelineStageResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_dict_ {
+  data: Record<string, unknown>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_PipelineResponse__ {
+  data: Array<PipelineResponse>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_PipelineStageResponse__ {
+  data: Array<PipelineStageResponse>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_dict__ {
+  data: Array<Record<string, unknown>>;
+  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;
+}
+
+export interface PipelineCreateRequest {
+  blank?: boolean;
+  name?: string;
+  target?: string | null;
+}
+
+export interface PipelineResponse {
+  id: string;
+  is_default?: boolean;
+  name: string;
+  stages?: Array<PipelineStageResponse>;
+}
+
+export interface PipelineStageResponse {
+  channel_scripts?: Record<string, string>;
+  color?: string | null;
+  id: string;
+  name: string;
+  position?: number | null;
+  probability?: number | null;
+  recommended_elements?: Array<string>;
+  required_elements?: Array<string>;
+  stage_type?: string | null;
+}
+
+export interface PipelineUpdateRequest {
+  name?: string | null;
+  set_default?: boolean;
+  target?: string | null;
+}
+
+export interface StageCreateRequest {
+  channel_scripts?: Record<string, string> | null;
+  color?: string;
+  name: string;
+  probability?: number;
+  recommended_elements?: Array<string>;
+  required_elements?: Array<string>;
+  stage_type?: string;
+}
+
+export interface StageReorderRequest {
+  stage_ids: Array<string>;
+}
+
+export interface StageUpdateRequest {
+  channel_scripts?: Record<string, string> | null;
+  color?: string | null;
+  name?: string | null;
+  probability?: number | null;
+  recommended_elements?: Array<string> | null;
+  required_elements?: Array<string> | null;
+  stage_type?: string | null;
+}
+
+export interface SuggestRequest {
+  motion_hint?: string | null;
+  target?: string | null;
+  use_brief_only?: boolean;
+}