@ai2aim.ai/hivemind-sdk 1.0.15 → 3.1.1

package/dist/types.d.ts

@@ -1,253 +1,83 @@
-/**
- * Every JSON response from the backend is wrapped in this envelope by
- * the `ResponseEnvelopeMiddleware`. The SDK's REST client unwraps it
- * automatically — use {@link ApiEnvelope} when you need access to
- * `message` or `statusCode` directly.
- */
 export interface ApiEnvelope<T = unknown> {
     success: boolean;
     statusCode: number;
     data: T;
     message: string;
 }
-/** Shape of the envelope when the request failed (4xx / 5xx). */
 export interface ApiErrorBody {
     success: false;
     statusCode: number;
     data: Record<string, unknown> | null;
     message: string;
 }
-/**
- * Optional per-request overrides. Use this to pass an API key from your
- * own database/cache instead of storing it in client config.
- */
+export type RequestAuthMode = "api" | "admin" | "webhook" | "none";
 export interface RequestOptions {
-    /** Organization API key for this request (e.g. from your DB/cache). */
     apiKey?: string;
+    authMode?: RequestAuthMode;
 }
-/**
- * Resolved config (baseUrl always set). Used internally.
- */
 export interface HivemindClientConfig {
     baseUrl: string;
     apiPrefix?: string;
     apiKey?: string;
     adminKey?: string;
     webhookSecret?: string;
-    employeeId?: string;
     timeoutMs?: number;
     insecure?: boolean;
 }
