@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/calendarInvites.d.ts

@@ -0,0 +1,117 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.calendarInvites` (Calendar Invites): 3 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"create_calendar_invite_calendar_invites_post">;
+ *
+ * Reference with examples: calendarInvites.md
+ */
+/* eslint-disable */
+
+/** `g8.api.calendarInvites.<member>` -> the operationId it calls. */
+export interface CalendarInvitesMembers {
+  createCalendarInvite: "create_calendar_invite_calendar_invites_post";
+  getCalendarInvite: "get_calendar_invite_calendar_invites__invite_id__get";
+  updateCalendarInvite: "update_calendar_invite_calendar_invites__invite_id__patch";
+}
+
+/** Input and output of every `g8.api.calendarInvites` operation, keyed by operationId. */
+export interface CalendarInvitesOperations {
+  /**
+   * POST /calendar-invites
+   * Create Calendar Invite
+   * tier: write · scope: meetings:write
+   */
+  create_calendar_invite_calendar_invites_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CalendarInviteCreateRequest;
+  };
+    output: ApiResponse_CalendarInvitePayload_;
+  };
+  /**
+   * GET /calendar-invites/{invite_id}
+   * Get Calendar Invite
+   * tier: read · scope: meetings:read
+   */
+  get_calendar_invite_calendar_invites__invite_id__get: {
+    input: {
+    path: {
+      /** Invite id. */
+      invite_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CalendarInvitePayload_;
+  };
+  /**
+   * PATCH /calendar-invites/{invite_id}
+   * Update Calendar Invite
+   * tier: write · scope: meetings:write
+   */
+  update_calendar_invite_calendar_invites__invite_id__patch: {
+    input: {
+    path: {
+      /** Invite id. */
+      invite_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CalendarInviteUpdateRequest;
+  };
+    output: ApiResponse_CalendarInvitePayload_;
+  };
+}
+
+// 5 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_CalendarInvitePayload_ {
+  data: CalendarInvitePayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface CalendarInviteCreateRequest {
+  description?: string | null;
+  duration_minutes?: number;
+  /** An http(s) URL. */
+  meeting_link?: string | null;
+  /** Start time WITH a timezone offset. */
+  start_at: string;
+  title: string;
+  /** IANA timezone the event is shown in, e.g. `Europe/London`. */
+  tz: string;
+}
+
+/** A calendar invite, including the public `ics_url`. */
+export type CalendarInvitePayload = Record<string, unknown>;
+
+export interface CalendarInviteUpdateRequest {
+  description?: string | null;
+  duration_minutes?: number;
+  meeting_link?: string | null;
+  /** Start time WITH a timezone offset. */
+  start_at: string;
+  title?: string | null;
+  tz: 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;
+}

package/docs/api/calendarInvites.md

@@ -0,0 +1,148 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.calendarInvites`: Calendar Invites
+
+3 operations (1 read, 2 write).
+
+No hand-written client covers this area. Call it through `g8.api.calendarInvites.*` 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: [calendarInvites.d.ts](calendarInvites.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`createCalendarInvite`](#op-createcalendarinvite) | `POST /api/v1/calendar-invites` | write | `meetings:write` | Create Calendar Invite |
+| [`getCalendarInvite`](#op-getcalendarinvite) | `GET /api/v1/calendar-invites/{invite_id}` | read | `meetings:read` | Get Calendar Invite |
+| [`updateCalendarInvite`](#op-updatecalendarinvite) | `PATCH /api/v1/calendar-invites/{invite_id}` | write | `meetings:write` | Update Calendar Invite |
+
+---
+
+<a id="op-createcalendarinvite"></a>
+
+### `g8.api.calendarInvites.createCalendarInvite(input)`
+
+**Create Calendar Invite**
+
+- HTTP: `POST /api/v1/calendar-invites`
+- operationId: `create_calendar_invite_calendar_invites_post` (also callable as `g8.api.call("create_calendar_invite_calendar_invites_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `meetings:write`
+
+Create a calendar invite. Sends nothing; share the returned `ics_url`.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CalendarInviteCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`CalendarInviteCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.start_at` | `string (date-time)` | yes | Start time WITH a timezone offset. |
+| `body.title` | `string` | yes | min length 1, max length 1000 |
+| `body.tz` | `string` | yes | IANA timezone the event is shown in, e.g. `Europe/London`. |
+| `body.description` | `string \| null` | no |  |
+| `body.duration_minutes` | `integer` | no | default `45`, min 1, max 1440 |
+| `body.meeting_link` | `string \| null` | no | An http(s) URL. |
+
+**Returns** `ApiResponse_CalendarInvitePayload_`: the envelope `{ data: CalendarInvitePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.calendarInvites.createCalendarInvite({
+  body: { start_at: "2026-01-01T09:00:00Z", title: "Example", tz: "example" },
+});
+```
+
+---
+
+<a id="op-getcalendarinvite"></a>
+
+### `g8.api.calendarInvites.getCalendarInvite(input)`
+
+**Get Calendar Invite**
+
+- HTTP: `GET /api/v1/calendar-invites/{invite_id}`
+- operationId: `get_calendar_invite_calendar_invites__invite_id__get` (also callable as `g8.api.call("get_calendar_invite_calendar_invites__invite_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `meetings:read`
+
+One calendar invite.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.invite_id` | `string` | yes | Invite id. |
+
+**Returns** `ApiResponse_CalendarInvitePayload_`: the envelope `{ data: CalendarInvitePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.calendarInvites.getCalendarInvite({ path: { invite_id: "id" } });
+```
+
+---
+
+<a id="op-updatecalendarinvite"></a>
+
+### `g8.api.calendarInvites.updateCalendarInvite(input)`
+
+**Update Calendar Invite**
+
+- HTTP: `PATCH /api/v1/calendar-invites/{invite_id}`
+- operationId: `update_calendar_invite_calendar_invites__invite_id__patch` (also callable as `g8.api.call("update_calendar_invite_calendar_invites__invite_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `meetings:write`
+
+Edit an invite. Calendars subscribed to its `.ics` pick up the change.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.invite_id` | `string` | yes | Invite id. |
+| `body` | `CalendarInviteUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`CalendarInviteUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.start_at` | `string (date-time)` | yes | Start time WITH a timezone offset. |
+| `body.tz` | `string` | yes |  |
+| `body.description` | `string \| null` | no |  |
+| `body.duration_minutes` | `integer` | no | default `45`, min 1, max 1440 |
+| `body.meeting_link` | `string \| null` | no |  |
+| `body.title` | `string \| null` | no | max length 1000 |
+
+**Returns** `ApiResponse_CalendarInvitePayload_`: the envelope `{ data: CalendarInvitePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.calendarInvites.updateCalendarInvite({
+  path: { invite_id: "id" },
+  body: { start_at: "2026-01-01T09:00:00Z", tz: "example" },
+});
+```

package/docs/api/campaignWorkflows.d.ts

@@ -0,0 +1,152 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.campaignWorkflows` (Campaign Workflows): 5 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"get_campaign_generation_progress_campaigns__campaign_id__generation_progress_get">;
+ *
+ * Reference with examples: campaignWorkflows.md
+ */
+/* eslint-disable */
+
+/** `g8.api.campaignWorkflows.<member>` -> the operationId it calls. */
+export interface CampaignWorkflowsMembers {
+  getCampaignGenerationProgress: "get_campaign_generation_progress_campaigns__campaign_id__generation_progress_get";
+  listCampaignWorkflows: "list_campaign_workflows_campaigns__campaign_id__workflows_get";
+  saveCampaignIdeas: "save_campaign_ideas_campaigns_ideas_save_post";
+  unlinkCampaignWorkflow: "unlink_campaign_workflow_campaigns__campaign_id__workflows__link_id__delete";
+  updateCampaignWorkflowLink: "update_campaign_workflow_link_campaigns__campaign_id__workflows__link_id__put";
+}
+
+/** Input and output of every `g8.api.campaignWorkflows` operation, keyed by operationId. */
+export interface CampaignWorkflowsOperations {
+  /**
+   * GET /campaigns/{campaign_id}/generation-progress
+   * Get Campaign Generation Progress
+   * tier: read · scope: campaigns:read
+   */
+  get_campaign_generation_progress_campaigns__campaign_id__generation_progress_get: {
+    input: {
+    path: {
+      /** Campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CampaignWorkflowPayload_;
+  };
+  /**
+   * GET /campaigns/{campaign_id}/workflows
+   * List Campaign Workflows
+   * tier: read · scope: campaigns:read
+   */
+  list_campaign_workflows_campaigns__campaign_id__workflows_get: {
+    input: {
+    path: {
+      /** Campaign id. */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CampaignWorkflowListPayload_;
+  };
+  /**
+   * POST /campaigns/ideas/save
+   * Save Campaign Ideas
+   * tier: write · scope: campaigns:write
+   */
+  save_campaign_ideas_campaigns_ideas_save_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: Array<Record<string, unknown>>;
+  };
+    output: ApiResponse_CampaignWorkflowPayload_;
+  };
+  /**
+   * DELETE /campaigns/{campaign_id}/workflows/{link_id}
+   * Unlink Campaign Workflow
+   * tier: destructive · scope: campaigns:delete
+   */
+  unlink_campaign_workflow_campaigns__campaign_id__workflows__link_id__delete: {
+    input: {
+    path: {
+      /** Campaign id. */
+      campaign_id: string;
+      /** Link id. */
+      link_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: void;
+  };
+  /**
+   * PUT /campaigns/{campaign_id}/workflows/{link_id}
+   * Update Campaign Workflow Link
+   * tier: write · scope: campaigns:write
+   */
+  update_campaign_workflow_link_campaigns__campaign_id__workflows__link_id__put: {
+    input: {
+    path: {
+      /** Campaign id. */
+      campaign_id: string;
+      /** Link id. */
+      link_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CampaignWorkflowLinkUpdateRequest;
+  };
+    output: ApiResponse_CampaignWorkflowPayload_;
+  };
+}
+
+// 6 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_CampaignWorkflowListPayload_ {
+  data: CampaignWorkflowListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_CampaignWorkflowPayload_ {
+  data: CampaignWorkflowPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface CampaignWorkflowLinkUpdateRequest {
+  display_order?: number | null;
+  role?: string | null;
+  status?: ("active" | "paused" | "archived") | null;
+}
+
+/** A campaign's workflow links under `items`. */
+export interface CampaignWorkflowListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/** A campaign-workflow link, generation progress or save result. */
+export type CampaignWorkflowPayload = Record<string, unknown>;
+
+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;
+}

package/docs/api/campaignWorkflows.md

@@ -0,0 +1,200 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.campaignWorkflows`: Campaign Workflows
+
+5 operations (2 read, 2 write, 1 destructive).
+
+No hand-written client covers this area. Call it through `g8.api.campaignWorkflows.*` 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: [campaignWorkflows.d.ts](campaignWorkflows.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`getCampaignGenerationProgress`](#op-getcampaigngenerationprogress) | `GET /api/v1/campaigns/{campaign_id}/generation-progress` | read | `campaigns:read` | Get Campaign Generation Progress |
+| [`listCampaignWorkflows`](#op-listcampaignworkflows) | `GET /api/v1/campaigns/{campaign_id}/workflows` | read | `campaigns:read` | List Campaign Workflows |
+| [`saveCampaignIdeas`](#op-savecampaignideas) | `POST /api/v1/campaigns/ideas/save` | write | `campaigns:write` | Save Campaign Ideas |
+| [`unlinkCampaignWorkflow`](#op-unlinkcampaignworkflow) | `DELETE /api/v1/campaigns/{campaign_id}/workflows/{link_id}` | destructive | `campaigns:delete` | Unlink Campaign Workflow |
+| [`updateCampaignWorkflowLink`](#op-updatecampaignworkflowlink) | `PUT /api/v1/campaigns/{campaign_id}/workflows/{link_id}` | write | `campaigns:write` | Update Campaign Workflow Link |
+
+---
+
+<a id="op-getcampaigngenerationprogress"></a>
+
+### `g8.api.campaignWorkflows.getCampaignGenerationProgress(input)`
+
+**Get Campaign Generation Progress**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/generation-progress`
+- operationId: `get_campaign_generation_progress_campaigns__campaign_id__generation_progress_get` (also callable as `g8.api.call("get_campaign_generation_progress_campaigns__campaign_id__generation_progress_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+How far a campaign's content generation has got: documents done, total, current.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id. |
+
+**Returns** `ApiResponse_CampaignWorkflowPayload_`: the envelope `{ data: CampaignWorkflowPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaignWorkflows.getCampaignGenerationProgress({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-listcampaignworkflows"></a>
+
+### `g8.api.campaignWorkflows.listCampaignWorkflows(input)`
+
+**List Campaign Workflows**
+
+- HTTP: `GET /api/v1/campaigns/{campaign_id}/workflows`
+- operationId: `list_campaign_workflows_campaigns__campaign_id__workflows_get` (also callable as `g8.api.call("list_campaign_workflows_campaigns__campaign_id__workflows_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+Workflows linked to a campaign.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id. |
+
+**Returns** `ApiResponse_CampaignWorkflowListPayload_`: the envelope `{ data: CampaignWorkflowListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CampaignWorkflowListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.campaignWorkflows.listCampaignWorkflows({ path: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-savecampaignideas"></a>
+
+### `g8.api.campaignWorkflows.saveCampaignIdeas(input)`
+
+**Save Campaign Ideas**
+
+- HTTP: `POST /api/v1/campaigns/ideas/save`
+- operationId: `save_campaign_ideas_campaigns_ideas_save_post` (also callable as `g8.api.call("save_campaign_ideas_campaigns_ideas_save_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Store generated campaign ideas for the org.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `Array<Record<string, unknown>>` | yes | Request body; fields below. |
+
+**Returns** `ApiResponse_CampaignWorkflowPayload_`: the envelope `{ data: CampaignWorkflowPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaignWorkflows.saveCampaignIdeas({ body: [{}] });
+```
+
+---
+
+<a id="op-unlinkcampaignworkflow"></a>
+
+### `g8.api.campaignWorkflows.unlinkCampaignWorkflow(input)`
+
+**Unlink Campaign Workflow**
+
+- HTTP: `DELETE /api/v1/campaigns/{campaign_id}/workflows/{link_id}`
+- operationId: `unlink_campaign_workflow_campaigns__campaign_id__workflows__link_id__delete` (also callable as `g8.api.call("unlink_campaign_workflow_campaigns__campaign_id__workflows__link_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Unlink a workflow from a campaign. The workflow itself is untouched.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id. |
+| `path.link_id` | `string` | yes | Link id. |
+
+**Returns**: no JSON body is declared for the success response.
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.campaignWorkflows.unlinkCampaignWorkflow({ path: { campaign_id: "id", link_id: "id" } });
+```
+
+---
+
+<a id="op-updatecampaignworkflowlink"></a>
+
+### `g8.api.campaignWorkflows.updateCampaignWorkflowLink(input)`
+
+**Update Campaign Workflow Link**
+
+- HTTP: `PUT /api/v1/campaigns/{campaign_id}/workflows/{link_id}`
+- operationId: `update_campaign_workflow_link_campaigns__campaign_id__workflows__link_id__put` (also callable as `g8.api.call("update_campaign_workflow_link_campaigns__campaign_id__workflows__link_id__put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Change a link's role, display order or status.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.campaign_id` | `string` | yes | Campaign id. |
+| `path.link_id` | `string` | yes | Link id. |
+| `body` | `CampaignWorkflowLinkUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`CampaignWorkflowLinkUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.display_order` | `integer \| null` | no |  |
+| `body.role` | `string \| null` | no | max length 100 |
+| `body.status` | `"active" \| "paused" \| "archived" \| null` | no |  |
+
+**Returns** `ApiResponse_CampaignWorkflowPayload_`: the envelope `{ data: CampaignWorkflowPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.campaignWorkflows.updateCampaignWorkflowLink({ path: { campaign_id: "id", link_id: "id" }, body: {} });
+```