-/**
- * Config when creating a client. baseUrl is optional:
- * if omitted, it is read from env (HIVEMIND_BASE_URL or HIVEMIND_API_URL).
- * Set it once in the environment and only pass overrides (e.g. adminKey, apiKey)
- * when creating the client.
- */
-export interface HivemindClientConfigInput {
-    /** Base URL; defaults to HIVEMIND_BASE_URL or HIVEMIND_API_URL */
+export interface HivemindClientConfigInput extends Partial<HivemindClientConfig> {
     baseUrl?: string;
-    /** API prefix, defaults to "/v1" */
-    apiPrefix?: string;
-    /** Organization API key (vtx_…); or pass per-request via RequestOptions */
-    apiKey?: string;
-    /** Admin bootstrap key for admin-only endpoints */
-    adminKey?: string;
-    /** Webhook secret for webhook endpoints */
-    webhookSecret?: string;
-    /** Employee ID header */
-    employeeId?: string;
-    /** Request timeout in ms (default 30 000) */
-    timeoutMs?: number;
-    /** Skip TLS verification (self-signed certs) */
-    insecure?: boolean;
 }
-/** Organization tier determining quotas, rate limits, and available features. */
-export type OrgTier = "free" | "standard" | "premium" | "enterprise";
-/** Organization lifecycle status. */
-export type OrgStatus = "active" | "suspended";
-/**
- * Parameters for creating a new organization.
- *
- * **Auth:** Requires `adminKey` in client config.
- * **Endpoint:** `POST /v1/organizations`
- */
-export interface OrgCreateParams {
-    /** Unique organization identifier (2–64 characters, alphanumeric + hyphens). */
-    org_id: string;
-    /** Human-readable display name (2–128 characters). */
-    name: string;
-    /** Organization tier. Determines quotas and rate limits. @default "standard" */
-    tier?: OrgTier;
-    /** Custom key-value settings for the organization. @default {} */
+export type ApiKeyScopeStatus = "active" | "suspended";
+export interface ApiKeyIssueParams {
+    name?: string;
     settings?: Record<string, unknown>;
 }
-/** Options for organization creation helpers. */
-export interface CreateOrganizationOptions {
-    /**
-     * Controls duplicate-organization handling.
-     * Defaults to `true`, which makes org creation idempotent.
-     */
-    allowExisting?: boolean;
-}
-/** Full organization entity as returned by the API. */
-export interface Organization {
-    /** Unique organization identifier. */
-    org_id: string;
-    /** Display name. */
+export interface ApiKeyScope {
     name: string;
-    /** Current tier (free, standard, premium, enterprise). */
-    tier: OrgTier;
-    /** Lifecycle status (active or suspended). */
-    status: OrgStatus;
-    /** ISO 8601 creation timestamp. */
+    status: ApiKeyScopeStatus;
     created_at: string;
-    /** ISO 8601 last-update timestamp. */
     updated_at: string;
-    /** Custom organization settings. */
     settings: Record<string, unknown>;
 }
-/**
- * Response from creating an organization.
- * Contains the full organization entity and the generated API key.
- */
-export interface OrgBootstrapResponse {
-    /** The created organization. */
-    organization: Organization;
-    /** Generated API key (prefix `vxk_`). Store securely — shown only once. */
+export interface ApiKeyBootstrapResponse {
+    scope: ApiKeyScope;
     api_key: string;
 }
-/** Successful response when an organization was newly created. */
-export interface OrgCreatedResponse extends OrgBootstrapResponse {
-    /** Indicates the organization was created by this call. */
-    created: true;
-}
-/** Successful response when the organization already existed. */
-export interface OrgExistingResponse {
-    /** Indicates the organization already existed before this call. */
-    created: false;
-    /** Current organization details fetched via the admin API. */
-    organization: Organization;
-    /** Existing orgs do not expose the original API key again. */
-    api_key: null;
-}
-/** Result from an idempotent organization provisioning flow. */
-export type OrgEnsureResponse = OrgCreatedResponse | OrgExistingResponse;
-/**
- * Response from rotating an organization's API key.
- * The previous key remains valid during a 24-hour grace period.
- */
-export interface RotateApiKeyResponse {
-    /** Organization identifier. */
-    org_id: string;
-    /** Newly generated API key. */
+export interface ApiKeyRotateResponse {
     new_api_key: string;
-    /** ISO 8601 timestamp when the previous key expires. */
     previous_key_grace_expires_at: string;
 }
-/** Response from suspending or reactivating an organization. */
-export interface ChangeOrgStatusResponse {
-    /** Organization identifier. */
-    org_id: string;
-    /** New status after the operation. */
-    status: OrgStatus;
-    /** ISO 8601 timestamp of the status change. */
-    updated_at: string;
-}
-/**
- * Parameters for exchanging the bootstrap admin key for a signed session token.
- *
- * **Auth:** None (this is the login endpoint).
- * **Endpoint:** `POST /v1/admin/login`
- */
 export interface AdminLoginParams {
-    /** The bootstrap admin key (min 1 character). */
     admin_key: string;
 }
-/** Response containing a signed admin session token. */
 export interface AdminLoginResponse {
-    /** Signed JWT session token. Use as `Authorization: Bearer <token>`. */
     access_token: string;
-    /** Token type — always `"bearer"`. */
     token_type: string;
-    /** Token validity in seconds (default 28800 = 8 hours). */
     expires_in_seconds: number;
 }
-/**
- * Response from uploading and ingesting a document.
- * The document is stored in GCS, split into chunks, and embedded for RAG retrieval.
- */
+export interface RootResponse {
+    service: string;
+    status: string;
+    health: string;
+    docs: string;
+}
+export interface HealthResponse {
+    service: string;
+    version: string;
+    status: string;
+    stats: Record<string, unknown>;
+}
 export interface DocumentUploadResponse {
-    /** Unique document identifier. */
     document_id: string;
-    /** Organization the document belongs to. */
-    org_id: string;
-    /** Original filename. */
     filename: string;
-    /** Number of text chunks created from the document. */
     chunks: number;
-    /** Processing status (e.g. `"processed"`). */
     status: string;
 }
-/**
- * Parameters for a RAG (Retrieval-Augmented Generation) query.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/query`
- */
-export interface QueryParams {
-    /** The query text (min 1 character). */
-    query: string;
-    /** Optional user identifier for tracking and audit. */
-    user_id?: string;
-    /** Optional content-project context for project-scoped memory. */
-    project_id?: string;
-    /** Gemini model to use for generation. @default "gemini-pro" */
-    model_type?: string;
-    /** Sampling temperature (0.0–1.0). Lower = more deterministic. @default 0.2 */
-    temperature?: number;
-    /** Retrieval strategy: `"hybrid"`, `"dense"`, or `"sparse"`. @default "hybrid" */
-    retrieval_strategy?: string;
-}
-/** A single citation returned inside a RAG query response. */
-export interface Citation {
-    doc_id: string;
-    chunk_id: string;
-    score: number;
-    snippet: string;
-}
-/** Response from a RAG query, including the generated answer and source citations. */
-export interface QueryResponse {
-    /** Generated answer text. */
-    answer: string;
-    /** Source document chunks used to generate the answer, with scores and snippets. */
-    sources: Citation[];
-    /** Backward-compatible answer field used by older API consumers. */
-    response: string;
-    /** Backward-compatible citations field used by older API consumers. */
-    citations: Citation[];
-    /** Confidence score returned by the answering pipeline. */
-    confidence: number;
-    /** Approximate processing time in seconds. */
-    processing_time: number;
-    /** Model used for generation. */
-    model_type?: string | null;
-}
-/**
- * Parameters for source discovery search.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/search`
- */
 export interface SearchParams {
-    /** Search query text (min 1 character). */
     query: string;
-    /** Optional search type hint. */
     type?: string;
-    /** Maximum number of results to return (1-25). @default 10 */
     num?: number;
 }
-/** A single organic search result. */
 export interface SearchOrganicResult {
     url: string;
     title: string;
@@ -255,382 +85,166 @@ export interface SearchOrganicResult {
     date?: string | null;
     order?: number | null;
 }
-/** A single "people also ask" result. */
 export interface SearchPeopleAlsoAskResult {
     question: string;
     snippet: string;
     title: string;
     link: string;
 }
-/** Source discovery search response. */
 export interface SearchResponse {
     organic: SearchOrganicResult[];
     peopleAlsoAsk: SearchPeopleAlsoAskResult[];
     relatedSearches: string[];
 }
-export type ProjectStatus = "active" | "archived";
-export type ContentItemType = "script" | "article" | "social_post" | "generic" | "video" | "audio" | "music";
-export type ContentItemStatus = "draft" | "ready" | "published" | "archived";
-export type SourceStatus = "pending" | "scraped" | "failed";
-export type ScheduleStatus = "scheduled" | "processing" | "published" | "failed" | "cancelled";
-export interface ProjectCreateParams {
-    name: string;
-    description?: string;
-    metadata?: Record<string, unknown>;
-}
-export interface ProjectUpdateParams {
-    name?: string;
-    description?: string;
-    metadata?: Record<string, unknown>;
-    status?: ProjectStatus;
-}
-export interface ContentProject {
-    project_id: string;
-    org_id: string;
-    name: string;
-    description: string;
-    created_at: string;
-    updated_at: string;
-    created_by: string;
-    status: ProjectStatus;
-    metadata: Record<string, unknown>;
-}
-export interface ContentProjectListResponse {
-    projects: ContentProject[];
-    total: number;
-}
-export interface ProjectChatParams {
-    message: string;
-    user_id: string;
-    model_type?: string;
-    temperature?: number;
-    retrieval_strategy?: string;
-}
-export interface ConversationMessage {
-    org_id: string;
-    user_id: string;
-    role: string;
-    content: string;
-    created_at: string;
-    metadata: Record<string, unknown>;
-}
-export interface ProjectChatHistoryResponse {
-    messages: ConversationMessage[];
-    total: number;
-}
-export interface ContentItemCreateParams {
-    item_type: ContentItemType;
-    title: string;
-    content?: string;
-    asset_url?: string;
-    status?: ContentItemStatus;
-    metadata?: Record<string, unknown>;
-}
-export interface ContentItemUpdateParams {
-    title?: string;
-    content?: string;
-    asset_url?: string | null;
-    status?: ContentItemStatus;
-    metadata?: Record<string, unknown>;
-}
-export interface ContentItemResponse {
-    content_id: string;
-    org_id: string;
-    project_id: string;
-    item_type: ContentItemType;
-    title: string;
-    content: string;
-    created_at: string;
-    updated_at: string;
-    created_by: string;
-    status: ContentItemStatus;
-    asset_url?: string | null;
-    metadata: Record<string, unknown>;
-}
-export interface ContentItemListResponse {
-    items: ContentItemResponse[];
-    total: number;
-}
-export interface ProjectSourceCreateParams {
-    url: string;
-    title?: string;
-    content?: string;
-    description?: string;
-    source_type?: string;
-    status?: SourceStatus;
-    metadata?: Record<string, unknown>;
-}
-/**
- * Parameters for scraping one or more URLs and persisting the normalized
- * results as project sources.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/projects/{projectId}/sources/scrape`
- */
-export interface ProjectSourceScrapeParams {
-    /** One or more absolute URLs to fetch and save into the project. */
-    urls: string[];
-}
-export interface ProjectSourceUpdateParams {
-    title?: string;
-    content?: string;
-    description?: string;
-    status?: SourceStatus;
-    metadata?: Record<string, unknown>;
-}
-export interface ProjectSourceResponse {
-    source_id: string;
-    org_id: string;
-    project_id: string;
-    url: string;
-    title: string;
-    content: string;
-    created_at: string;
-    updated_at: string;
-    source_type: string;
-    description: string;
-    status: SourceStatus;
-    metadata: Record<string, unknown>;
-}
-export interface ProjectSourceListResponse {
-    sources: ProjectSourceResponse[];
-    total: number;
-}
-export interface PublishScheduleCreateParams {
-    content_id: string;
-    target_platforms?: string[];
-    publish_at: string;
-    timezone?: string;
-    delivery_endpoint?: string;
-    delivery_headers?: Record<string, string>;
-    metadata?: Record<string, unknown>;
-}
-export interface PublishScheduleUpdateParams {
-    target_platforms?: string[];
-    publish_at?: string;
-    timezone?: string;
-    status?: ScheduleStatus;
-    delivery_endpoint?: string | null;
-    delivery_headers?: Record<string, string>;
-    metadata?: Record<string, unknown>;
-}
-export interface PublishScheduleResponse {
-    schedule_id: string;
-    org_id: string;
-    project_id: string;
-    content_id: string;
-    target_platforms: string[];
-    publish_at: string;
-    created_at: string;
-    updated_at: string;
-    created_by: string;
-    timezone: string;
-    status: ScheduleStatus;
-    delivery_endpoint?: string | null;
-    delivery_headers: Record<string, string>;
-    published_at?: string | null;
-    last_result: Record<string, unknown>;
-    metadata: Record<string, unknown>;
-}
-export interface PublishScheduleListResponse {
-    schedules: PublishScheduleResponse[];
-    total: number;
-}
-/**
- * Response from manually running due Content Creator schedules.
- *
- * Returned by `POST /v1/admin/content-creator/schedules/run-due`.
- */
-export interface ScheduleRunResultResponse {
-    processed: number;
-    published: number;
-    failed: number;
-    schedules: PublishScheduleResponse[];
-}
-/**
- * Parameters for starting an asynchronous video generation job (Vertex AI Veo).
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/generate/video`
- */
 export interface GenerateVideoParams {
-    /** Video generation prompt (min 1 character). */
     prompt: string;
-    /** Duration in seconds. Must be 4, 6, or 8. @default 8 */
     duration?: 4 | 6 | 8;
-    /** Aspect ratio (e.g. `"16:9"`, `"9:16"`, `"1:1"`). @default "16:9" */
     aspect_ratio?: string;
-    /** Visual style hint (e.g. `"cinematic"`, `"anime"`). */
     style?: string;
-    /** Optional user identifier for tracking. */
-    user_id?: string;
-}
-/**
- * Parameters for starting an asynchronous image generation job (Vertex AI Imagen).
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/generate/image`
- */
+}
 export interface GenerateImageParams {
-    /** Image generation prompt (min 1 character). */
     prompt: string;
-    /** Aspect ratio (e.g. `"1:1"`, `"16:9"`, `"9:16"`). @default "1:1" */
     aspect_ratio?: string;
-    /** Visual style hint (e.g. `"digital art"`, `"photorealistic"`). */
     style?: string;
-    /** Number of images to generate (1–8). @default 1 */
     num_images?: number;
-    /** Optional user identifier for tracking. */
-    user_id?: string;
-}
-/**
- * Parameters for starting an asynchronous music generation job.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/generate/music`
- */
+}
 export interface GenerateMusicParams {
-    /** Target genre (e.g. `"ambient"`). */
     genre: string;
-    /** Target mood (e.g. `"uplifting"`). */
     mood: string;
-    /** Duration in seconds. */
     duration: number;
-    /** Optional user identifier for tracking. */
-    user_id?: string;
 }
-/** Response returned when an asynchronous generation job is accepted (HTTP 202). */
+export type SocialPlatform = "x" | "linkedin" | "facebook" | "instagram" | "tiktok" | "youtube";
+export type SocialContentGoal = "awareness" | "engagement" | "clicks" | "leads" | "conversions" | "education" | "community" | "launch";
+export type SocialContentLength = "short" | "medium" | "long";
+export type SocialTone = "professional" | "friendly" | "playful" | "bold" | "authoritative" | "educational" | "witty";
+export type SocialWritingStyle = "conversational" | "storytelling" | "direct" | "thought_leadership" | "persuasive" | "community_led" | "scripted";
+export type EmojiDensity = "none" | "light" | "medium" | "heavy";
+export interface SocialContentGenerateParams {
+    prompt: string;
+    platforms: SocialPlatform[];
+    objective?: SocialContentGoal;
+    target_audience?: string;
+    brand_name?: string;
+    tone?: SocialTone;
+    writing_style?: SocialWritingStyle;
+    length?: SocialContentLength;
+    call_to_action?: string;
+    primary_keyword?: string;
+    secondary_keywords?: string[];
+    include_hashtags?: boolean;
+    hashtags?: string[];
+    hashtag_count?: number;
+    include_emojis?: boolean;
+    emoji_density?: EmojiDensity;
+    variation_count?: number;
+    include_title?: boolean;
+    include_hook?: boolean;
+    include_short_description?: boolean;
+    include_script?: boolean;
+    must_include?: string[];
+    avoid_terms?: string[];
+    compliance_notes?: string[];
+    landing_page_url?: string;
+    language?: string;
+}
+export interface SocialContentAnalysis {
+    summary: string;
+    recommended_hook: string;
+    recommended_structure: string[];
+    keyword_focus: string[];
+    platform_notes: Record<string, string[]>;
+    risks: string[];
+}
+export interface SocialContentSeoCheck {
+    passed: boolean;
+    score: number;
+    primary_keyword?: string | null;
+    matched_keywords: string[];
+    missing_keywords: string[];
+    recommendations: string[];
+}
+export interface SocialContentGuardrail {
+    passed: boolean;
+    risk_level: string;
+    issues: string[];
+    redactions: string[];
+    sanitized: boolean;
+}
+export interface SocialContentVariant {
+    platform: SocialPlatform;
+    variation: number;
+    title?: string | null;
+    hook?: string | null;
+    body: string;
+    short_description?: string | null;
+    call_to_action?: string | null;
+    hashtags: string[];
+    keywords_used: string[];
+    script?: string | null;
+    notes: string[];
+    seo: SocialContentSeoCheck;
+    guardrails: SocialContentGuardrail;
+}
+export interface SocialContentGenerationResponse {
+    request_id: string;
+    model?: string | null;
+    tools_used: string[];
+    analysis: SocialContentAnalysis;
+    variants: SocialContentVariant[];
+}
 export interface JobAcceptedResponse {
-    /** Unique job identifier. Use with `getJob()` or `waitForJob()` to poll status. */
     job_id: string;
-    /** Initial status — always `"processing"`. */
     status: string;
-    /** Estimated processing time in seconds. */
     estimated_time: number;
 }
-/**
- * Status of an asynchronous job (video or image generation).
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `GET /v1/organizations/{orgId}/jobs/{jobId}`
- */
 export interface JobStatusResponse {
-    /** Job identifier. */
     job_id: string;
-    /** Current status: `"processing"`, `"completed"`, `"failed"`, or `"cancelled"`. */
     status: string;
-    /** Result payload when completed (e.g. `{ output_url, signed_url }`). `null` while processing. */
     result: unknown;
-    /** Error message if the job failed. `null` otherwise. */
     error: string | null;
 }
-/**
- * Parameters for a natural-language query over BigQuery datasets.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/data-chat`
- */
 export interface DataChatParams {
-    /** Natural-language question (min 1 character). */
     question: string;
-    /** Optional user identifier for tracking. */
-    user_id?: string;
 }
-/** Response from a data chat query, including the generated SQL and result rows. */
 export interface DataChatResponse {
-    /** Natural-language answer summarizing the results. */
     answer: string;
-    /** Generated SQL query executed against the data backend. */
     sql: string;
-    /** Result rows returned by the query. */
     data: Array<Record<string, unknown>>;
-    /** Number of rows returned. */
     row_count: number;
-    /** Backend tool used (e.g. "alloydb"). */
     tool_used: string;
 }
-/**
- * Parameters for creating a custom AI agent template.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/agents/custom`
- */
 export interface AgentCreateParams {
-    /** Agent name (2–64 characters). */
     name: string;
-    /** System instructions for the agent (min 4 characters). */
     instructions: string;
-    /** Tool identifiers the agent can use (e.g. `["rag_search", "ticket_create"]`). @default [] */
     tools?: string[];
 }
-/** Response from creating a custom agent. */
 export interface AgentCreateResponse {
-    /** Unique agent identifier. */
     agent_id: string;
-    /** Agent name. */
     name: string;
-    /** Tools enabled for this agent. */
     tools: string[];
 }
-/**
- * Parameters for querying an AI agent.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/agents/query`
- */
 export interface AgentQueryParams {
-    /** User query text (min 1 character). */
     query: string;
-    /** User identifier (required for agent context). */
-    user_id: string;
-    /** Agent type to route to. @default "auto" */
     agent_type?: string;
 }
-/** Response from an agent query. */
 export interface AgentQueryResponse {
-    /** Agent type that handled the query. */
     agent_type: string;
-    /** Agent's response text. */
     response: string;
-    /** Actions taken by the agent during processing. */
     actions: string[];
 }
-/**
- * Parameters for audio transcription (speech-to-text).
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/audio/transcribe`
- */
 export interface AudioTranscribeParams {
-    /** Legacy fallback text input used when no audio URL is provided. */
     audio_text?: string;
-    /** Public or cloud-storage URL for the audio file to transcribe with ElevenLabs Scribe. */
     audio_url?: string;
-    /** BCP-47 language code. @default "en-US" */
     language_code?: string;
-    /** Speech-to-text model. @default "scribe_v2" */
     model_id?: string;
 }
-/**
- * Parameters for text-to-speech synthesis.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/audio/synthesize`
- */
 export interface AudioSynthesizeParams {
-    /** Text to convert to speech (min 1 character). */
     text: string;
-    /** Voice identifier. @default "en-US-Neural2-J" */
     voice_name?: string;
-    /** Optional ElevenLabs model override, e.g. `eleven_v3`. */
     model_id?: string;
-    /** Optional ElevenLabs output format override, e.g. `mp3_44100_128`. */
     output_format?: string;
-    /** Optional ISO 639-1 language code passed to ElevenLabs. */
     language_code?: string;
-    /** Optional deterministic seed passed to ElevenLabs. */
     seed?: number;
-    /** Optional per-request ElevenLabs voice settings override. */
     voice_settings?: {
         stability?: number;
         similarity_boost?: number;
@@ -639,12 +253,10 @@ export interface AudioSynthesizeParams {
         speed?: number;
     };
 }
-/** A speaker turn detected by the transcription pipeline. */
 export interface AudioSpeakerTurn {
     speaker: number;
     word_count: number;
 }
-/** Response from audio transcription (speech-to-text). */
 export interface AudioTranscriptionResponse {
     transcript: string;
     speaker_turns: AudioSpeakerTurn[];
@@ -653,7 +265,6 @@ export interface AudioTranscriptionResponse {
     transcription_id?: string | null;
     source_url?: string | null;
 }
-/** Response from text-to-speech synthesis. */
 export interface AudioSynthesizeResponse {
     url: string;
     output_url: string;
@@ -668,256 +279,79 @@ export interface AudioSynthesizeResponse {
     content_type?: string | null;
     request_id?: string | null;
 }
-/**
- * Parameters for training a predictive model on tabular data.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/analytics/train`
- */
 export interface TrainModelParams {
-    /** Column name to predict. */
     target_column: string;
-    /** Feature column names used as model inputs. */
     feature_columns: string[];
-    /** Training data rows. Each row is an object with feature + target columns. */
     rows: Array<Record<string, unknown>>;
 }
-/** Response from training a predictive model. */
 export interface TrainModelResponse {
-    /** Unique model identifier. Use with `predict()`. */
     model_id: string;
-    /** Deployment status (e.g. `"deployed"`). */
     status: string;
 }
-/**
- * Parameters for running predictions with a trained model.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/analytics/predict`
- */
 export interface PredictParams {
-    /** Trained model identifier (from `trainModel()`). */
     model_id: string;
-    /** Data instances to predict on. Each instance has the model's feature columns. */
     instances: Array<Record<string, unknown>>;
 }
-/** Response containing prediction results. */
 export interface PredictResponse {
-    /** Predictions for each input instance. */
     predictions: unknown[];
 }
-/**
- * Parameters for time-series forecasting.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/analytics/forecast`
- */
 export interface ForecastParams {
-    /** Historical time-series values. */
     series: number[];
-    /** Forecast horizon in periods (1–365). @default 30 */
     horizon?: number;
 }
-/** Response containing the forecast values. */
 export interface ForecastResponse {
-    /** Predicted future values for the specified horizon. */
     forecast: number[];
-    /** Model used for forecasting. */
     model: string;
 }
-/**
- * Monthly usage summary for an organization.
- * Includes token, image, video, storage, and compute usage against tier limits.
- */
-export interface UsageSummaryResponse {
-    /** Organization identifier. */
-    org_id: string;
-    /** Month in `YYYY-MM` format. */
-    month: string;
-    /** Usage counters (tokens_used, images_generated, videos_generated, storage_bytes, compute_hours). */
-    usage: Record<string, unknown>;
-    /** Tier limits for comparison. */
-    limits: Record<string, unknown>;
-    /** Whether the organization is within all quotas. */
-    within_quota: boolean;
-    /** List of limit keys that have been exceeded. */
-    exceeded_limits: string[];
-}
-/**
- * Monthly invoice with cost breakdown by resource type.
- * Costs are calculated based on the platform's pricing configuration.
- */
-export interface InvoiceResponse {
-    /** Organization identifier. */
-    org_id: string;
-    /** Month in `YYYY-MM` format. */
-    month: string;
-    /** Usage counters for the billing period. */
-    usage: Record<string, unknown>;
-    /** Cost breakdown by resource type. */
-    costs: Record<string, number>;
-    /** Total cost for the period. */
-    total: number;
-    /** Currency code. */
-    currency: string;
-}
-/** A single audit log entry recording an API action. */
 export interface AuditRecord {
-    /** ISO 8601 timestamp of the action. */
     timestamp: string;
-    /** Organization identifier. */
-    org_id: string;
-    /** User who performed the action (null for system actions). */
-    user_id: string | null;
-    /** Action identifier (e.g. `"query.execute"`, `"document.upload"`). */
     action: string;
-    /** Resource path (e.g. `"rag/query"`, `"documents/upload"`). */
     resource: string;
-    /** Outcome status (e.g. `"success"`, `"failure"`). */
     status: string;
-    /** Additional context (model_type, file size, etc.). */
     metadata: Record<string, unknown>;
 }
-/**
- * Response containing audit log records for an organization.
- * Backend model: `AuditLogListResponse`.
- */
 export interface AuditLogResponse {
-    /** Organization identifier. */
-    org_id: string;
-    /** Audit log entries, newest first. */
     records: AuditRecord[];
 }
-/**
- * Parameters for submitting URLs to scrape.
- *
- * **Auth:** None required.
- * **Endpoint:** `POST /v1/scraping/scrape`
- */
 export interface ScrapeParams {
-    /** List of URLs to scrape. JS-heavy sites (Reddit, Twitter, etc.) are auto-routed to Selenium. */
     urls: string[];
 }
-/** Response from submitting a scrape job. */
 export interface ScrapeResponse {
-    /** Unique task identifier. Use with `getScrapeStatus()` to poll results. */
     task_id: string;
-    /** Submission status (`"completed"` for inline mode, `"submitted"` for Celery mode). */
     status: string;
 }
-/** A single scraped page result. */
 export interface ScrapeResultItem {
-    /** Source URL. */
     url?: string;
-    /** Page title. */
     title?: string;
-    /** Meta description. */
     description?: string;
-    /** Extracted text paragraphs. */
     paragraphs?: string[];
-    /** Full extracted text content. */
     full_text?: string;
-    /** Error message if scraping this URL failed. */
     error?: string;
 }
-/**
- * Status and results of a scrape task.
- *
- * **Endpoint:** `GET /v1/scraping/status/{taskId}`
- */
 export interface ScrapeStatusResponse {
-    /** Task identifier. */
     task_id: string;
-    /** Task status: `"PENDING"`, `"SUCCESS"`, `"FAILURE"`, or `"completed"`. */
     status: string;
-    /** Scraped results (empty while pending). */
     result: ScrapeResultItem[];
 }
-/**
- * Runtime scraping configuration.
- *
- * **Endpoint:** `GET /v1/scraping/config`
- */
 export interface ScrapingConfigResponse {
-    /** Execution mode: `"inline"`, `"celery"`, or `"auto"`. */
     execution_mode: string;
-    /** Whether running on Cloud Run. */
     is_cloud_run: boolean;
-    /** Maximum inline result cache size. */
     inline_result_cache_size: number;
-    /** Current number of cached entries. */
     inline_result_cache_entries: number;
 }
-/**
- * Payload for the video generation completion webhook.
- *
- * **Auth:** Requires `webhookSecret` in client config.
- * **Endpoint:** `POST /v1/webhook/video-complete`
- */
 export interface VideoCompleteWebhook {
-    /** Job identifier. */
     job_id: string;
-    /** Organization identifier. */
-    org_id: string;
-    /** Completion status (e.g. `"completed"`, `"failed"`). */
     status: string;
-    /** Additional metadata (e.g. `{ output_uri: "gs://..." }`). */
     metadata?: Record<string, unknown>;
 }
-/**
- * Payload for the document processing completion webhook.
- *
- * **Auth:** Requires `webhookSecret` in client config.
- * **Endpoint:** `POST /v1/webhook/document-processed`
- */
 export interface DocumentProcessedWebhook {
-    /** Document identifier. */
     document_id: string;
-    /** Organization identifier. */
-    org_id: string;
-    /** Processing status (e.g. `"processed"`, `"failed"`). */
     status: string;
-    /** Additional metadata (e.g. `{ chunks: 47 }`). */
     metadata?: Record<string, unknown>;
 }
-/**
- * Root service metadata response.
- *
- * **Auth:** None required.
- * **Endpoint:** `GET /`
- */
-export interface RootResponse {
-    /** Service name. */
-    service: string;
-    /** Service status (`"ok"`). */
-    status: string;
-    /** Relative health endpoint path. */
-    health: string;
-    /** Relative Swagger docs path. */
-    docs: string;
-}
-/**
- * Service health check response.
- *
- * **Auth:** None required.
- * **Endpoint:** `GET /v1/health`
- */
-export interface HealthResponse {
-    /** Service name. */
-    service: string;
-    /** Service version. */
-    version: string;
-    /** Health status (`"ok"`). */
-    status: string;
-    /** Aggregate statistics (organizations, documents, total_chunks). */
-    stats: Record<string, unknown>;
+export interface WebhookAckResponse {
+    received: boolean;
 }
-/**
- * Full service configuration overview.
- *
- * **Auth:** Requires `adminKey` in client config.
- * **Endpoint:** `GET /v1/admin/config`
- */
 export interface ConfigOverview {
     service_name: string;
     service_version: string;
@@ -940,41 +374,33 @@ export interface ConfigOverview {
     max_upload_bytes: number;
     use_secret_manager: boolean;
     redis_url_set: boolean;
-    content_schedule_runner_enabled: boolean;
-    content_schedule_runner_poll_seconds: number;
     log_level: string;
     debug: boolean;
 }
-/** Request to update a runtime setting. */
 export interface UpdateSettingRequest {
     key: string;
     value: unknown;
 }
-/** Response after updating a runtime setting. */
 export interface UpdateSettingResponse {
     key: string;
     previous_value: unknown;
     new_value: unknown;
     updated_at: string;
 }
-/** Request to change the log level. */
 export interface LogLevelRequest {
     level: string;
 }
-/** Response from changing the log level. */
 export interface LogLevelResponse {
     previous_level: string;
     new_level: string;
     updated_at: string;
 }
-/** Information about a single logger. */
 export interface LoggerInfo {
     name: string;
     level: string;
     effective_level: string;
     handlers: string[];
 }
-/** Inbound traffic statistics. */
 export interface InboundTrafficStats {
     total_requests: number;
     requests_by_method: Record<string, number>;
@@ -983,7 +409,6 @@ export interface InboundTrafficStats {
     top_paths: Array<Record<string, unknown>>;
     collected_since: string;
 }
-/** A single outbound dependency health check. */
 export interface OutboundDependency {
     name: string;
     type: string;
@@ -991,151 +416,100 @@ export interface OutboundDependency {
     latency_ms: number | null;
     details: Record<string, unknown>;
 }
-/** Response from checking outbound dependencies. */
 export interface OutboundStatusResponse {
     checked_at: string;
     dependencies: OutboundDependency[];
 }
-/** A single rate-limit entry for an organization. */
 export interface RateLimitEntry {
-    org_id: string;
+    scope_id: string;
     current_count: number;
     window_start: string | null;
 }
-/** Summary of an organization for admin listing. */
-export interface OrgSummary {
-    org_id: string;
-    name: string;
-    tier: string;
-    status: string;
-    created_at: string;
-}
-/** Response from listing all organizations. */
-export interface OrgListResponse {
-    total: number;
-    organizations: OrgSummary[];
-}
-/** Summary of a job for admin listing. */
 export interface JobSummary {
     job_id: string;
-    org_id: string;
+    scope_id: string;
     status: string;
     created_at: string;
     completed_at: string | null;
 }
-/** Response from listing all jobs. */
 export interface JobListResponse {
     total: number;
     jobs: JobSummary[];
 }
-/** A single feature flag. */
 export interface FeatureFlag {
     key: string;
     enabled: boolean;
     description: string;
 }
-/** Request to create or update a feature flag. */
 export interface FeatureFlagUpdate {
     key: string;
     enabled: boolean;
 }
-/** Request to set maintenance mode. */
 export interface MaintenanceModeRequest {
     enabled: boolean;
     message?: string;
 }
-/** Response with current maintenance mode state. */
 export interface MaintenanceModeResponse {
     enabled: boolean;
     message: string;
     updated_at: string;
 }
-/** Cache statistics. */
 export interface CacheStatsResponse {
     backend: string;
     connected: boolean;
     details: Record<string, unknown>;
 }
-/** Configuration for a single tier. */
-export interface TierConfigResponse {
-    tier: string;
-    max_tokens_per_month: number;
-    max_images_per_month: number;
-    max_videos_per_month: number;
-    max_storage_gb: number;
-    max_compute_hours: number;
-    requests_per_minute: number;
-    concurrent_jobs: number;
-    features: string[];
-}
-/** Pricing configuration. */
-export interface PricingResponse {
-    pricing: Record<string, number>;
-}
-/** A single admin audit log entry. */
 export interface AdminAuditEntry {
     timestamp: string;
     admin_action: string;
     detail: string;
     metadata: Record<string, unknown>;
 }
-/** Response from the admin audit endpoint. */
 export interface AdminAuditResponse {
     total: number;
     entries: AdminAuditEntry[];
 }
-/**
- * Request to connect a Jira Cloud site using an API token.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/integrations/jira/connect`
- */
+export interface JiraWebhookPayload {
+    webhookEvent: string;
+    timestamp?: number | null;
+    issue?: Record<string, unknown> | null;
+    comment?: Record<string, unknown> | null;
+    changelog?: Record<string, unknown> | null;
+    user?: Record<string, unknown>;
+    matchedWebhookIds?: number[];
+}
 export interface JiraConnectRequest {
     site_url: string;
     email: string;
     api_token: string;
 }
-/**
- * Response from connecting a Jira Cloud site.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/integrations/jira/connect`
- */
+export interface JiraIntegrationStatusResponse {
+    connected: boolean;
+    site_url?: string | null;
+    cloud_id?: string | null;
+    status?: string | null;
+    connected_at?: string | null;
+}
 export interface JiraConnectResponse {
     status: string;
-    org_id: string;
     site_url: string;
     cloud_id: string;
 }
-/**
- * Jira integration status for an organization.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `GET /v1/organizations/{orgId}/integrations/jira/status`
- */
-export interface JiraIntegrationStatusResponse {
-    org_id: string;
-    connected: boolean;
-    site_url: string | null;
-    cloud_id: string | null;
-    status: string | null;
-    connected_at: string | null;
-}
-/**
- * Request to sync Jira projects.
- *
- * **Auth:** Requires org-scoped API key.
- * **Endpoint:** `POST /v1/organizations/{orgId}/integrations/jira/sync`
- */
 export interface JiraSyncRequest {
     project_keys: string[];
 }
-/** Response from initiating a Jira sync. */
 export interface JiraSyncResponse {
     job_id: string;
     status: string;
     project_keys: string[];
 }
+export interface JiraDisconnectResponse {
+    status: string;
+}
+export interface JiraWebhookAckResponse {
+    received: boolean;
+    result: Record<string, unknown>;
+}
 export interface AIGenerationRules {
     enabled: boolean;
     context_required: string[];
@@ -1149,8 +523,8 @@ export interface BlueprintSection {
     is_required: boolean;
     section_type: string;
     ai_generation_rules: AIGenerationRules;
-    min_length: number | null;
-    max_length: number | null;
+    min_length?: number | null;
+    max_length?: number | null;
 }
 export interface WorkflowStageConfig {
     allowed_roles: string[];
@@ -1176,11 +550,10 @@ export interface TargetRoles {
 }
 export interface BlueprintResponse {
     blueprint_id: string;
-    org_id: string;
     name: string;
     description: string;
     category: string;
-    status: "draft" | "published" | "archived";
+    status: string;
     version: number;
     created_at: string;
     updated_at: string;
@@ -1205,16 +578,9 @@ export interface BlueprintCreateParams {
     target_roles?: Partial<TargetRoles>;
     sections?: Array<Omit<BlueprintSection, "section_id">>;
     workflow_config?: Partial<WorkflowConfig>;
+    metadata?: Record<string, unknown>;
 }
-export interface BlueprintUpdateParams {
-    name?: string;
-    description?: string;
-    category?: string;
-    default_workflow?: string;
-    visibility_notes?: string;
-    target_roles?: Partial<TargetRoles>;
-    sections?: Array<Omit<BlueprintSection, "section_id">>;
-    workflow_config?: Partial<WorkflowConfig>;
+export interface BlueprintUpdateParams extends BlueprintCreateParams {
 }
 export interface DocumentSectionContent {
     section_id: string;
@@ -1235,8 +601,8 @@ export interface DocumentSection {
     order: number;
     content: string;
     is_ai_generated: boolean;
-    last_edited_by: string | null;
-    last_edited_at: string | null;
+    last_edited_by: string;
+    last_edited_at?: string | null;
 }
 export interface WorkflowAction {
     action_id: string;
@@ -1249,10 +615,9 @@ export interface WorkflowAction {
 }
 export interface ManagedDocumentResponse {
     document_id: string;
-    org_id: string;
     blueprint_id: string;
     title: string;
-    status: "draft" | "in_review" | "approved" | "sealed" | "rejected" | "revision";
+    status: string;
     created_at: string;
     updated_at: string;
     created_by: string;
@@ -1276,77 +641,18 @@ export interface DocumentWorkflowActionParams {
     action: "submit" | "approve" | "reject" | "request_changes" | "seal";
     comment?: string;
 }
-/** Parameters for AI-generating content for a document section. */
 export interface DocumentGenerateSectionParams {
-    /** Section ID to generate content for. */
     section_id: string;
-    /** Key-value context for AI generation. */
     context?: Record<string, string>;
 }
-/** Response from AI-generating a document section. */
 export interface DocumentGenerateResponse {
-    /** Section that was generated. */
     section_id: string;
-    /** Generated content. */
     generated_content: string;
-    /** AI model used for generation. */
     model_used: string;
 }
-/** Response from a webhook acknowledgment. */
-export interface WebhookAckResponse {
-    received: boolean;
-}
-/** Response from disconnecting a Jira integration. */
-export interface JiraDisconnectResponse {
-    status: string;
-    org_id: string;
-}
-/** Response from a Jira webhook acknowledgment. */
-export interface JiraWebhookAckResponse {
-    received: boolean;
-    org_id: string;
-    result: Record<string, unknown>;
-}
-/** A parsed Server-Sent Event. */
 export interface SseEvent {
-    /** Event type (from the `event:` line). Undefined for unnamed events. */
     event?: string;
-    /** Payload string (from the `data:` line(s)). */
     data: string;
-    /** Event ID (from the `id:` line), if present. */
     id?: string;
 }
-/** Typed SSE events emitted by the chat/stream endpoint. */
-export type ChatStreamEvent = {
-    event: "start";
-    data: {
-        org_id: string;
-        project_id: string;
-    };
-} | {
-    event: "done";
-    data: QueryResponse;
-} | {
-    event: "error";
-    data: {
-        message: string;
-    };
-};
-/** Command sent by the client over a chat WebSocket. */
-export interface WsChatCommand {
-    type: "chat";
-    message: string;
-    user_id: string;
-    model_type?: string;
-    temperature?: number;
-    retrieval_strategy?: string;
-}
-/** Frames sent by the server over a chat WebSocket. */
-export type WsChatFrame = {
-    type: "result";
-    payload: QueryResponse;
-} | {
-    type: "error";
-    message: string;
-};
 //# sourceMappingURL=types.d.ts.map